javax.rad.remote
Interface IConnection

All Known Implementing Classes:

AbstractSerializedConnection, DirectObjectConnection, DirectServerConnection, HttpConnection

public interface IConnection

The IConnection interface defines all methods for the communication between client and server.

Field Summary

static int	COMPRESSION_BYTES the max. bytes for uncompressed communication (more bytes switches to compressed mode).
static int	FLAG_ACKNOWLEDGE the acknowledge flag.
static int	FLAG_BROKEN the broken flag.
static int	FLAG_ESTABLISHED the established flag.
static String	MET_SESSION_CREATE Constant for the session create method.
static String	MET_SESSION_DESTROY Constant for the session destroy method.
static String	MET_SESSION_GET_PROPERTIES Constant for the get properties method.
static String	MET_SESSION_GET_PROPERTY Constant for the get property method.
static String	MET_SESSION_SET_NEW_PASSWORD Constant for the set new password method.
static String	MET_SESSION_SET_PROPERTY Constant for the set property method.
static String	MET_SESSION_SETCHECKALIVE Constant for the set and check of the session alive state.
static String	MET_SESSION_SUBSESSION_CREATE Constant for the sub session create method.
static int	MODE_COMPRESSED Constant type for compressed communication.
static int	MODE_UNCOMPRESSED Constant type for uncompressed communication.
static String	OBJ_SESSION Constant for the internal session handler.
static byte	TYPE_CALL_ERROR Constant type for exception return values.
static byte	TYPE_CALL_RESULT Constant type for return values from remote method calls.
static byte	TYPE_CALLBACK_ERROR Constant type for failed callback remote method calls.
static byte	TYPE_CALLBACK_RESULT Constant type for successful callback remote method calls.
static byte	TYPE_PROPERTY_RESULT Constant type for properties from the server.

Method Summary

void	addPropertyChangedListener(IConnectionPropertyChangedListener pListener) Adds an IConnectionPropertyChangedListener to the list of registered listeners.
Object[]	call(ConnectionInfo pConnectionInfo, String[] pObjectName, String[] pMethod, Object[][] pParams, ICallBackListener[] pCallBack) Calls desired methods from a remote server object.
void	close(ConnectionInfo pConnectionInfo) Close the connection to the server.
Hashtable<String,Object>	getProperties(ConnectionInfo pConnectionInfo) Gets a clone of all connection properties.
Object	getProperty(ConnectionInfo pConnectionInfo, String pName) Gets a connection property.
boolean	isCalling() Gets whether a call is active.
boolean	isOpen(ConnectionInfo pConnectionInfo) Checks if the connection to the server is opened.
void	open(ConnectionInfo pConnectionInfo) Opens the connection to the server.
void	openSub(ConnectionInfo pConnectionInfo, ConnectionInfo pConnectionInfoSub) Opens a new sub connection.
void	removePropertyChangedListener(IConnectionPropertyChangedListener pListener) Removes an IConnectionPropertyChangedListener from the list of registered listeners.
ConnectionInfo[]	setAndCheckAlive(ConnectionInfo pConnectionInfo, ConnectionInfo[] pSubConnections) Sets the alive state for a connection, on the server, and validates the alive state of subconnections.
void	setNewPassword(ConnectionInfo pConnectionInfo, String pOldPassword, String pNewPassword) Sets a new password for the connected user.
void	setProperty(ConnectionInfo pConnectionInfo, String pName, Object pValue) Sets a connection property.

Field Detail

COMPRESSION_BYTES

static final int COMPRESSION_BYTES

the max. bytes for uncompressed communication (more bytes switches to compressed mode).

See Also:

Constant Field Values

MODE_UNCOMPRESSED

static final int MODE_UNCOMPRESSED

Constant type for uncompressed communication.

See Also:

Constant Field Values

MODE_COMPRESSED

static final int MODE_COMPRESSED

Constant type for compressed communication.

See Also:

Constant Field Values

FLAG_ACKNOWLEDGE

static final int FLAG_ACKNOWLEDGE

the acknowledge flag.

See Also:

Constant Field Values

FLAG_ESTABLISHED

static final int FLAG_ESTABLISHED

the established flag.

See Also:

Constant Field Values

FLAG_BROKEN

static final int FLAG_BROKEN

the broken flag.

See Also:

Constant Field Values

TYPE_CALLBACK_RESULT

static final byte TYPE_CALLBACK_RESULT

Constant type for successful callback remote method calls.

See Also:

Constant Field Values

TYPE_CALLBACK_ERROR

static final byte TYPE_CALLBACK_ERROR

Constant type for failed callback remote method calls.

See Also:

Constant Field Values

TYPE_CALL_RESULT

static final byte TYPE_CALL_RESULT

Constant type for return values from remote method calls.

See Also:

Constant Field Values

TYPE_CALL_ERROR

static final byte TYPE_CALL_ERROR

Constant type for exception return values.

See Also:

Constant Field Values

TYPE_PROPERTY_RESULT

static final byte TYPE_PROPERTY_RESULT

Constant type for properties from the server.

See Also:

Constant Field Values

OBJ_SESSION

static final String OBJ_SESSION

Constant for the internal session handler.

See Also:

Constant Field Values

MET_SESSION_CREATE

static final String MET_SESSION_CREATE

Constant for the session create method.

See Also:

Constant Field Values

MET_SESSION_SUBSESSION_CREATE

static final String MET_SESSION_SUBSESSION_CREATE

Constant for the sub session create method.

See Also:

Constant Field Values

MET_SESSION_DESTROY

static final String MET_SESSION_DESTROY

Constant for the session destroy method.

See Also:

Constant Field Values

MET_SESSION_SET_PROPERTY

static final String MET_SESSION_SET_PROPERTY

Constant for the set property method.

See Also:

Constant Field Values

MET_SESSION_GET_PROPERTY

static final String MET_SESSION_GET_PROPERTY

Constant for the get property method.

See Also:

Constant Field Values

MET_SESSION_GET_PROPERTIES

static final String MET_SESSION_GET_PROPERTIES

Constant for the get properties method.

See Also:

Constant Field Values

MET_SESSION_SETCHECKALIVE

static final String MET_SESSION_SETCHECKALIVE

Constant for the set and check of the session alive state.

See Also:

Constant Field Values

MET_SESSION_SET_NEW_PASSWORD

static final String MET_SESSION_SET_NEW_PASSWORD

Constant for the set new password method.

See Also:

Constant Field Values

Method Detail

open

void open(ConnectionInfo pConnectionInfo)
          throws Throwable

Opens the connection to the server. The credentials have to be a key/value mapping in the connection information.

Parameters:

pConnectionInfo - the connection information

Throws:

Throwable - if the connection can not be established

openSub

void openSub(ConnectionInfo pConnectionInfo,
             ConnectionInfo pConnectionInfoSub)
             throws Throwable

Opens a new sub connection. The name of the sub connection has to be a key/value mapping in the sub connection information.

Parameters:

pConnectionInfo - the connection information of the master connection

pConnectionInfoSub - the connection information of the sub connection

Throws:

Throwable - communication error, security checks, invalid method, ...

isOpen

boolean isOpen(ConnectionInfo pConnectionInfo)

Checks if the connection to the server is opened.

Parameters:

pConnectionInfo - the connection information

Returns:

true if the connection is open

close

void close(ConnectionInfo pConnectionInfo)
           throws Throwable

Close the connection to the server.

Parameters:

pConnectionInfo - the connection information

Throws:

Throwable - if the connection can not be established

call

Object[] call(ConnectionInfo pConnectionInfo,
              String[] pObjectName,
              String[] pMethod,
              Object[][] pParams,
              ICallBackListener[] pCallBack)
              throws Throwable

Calls desired methods from a remote server object.

Parameters:

pConnectionInfo - the connection information

pObjectName - list of server object names/aliases

pMethod - method names which should be called

pParams - parameters for the method calls

pCallBack - callback listeners for asynchronous or null for synchronous calls

Returns:

result list from the remote method calls

Throws:

Throwable - communication error, security checks, invalid method, ...

isCalling

boolean isCalling()

Gets whether a call is active.

Returns:

true if a call is active, false otherwise

setAndCheckAlive

ConnectionInfo[] setAndCheckAlive(ConnectionInfo pConnectionInfo,
                                  ConnectionInfo[] pSubConnections)
                                  throws Throwable

Sets the alive state for a connection, on the server, and validates the alive state of subconnections.

Parameters:

pConnectionInfo - the connection information

pSubConnections - the connection information of the sub connections, for the alive validation

Returns:

the invalid/expired sub connections

Throws:

Throwable - communication error, security checks, invalid method, ...

setProperty

void setProperty(ConnectionInfo pConnectionInfo,
                 String pName,
                 Object pValue)
                 throws Throwable

Sets a connection property.

Parameters:

pConnectionInfo - the connection information

pName - the property name

pValue - the value of the property or null to delete the property

Throws:

Throwable - communication error, security checks, invalid method, ...

SecurityException - if it's not allowed to set the property

getProperty

Object getProperty(ConnectionInfo pConnectionInfo,
                   String pName)
                   throws Throwable

Gets a connection property.

Parameters:

pConnectionInfo - the connection information

pName - the property name

Returns:

the value of the property or null if the property is not set

Throws:

Throwable - communication error, security checks, invalid method, ...

getProperties

Hashtable<String,Object> getProperties(ConnectionInfo pConnectionInfo)
                                       throws Throwable

Gets a clone of all connection properties.

Parameters:

pConnectionInfo - the connection information

Returns:

a Hashtable with property names and values

Throws:

Throwable - communication error, security checks, invalid method, ...

addPropertyChangedListener

void addPropertyChangedListener(IConnectionPropertyChangedListener pListener)

Adds an IConnectionPropertyChangedListener to the list of registered listeners.

Parameters:

pListener - the new property changed listener.

removePropertyChangedListener

void removePropertyChangedListener(IConnectionPropertyChangedListener pListener)

Removes an IConnectionPropertyChangedListener from the list of registered listeners.

Parameters:

pListener - the property changed listener to remove

setNewPassword

void setNewPassword(ConnectionInfo pConnectionInfo,
                    String pOldPassword,
                    String pNewPassword)
                    throws Throwable

Sets a new password for the connected user.

Parameters:

pConnectionInfo - the connection information

pOldPassword - the old password

pNewPassword - the new password

Throws:

Throwable - communication error, security checks, invalid method, ...