1 package be
.nikiroo
.utils
.serial
.server
;
3 import java
.io
.ByteArrayInputStream
;
4 import java
.io
.IOException
;
5 import java
.io
.InputStream
;
6 import java
.lang
.reflect
.Array
;
7 import java
.net
.Socket
;
8 import java
.net
.UnknownHostException
;
10 import be
.nikiroo
.utils
.StringUtils
;
11 import be
.nikiroo
.utils
.TraceHandler
;
12 import be
.nikiroo
.utils
.Version
;
13 import be
.nikiroo
.utils
.serial
.Importer
;
16 * This class implements a simple server that can bridge two other
19 * It can, of course, inspect the data that goes through it (by default, it
20 * prints traces of the data).
22 * Note: this {@link ServerBridge} has to be discarded after use (cannot be
27 public class ServerBridge
extends Server
{
28 private final String forwardToHost
;
29 private final int forwardToPort
;
30 private final String forwardToKey
;
33 * Create a new server that will start listening on the network when
34 * {@link ServerBridge#start()} is called.
37 * the port to listen on, or 0 to assign any unallocated port
38 * found (which can later on be queried via
39 * {@link ServerBridge#getPort()}
41 * an optional key to encrypt all the communications (if NULL,
42 * everything will be sent in clear text)
43 * @param forwardToHost
44 * the host server to forward the calls to
45 * @param forwardToPort
46 * the host port to forward the calls to
48 * an optional key to encrypt all the communications (if NULL,
49 * everything will be sent in clear text)
52 * in case of I/O error
53 * @throws UnknownHostException
54 * if the IP address of the host could not be determined
55 * @throws IllegalArgumentException
56 * if the port parameter is outside the specified range of valid
57 * port values, which is between 0 and 65535, inclusive
59 public ServerBridge(int port
, String key
, String forwardToHost
,
60 int forwardToPort
, String forwardToKey
) throws IOException
{
62 this.forwardToHost
= forwardToHost
;
63 this.forwardToPort
= forwardToPort
;
64 this.forwardToKey
= forwardToKey
;
68 * Create a new server that will start listening on the network when
69 * {@link ServerBridge#start()} is called.
72 * the server name (only used for debug info and traces)
74 * the port to listen on
76 * an optional key to encrypt all the communications (if NULL,
77 * everything will be sent in clear text)
78 * @param forwardToHost
79 * the host server to forward the calls to
80 * @param forwardToPort
81 * the host port to forward the calls to
83 * an optional key to encrypt all the communications (if NULL,
84 * everything will be sent in clear text) use an SSL connection
85 * for the forward server or not
88 * in case of I/O error
89 * @throws UnknownHostException
90 * if the IP address of the host could not be determined
91 * @throws IllegalArgumentException
92 * if the port parameter is outside the specified range of valid
93 * port values, which is between 0 and 65535, inclusive
95 public ServerBridge(String name
, int port
, String key
,
96 String forwardToHost
, int forwardToPort
, String forwardToKey
)
98 super(name
, port
, key
);
99 this.forwardToHost
= forwardToHost
;
100 this.forwardToPort
= forwardToPort
;
101 this.forwardToKey
= forwardToKey
;
105 * The traces handler for this {@link Server}.
107 * The trace levels are handled as follow:
109 * <li>1: it will only print basic IN/OUT messages with length</li>
110 * <li>2: it will try to interpret it as an object (SLOW) and print the
111 * object class if possible</li>
112 * <li>3: it will try to print the {@link Object#toString()} value, or the
113 * data if it is not an object</li>
114 * <li>4: it will also print the unzipped serialised value if it is an
119 * the new traces handler
122 public void setTraceHandler(TraceHandler tracer
) {
123 super.setTraceHandler(tracer
);
127 protected ConnectActionServer
createConnectActionServer(Socket s
) {
128 // Bad impl, not up to date (should work, but not efficient)
129 return new ConnectActionServerString(s
, key
) {
131 public void action(final Version clientVersion
) throws Exception
{
132 onClientContact(clientVersion
);
133 final ConnectActionServerString bridge
= this;
136 new ConnectActionClientString(forwardToHost
, forwardToPort
,
137 forwardToKey
, clientVersion
) {
139 public void action(final Version serverVersion
)
141 onServerContact(serverVersion
);
143 for (String fromClient
= bridge
.rec(); fromClient
!= null; fromClient
= bridge
145 onRec(clientVersion
, fromClient
);
146 String fromServer
= send(fromClient
);
147 onSend(serverVersion
, fromServer
);
148 bridge
.send(fromServer
);
151 getTraceHandler().trace("=== DONE", 1);
152 getTraceHandler().trace("", 1);
156 protected void onError(Exception e
) {
157 ServerBridge
.this.onError(e
);
160 } catch (Exception e
) {
161 ServerBridge
.this.onError(e
);
168 * This is the method that is called each time a client contact us.
170 * @param clientVersion
173 protected void onClientContact(Version clientVersion
) {
174 getTraceHandler().trace(">>> CLIENT " + clientVersion
);
178 * This is the method that is called each time a client contact us.
180 * @param serverVersion
183 protected void onServerContact(Version serverVersion
) {
184 getTraceHandler().trace("<<< SERVER " + serverVersion
);
185 getTraceHandler().trace("");
189 * This is the method that is called each time a client contact us.
191 * @param clientVersion
194 * the data sent by the client
196 protected void onRec(Version clientVersion
, String data
) {
197 trace(">>> CLIENT (" + clientVersion
+ ")", data
);
201 * This is the method that is called each time the forwarded server contact
204 * @param serverVersion
207 * the data sent by the client
209 protected void onSend(Version serverVersion
, String data
) {
210 trace("<<< SERVER (" + serverVersion
+ ")", data
);
215 getTraceHandler().trace(
216 getName() + ": will forward to " + forwardToHost
+ ":"
217 + forwardToPort
+ " ("
218 + (forwardToKey
!= null ?
"encrypted" : "plain text")
224 * Trace the data with the given prefix.
227 * the prefix (client, server, version...)
231 private void trace(String prefix
, String data
) {
232 // TODO: we convert to string and back
233 int size
= data
== null ?
0 : data
.length();
234 String ssize
= StringUtils
.formatNumber(size
) + "bytes";
236 getTraceHandler().trace(prefix
+ ": " + ssize
, 1);
238 if (getTraceHandler().getTraceLevel() >= 2) {
240 while (data
.startsWith("ZIP:") || data
.startsWith("B64:")) {
241 if (data
.startsWith("ZIP:")) {
242 data
= StringUtils
.unbase64s(data
.substring(4), true);
243 } else if (data
.startsWith("B64:")) {
244 data
= StringUtils
.unbase64s(data
.substring(4), false);
248 InputStream stream
= new ByteArrayInputStream(
249 data
.getBytes("UTF-8"));
251 Object obj
= new Importer().read(stream
).getValue();
253 getTraceHandler().trace("NULL", 2);
254 getTraceHandler().trace("NULL", 3);
255 getTraceHandler().trace("NULL", 4);
257 if (obj
.getClass().isArray()) {
258 getTraceHandler().trace(
259 "(" + obj
.getClass() + ") with "
260 + Array
.getLength(obj
)
263 getTraceHandler().trace("(" + obj
.getClass() + ")",
266 getTraceHandler().trace("" + obj
.toString(), 3);
267 getTraceHandler().trace(data
, 4);
272 } catch (NoSuchMethodException e
) {
273 getTraceHandler().trace("(not an object)", 2);
274 getTraceHandler().trace(data
, 3);
275 getTraceHandler().trace("", 4);
276 } catch (NoSuchFieldException e
) {
277 getTraceHandler().trace(
278 "(incompatible: " + e
.getMessage() + ")", 2);
279 getTraceHandler().trace(data
, 3);
280 getTraceHandler().trace("", 4);
281 } catch (ClassNotFoundException e
) {
282 getTraceHandler().trace(
283 "(unknown object: " + e
.getMessage() + ")", 2);
284 getTraceHandler().trace(data
, 3);
285 getTraceHandler().trace("", 4);
286 } catch (Exception e
) {
287 getTraceHandler().trace(
288 "(decode error: " + e
.getMessage() + ")", 2);
289 getTraceHandler().trace(data
, 3);
290 getTraceHandler().trace("", 4);
293 getTraceHandler().trace("", 2);