com.kheops.jmap.net

Class JMapNetworkConnection

java.lang.Object

com.kheops.jmap.net.JMapConnection

com.kheops.jmap.net.JMapBaseNetworkConnection

com.kheops.jmap.net.JMapNetworkConnection

All Implemented Interfaces:

KSchedulerClient

public class JMapNetworkConnection
extends JMapBaseNetworkConnection

This class represents a network connection between a client application and JMapServer.

See Also:

JMapConnection

Field Summary

Fields inherited from class com.kheops.jmap.net.JMapBaseNetworkConnection

autoReconnect, autoSendPendingRequests, CONN_DIRECT_ALWAYS, CONN_PROXY_ALWAYS, CONN_PROXY_IFNEEDED, CONNECTION_DIRECT, CONNECTION_PROXY, connectionListeners, connectionMode, DEFAULT_DIRECT_CONNECTION_TIMEOUT, DEFAULT_PROXY_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT, directConnectionTimeout, host, httpPort, JMAP_PROXY_SERVLET_PATH, port, protocol, proxyConnectionTimeout, proxyPath, READ_TIMEOUT, serverId, useProxy, verbose, workingOffline

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JMapNetworkConnection() Creates a raw network connection that won't be initialized until initConnection() is called.

Method Summary

Modifier and Type	Method and Description
boolean	cancelRequest(JMapRequest pushedRequest) Method that cancels a previously pushed request.
void	close() Closes the connection.
static java.lang.Object	deserializeObject(byte[] bytes) Deprecated. use IOUtil.deserialize(byte[]) instead.
void	destroy()
byte[]	executeRequest(byte[] requestBytes) Blocking method that sends a pre-serialized request (byte array) to JMapServer and returns the serialized response object (byte array) obtained from JMapServer.
JMapResponse	executeRequest(JMapRequest request) Blocking method that sends a request to JMapServer and returns the response object obtained from JMapServer. Notes about the offline mode : - If working offline and the auto reconnect option is true, it will try to reconnect before sending the request; - If working offline, the OfflineRequestHandler will process the request; - If offline mode is not allowed and the connection is lost, a null response will be returned;
int	getReadTimeout()
boolean	goOffline() This function will force the offline mode.
boolean	goOnline() This function will force the online mode.
protected void	initConnection()
boolean	isConnected()
void	open(java.lang.String host, int port) Opens a raw network connection with JMapServer using the specified host and port information.
void	open(java.lang.String host, int port, int httpPort, java.lang.String proxyPath, java.lang.String serverId, int connectionMode)
void	open(java.lang.String host, int port, java.lang.String proxyPath, java.lang.String serverId) Opens a HTTP network connection with JMapServer using the specified host, port, proxy path and serverId.
void	open(java.lang.String protocol, java.lang.String host, int port, int httpPort, java.lang.String proxyPath, java.lang.String serverId, int connectionMode)
void	pushRequest(JMapRequest request) Non-blocking method that pushes a request in the queue.
static byte[]	rawReceive(java.io.DataInputStream is)
static void	rawSend(byte[] bytes, java.io.DataOutputStream os)
static byte[]	serializeObject(java.io.Serializable o) Deprecated. use IOUtil.serialize(Serializable) instead.
void	setReadTimeout(int readTimeout)

Methods inherited from class com.kheops.jmap.net.JMapBaseNetworkConnection

addConnectionListener, finalize, fireConnectionActivity, fireConnectionEvent, fireDisconnectionEvent, getVerbose, isAutoReconnect, isAutoSendPendingRequests, isOpen, isWorkingOffline, removeConnectionListener, schCallback, setAutoReconnect, setAutoSendPendingRequests, setVerbose

Methods inherited from class com.kheops.jmap.net.JMapConnection

pingServer

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JMapNetworkConnection

protected JMapNetworkConnection()

Creates a raw network connection that won't be initialized until initConnection() is called.

Method Detail

open

public void open(java.lang.String host,
                 int port)
          throws java.io.IOException

Opens a raw network connection with JMapServer using the specified host and port information.

Specified by:

open in class JMapBaseNetworkConnection

Parameters:

host - IP address or name of JMapServer host

port - network port to use

Throws:

java.io.IOException

open

public void open(java.lang.String host,
                 int port,
                 java.lang.String proxyPath,
                 java.lang.String serverId)
          throws java.io.IOException

Opens a HTTP network connection with JMapServer using the specified host, port, proxy path and serverId. This will create a URL of the form http://host:port/proxyPath?serverId=serverId that will be used for communication between the client application and JMapServer.

Specified by:

open in class JMapBaseNetworkConnection

Parameters:

host - IP address or name of JMapServer host

port - network port to use

proxyPath - the path of the proxy servlet

serverId - the server to connect to behind the proxy

Throws:

java.io.IOException

open

public void open(java.lang.String host,
                 int port,
                 int httpPort,
                 java.lang.String proxyPath,
                 java.lang.String serverId,
                 int connectionMode)
          throws java.io.IOException

Specified by:

open in class JMapBaseNetworkConnection

Throws:

java.io.IOException

open

public void open(java.lang.String protocol,
                 java.lang.String host,
                 int port,
                 int httpPort,
                 java.lang.String proxyPath,
                 java.lang.String serverId,
                 int connectionMode)
          throws java.io.IOException

Specified by:

open in class JMapBaseNetworkConnection

Throws:

java.io.IOException

isConnected

public boolean isConnected()

Specified by:

isConnected in class JMapConnection

initConnection

protected void initConnection()
                       throws java.io.IOException

Throws:

java.io.IOException

goOffline

public boolean goOffline()

This function will force the offline mode.

Specified by:

goOffline in class JMapBaseNetworkConnection

Returns:

true if successful, false if the connection is already in offline mode

goOnline

public boolean goOnline()

This function will force the online mode.

Specified by:

goOnline in class JMapBaseNetworkConnection

Returns:

true if successful

pushRequest

public void pushRequest(JMapRequest request)

Non-blocking method that pushes a request in the queue. Requests placed in the queue are sent to JMapServer one after the other. When the response is obtained from JMapServer, the client specified in the request object is notified through its callback method.

Specified by:

pushRequest in class JMapConnection

Parameters:

request - the request to send to JMapServer

See Also:

JMapRequestClient, JMapRequest

executeRequest

public JMapResponse executeRequest(JMapRequest request)
                            throws java.io.IOException

Blocking method that sends a request to JMapServer and returns the response object obtained from JMapServer.

Notes about the offline mode :
- If working offline and the auto reconnect option is true, it will try to reconnect before sending the request;
- If working offline, the OfflineRequestHandler will process the request;
- If offline mode is not allowed and the connection is lost, a null response will be returned;

Specified by:

executeRequest in class JMapConnection

Parameters:

request - the request to send to JMapServer

Returns:

response from JMapServer (working online) or OfflineRequestHandler (worling offline). null will be return if disconnected and offline mode is not allowed

Throws:

java.io.IOException

cancelRequest

public boolean cancelRequest(JMapRequest pushedRequest)

Method that cancels a previously pushed request. The request will be cancelled ONLY if it is NOT currently in execution.

Parameters:

pushedRequest -

Returns:

true if the cancel was successful

executeRequest

public byte[] executeRequest(byte[] requestBytes)
                      throws java.io.IOException

Blocking method that sends a pre-serialized request (byte array) to JMapServer and returns the serialized response object (byte array) obtained from JMapServer.

Specified by:

executeRequest in class JMapConnection

Parameters:

requestBytes - the request bytes to send to JMapServer

Returns:

the response from JMapServer

Throws:

java.io.IOException

rawSend

public static void rawSend(byte[] bytes,
                           java.io.DataOutputStream os)
                    throws java.io.IOException

Throws:

java.io.IOException

rawReceive

public static byte[] rawReceive(java.io.DataInputStream is)
                         throws java.io.IOException

Throws:

java.io.IOException

close

public void close()

Closes the connection.

Specified by:

close in class JMapConnection

destroy

public void destroy()

Overrides:

destroy in class JMapBaseNetworkConnection

serializeObject

@Deprecated
public static byte[] serializeObject(java.io.Serializable o)
                                          throws java.io.IOException

Deprecated. use IOUtil.serialize(Serializable) instead.

Throws:

java.io.IOException

deserializeObject

@Deprecated
public static java.lang.Object deserializeObject(byte[] bytes)
                                                      throws java.io.IOException

Deprecated. use IOUtil.deserialize(byte[]) instead.

Throws:

java.io.IOException

getReadTimeout

public int getReadTimeout()

setReadTimeout

public void setReadTimeout(int readTimeout)