Add 'src/be/nikiroo/utils/' from commit '46add0670fdee4bd936a13fe2448c5e20a7ffd0a'

[fanfix.git] / src / be / nikiroo / utils / serial / server / ServerObject.java

diff --git a/src/be/nikiroo/utils/serial/server/ServerObject.java b/src/be/nikiroo/utils/serial/server/ServerObject.java
index dec84738865f480d64ae9a11dbd0ea5cd01b1058..a6a5dd1b83573c3ca0814f7c409ae872d2061e59 100644 (file)
--- a/src/be/nikiroo/utils/serial/server/ServerObject.java
+++ b/src/be/nikiroo/utils/serial/server/ServerObject.java
@@ -2,6 +2,7 @@ package be.nikiroo.utils.serial.server;
 
 import java.io.IOException;
 import java.net.Socket;
+import java.net.UnknownHostException;
 
 import be.nikiroo.utils.Version;
 
@@ -23,14 +24,20 @@ abstract public class ServerObject extends Server {
         *            the port to listen on, or 0 to assign any unallocated port
         *            found (which can later on be queried via
         *            {@link ServerObject#getPort()}
-        * @param ssl
-        *            use a SSL connection (or not)
+        * @param key
+        *            an optional key to encrypt all the communications (if NULL,
+        *            everything will be sent in clear text)
         * 
         * @throws IOException
         *             in case of I/O error
+        * @throws UnknownHostException
+        *             if the IP address of the host could not be determined
+        * @throws IllegalArgumentException
+        *             if the port parameter is outside the specified range of valid
+        *             port values, which is between 0 and 65535, inclusive
         */
-       public ServerObject(int port, boolean ssl) throws IOException {
-               super(port, ssl);
+       public ServerObject(int port, String key) throws IOException {
+               super(port, key);
        }
 
        /**
@@ -41,33 +48,45 @@ abstract public class ServerObject extends Server {
         *            the server name (only used for debug info and traces)
         * @param port
         *            the port to listen on
-        * @param ssl
-        *            use a SSL connection (or not)
+        * @param key
+        *            an optional key to encrypt all the communications (if NULL,
+        *            everything will be sent in clear text)
         * 
         * @throws IOException
         *             in case of I/O error
+        * @throws UnknownHostException
+        *             if the IP address of the host could not be determined
+        * @throws IllegalArgumentException
+        *             if the port parameter is outside the specified range of valid
+        *             port values, which is between 0 and 65535, inclusive
         */
-       public ServerObject(String name, int port, boolean ssl) throws IOException {
-               super(name, port, ssl);
+       public ServerObject(String name, int port, String key) throws IOException {
+               super(name, port, key);
        }
 
        @Override
        protected ConnectActionServer createConnectActionServer(Socket s) {
-               return new ConnectActionServerObject(s) {
+               return new ConnectActionServerObject(s, key) {
                        @Override
                        public void action(Version clientVersion) throws Exception {
+                               long id = getNextId();
                                try {
                                        for (Object data = rec(); true; data = rec()) {
                                                Object rep = null;
                                                try {
-                                                       rep = onRequest(this, clientVersion, data);
+                                                       rep = onRequest(this, clientVersion, data, id);
+                                                       if (isClosing()) {
+                                                               return;
+                                                       }
                                                } catch (Exception e) {
                                                        onError(e);
                                                }
+
                                                send(rep);
                                        }
                                } catch (NullPointerException e) {
                                        // Client has no data any more, we quit
+                                       onRequestDone(id, getBytesReceived(), getBytesSent());
                                }
                        }
 
@@ -78,6 +97,13 @@ abstract public class ServerObject extends Server {
                };
        }
 
+       @Override
+       protected ConnectActionClient getConnectionToMe()
+                       throws UnknownHostException, IOException {
+               return new ConnectActionClientObject(new Socket((String) null,
+                               getPort()), key);
+       }
+
        /**
         * This is the method that is called on each client request.
         * <p>
@@ -85,16 +111,70 @@ abstract public class ServerObject extends Server {
         * 
         * @param action
         *            the client action
-        * @param clientVersion
-        *            the client version
         * @param data
         *            the data sent by the client (which can be NULL)
+        * @param id
+        *            an ID to identify this request (will also be re-used for
+        *            {@link ServerObject#onRequestDone(long, long, long)}.
         * 
         * @return the answer to return to the client (which can be NULL)
         * 
         * @throws Exception
         *             in case of an exception, the error will only be logged
         */
-       abstract protected Object onRequest(ConnectActionServerObject action,
-                       Version clientVersion, Object data) throws Exception;
+       protected Object onRequest(ConnectActionServerObject action,
+                       Version clientVersion, Object data,
+                       @SuppressWarnings("unused") long id) throws Exception {
+               // TODO: change to abstract when deprecated method is removed
+               // Default implementation for compat
+               return onRequest(action, clientVersion, data);
+       }
+
+       // Deprecated //
+
+       /**
+        * @deprecated SSL support has been replaced by key-based encryption.
+        *             <p>
+        *             Please use the version with key encryption (this deprecated
+        *             version uses an empty key when <tt>ssl</tt> is TRUE and no
+        *             key (NULL) when <tt>ssl</tt> is FALSE).
+        */
+       @Deprecated
+       public ServerObject(int port, boolean ssl) throws IOException {
+               this(port, ssl ? "" : null);
+       }
+
+       /**
+        * @deprecated SSL support has been replaced by key-based encryption.
+        *             <p>
+        *             Please use the version with key encryption (this deprecated
+        *             version uses an empty key when <tt>ssl</tt> is TRUE and no
+        *             key (NULL) when <tt>ssl</tt> is FALSE).
+        */
+       @Deprecated
+       public ServerObject(String name, int port, boolean ssl) throws IOException {
+               this(name, port, ssl ? "" : null);
+       }
+
+       /**
+        * Will be called if the correct version is not overrided.
+        * 
+        * @deprecated use the version with the id.
+        * 
+        * @param action
+        *            the client action
+        * @param data
+        *            the data sent by the client
+        * 
+        * @return the answer to return to the client
+        * 
+        * @throws Exception
+        *             in case of an exception, the error will only be logged
+        */
+       @Deprecated
+       @SuppressWarnings("unused")
+       protected Object onRequest(ConnectActionServerObject action,
+                       Version version, Object data) throws Exception {
+               return null;
+       }
 }