com.kheops.jmap.net

Class JMapBaseNetworkConnection

java.lang.Object

com.kheops.jmap.net.JMapConnection

com.kheops.jmap.net.JMapBaseNetworkConnection

All Implemented Interfaces:

KSchedulerClient

Direct Known Subclasses:

JMapNetworkConnection, JMapSrvConnection

public abstract class JMapBaseNetworkConnection
extends JMapConnection
implements KSchedulerClient

Abstract superclass over JMapConnection. Encapsulates common instructions and functionalities between JMapNetworkConnection and JMapSrvConnection.

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoReconnect
protected boolean	autoSendPendingRequests
static int	CONN_DIRECT_ALWAYS Deprecated. since JMap 3.1. This connection type is no longer supported. The default behavior for the direct connection is to switch for the proxy mode if the connection can't be made. Use CONN_DIRECT instead.
static int	CONN_PROXY_ALWAYS Deprecated. since JMap 3.1. Use CONN_PROXY instead.
static int	CONN_PROXY_IFNEEDED Deprecated. since JMap 3.1. Use CONN_DIRECT instead.
static int	CONNECTION_DIRECT Connection mode constant.
static int	CONNECTION_PROXY Connection mode constant.
protected java.util.List<JMapConnectionListener>	connectionListeners
protected int	connectionMode
static int	DEFAULT_DIRECT_CONNECTION_TIMEOUT
static int	DEFAULT_PROXY_CONNECTION_TIMEOUT
static int	DEFAULT_READ_TIMEOUT
protected int	directConnectionTimeout
protected java.lang.String	host
protected int	httpPort
static java.lang.String	JMAP_PROXY_SERVLET_PATH
protected int	port
protected java.lang.String	protocol
protected int	proxyConnectionTimeout
protected java.lang.String	proxyPath
static int	READ_TIMEOUT Deprecated.
protected java.lang.String	serverId
protected boolean	useProxy
protected boolean	verbose
protected boolean	workingOffline

Constructor Summary

Constructors

Constructor and Description
JMapBaseNetworkConnection()

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(JMapConnectionListener listener)
void	destroy()
protected void	finalize()
protected void	fireConnectionActivity(JMapConnectionRequestEvent event, boolean active)
protected void	fireConnectionEvent(JMapRequest lastRequest, boolean wasOffline)
protected void	fireDisconnectionEvent(JMapRequest lastRequest)
boolean	getVerbose()
abstract boolean	goOffline()
abstract boolean	goOnline()
boolean	isAutoReconnect() Returns the state of the auto reconnect.
boolean	isAutoSendPendingRequests() Returns the state of the auto send pending requests.
boolean	isOpen()
boolean	isWorkingOffline() Returns the connection state.
abstract void	open(java.lang.String host, int port)
abstract void	open(java.lang.String host, int port, int httpPort, java.lang.String proxyPath, java.lang.String serverId, int connectionMode)
abstract void	open(java.lang.String host, int port, java.lang.String proxyPath, java.lang.String serverId)
abstract 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	removeConnectionListener(JMapConnectionListener listener)
void	schCallback(int jobId) Called by the scheduler to ping the server periodically.
void	setAutoReconnect(boolean autoReconnect) Sets the state of the auto reconnect.
void	setAutoSendPendingRequests(boolean autoSendPendingRequests) Sets the state of the auto send pending requests.
void	setVerbose(boolean verbose)

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

close, executeRequest, executeRequest, isConnected, pingServer, pushRequest

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DIRECT_CONNECTION_TIMEOUT

public static final int DEFAULT_DIRECT_CONNECTION_TIMEOUT

See Also:

Constant Field Values

DEFAULT_PROXY_CONNECTION_TIMEOUT

public static final int DEFAULT_PROXY_CONNECTION_TIMEOUT

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

See Also:

Constant Field Values

READ_TIMEOUT

@Deprecated
public static final int READ_TIMEOUT

Deprecated.

Use JMapBaseNetworkConnection.DEFAULT_READ_TIMEOUT

See Also:

Constant Field Values

JMAP_PROXY_SERVLET_PATH

public static final java.lang.String JMAP_PROXY_SERVLET_PATH

See Also:

Constant Field Values

CONN_PROXY_ALWAYS

@Deprecated
public static final int CONN_PROXY_ALWAYS

Deprecated. since JMap 3.1. Use CONN_PROXY instead.

Connection mode constant. Specifies that the proxy should always be used.

See Also:

Constant Field Values

CONN_DIRECT_ALWAYS

@Deprecated
public static final int CONN_DIRECT_ALWAYS

Deprecated. since JMap 3.1. This connection type is no longer supported. The default behavior for the direct connection is to switch for the proxy mode if the connection can't be made. Use CONN_DIRECT instead.

Connection mode constant. Specifies that a direct socket connection should always be used.

See Also:

Constant Field Values

CONN_PROXY_IFNEEDED

@Deprecated
public static final int CONN_PROXY_IFNEEDED

Deprecated. since JMap 3.1. Use CONN_DIRECT instead.

Connection mode constant. Specifies that a direct socket connection should tried first but if it fails, proxy should be used.

See Also:

Constant Field Values

CONNECTION_DIRECT

public static final int CONNECTION_DIRECT

Connection mode constant. Specifies that a direct socket connection should tried first but if it fails, proxy should be used.

See Also:

Constant Field Values

CONNECTION_PROXY

public static final int CONNECTION_PROXY

Connection mode constant. Specifies that the proxy should always be used.

See Also:

Constant Field Values

protocol

protected java.lang.String protocol

host

protected java.lang.String host

proxyPath

protected java.lang.String proxyPath

serverId

protected java.lang.String serverId

port

protected int port

httpPort

protected int httpPort

directConnectionTimeout

protected int directConnectionTimeout

proxyConnectionTimeout

protected int proxyConnectionTimeout

connectionMode

protected int connectionMode

useProxy

protected boolean useProxy

workingOffline

protected boolean workingOffline

autoReconnect

protected boolean autoReconnect

autoSendPendingRequests

protected boolean autoSendPendingRequests

connectionListeners

protected java.util.List<JMapConnectionListener> connectionListeners

verbose

protected boolean verbose

Constructor Detail

JMapBaseNetworkConnection

public JMapBaseNetworkConnection()

Method Detail

open

public abstract void open(java.lang.String host,
                          int port)
                   throws java.lang.Exception

Throws:

java.lang.Exception

open

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

Throws:

java.lang.Exception

open

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

Throws:

java.lang.Exception

open

public abstract 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.lang.Exception

Throws:

java.lang.Exception

isOpen

public boolean isOpen()

setVerbose

public void setVerbose(boolean verbose)

Parameters:

verbose - The verbose mode

getVerbose

public boolean getVerbose()

Returns:

Returns the verbose mode

addConnectionListener

public void addConnectionListener(JMapConnectionListener listener)

Parameters:

listener -

removeConnectionListener

public void removeConnectionListener(JMapConnectionListener listener)

fireConnectionEvent

protected void fireConnectionEvent(JMapRequest lastRequest,
                                   boolean wasOffline)

fireDisconnectionEvent

protected void fireDisconnectionEvent(JMapRequest lastRequest)

fireConnectionActivity

protected void fireConnectionActivity(JMapConnectionRequestEvent event,
                                      boolean active)

goOffline

public abstract boolean goOffline()

goOnline

public abstract boolean goOnline()

isWorkingOffline

public boolean isWorkingOffline()

Returns the connection state.

Returns:

true if offline; false if online

isAutoReconnect

public boolean isAutoReconnect()

Returns the state of the auto reconnect. Note : false will be returned if offline mode is not allowed.

Returns:

current state

setAutoReconnect

public void setAutoReconnect(boolean autoReconnect)

Sets the state of the auto reconnect. Is the connection will try to reconnect each time a request is asked? Note : Setting this flag at true has no effects if the offline mode is not allowed.

Parameters:

autoReconnect -

isAutoSendPendingRequests

public boolean isAutoSendPendingRequests()

Returns the state of the auto send pending requests.

Returns:

current state

setAutoSendPendingRequests

public void setAutoSendPendingRequests(boolean autoSendPendingRequests)

Sets the state of the auto send pending requests. If true, all pending requests will be executed at next reconnection.

Parameters:

autoSendPendingRequests -

schCallback

public void schCallback(int jobId)

Called by the scheduler to ping the server periodically.

Specified by:

schCallback in interface KSchedulerClient

Parameters:

jobId - the jobId of the job that has been called back

destroy

public void destroy()

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable