com.sibvisions.rad.util
Class DirectObjectConnection

java.lang.Object
  com.sibvisions.rad.util.DirectObjectConnection

All Implemented Interfaces:

IConnection

public class DirectObjectConnection
extends java.lang.Object
implements IConnection

The DirectObjectConnection enables direct object calls without the need of a server. It's possible to use the original client implementation and pass server and lifecycle objects. But it is important to specify all needed server objects by name (manual lifecycle handling).

Field Summary

Fields inherited from interface javax.rad.remote.IConnection

COMPRESSION_BYTES, FLAG_ACKNOWLEDGE, FLAG_BROKEN, FLAG_ESTABLISHED, MET_SESSION_CREATE, MET_SESSION_DESTROY, MET_SESSION_GET_PROPERTIES, MET_SESSION_GET_PROPERTY, MET_SESSION_SET_NEW_PASSWORD, MET_SESSION_SET_PROPERTY, MET_SESSION_SETCHECKALIVE, MET_SESSION_SUBSESSION_CREATE, MODE_COMPRESSED, MODE_UNCOMPRESSED, NOPARAMETER, OBJ_SESSION, TYPE_CALL_ERROR, TYPE_CALL_RESULT, TYPE_CALLBACK_ERROR, TYPE_CALLBACK_RESULT, TYPE_CALLBACKRESULT_RESULT, TYPE_PROPERTY_RESULT

Constructor Summary

DirectObjectConnection()
Creates a new instance of DirectObjectConnection without any object.

DirectObjectConnection(java.util.Map<java.lang.String,java.lang.Object> pObjects)
Creates a new instance of DirectObjectConnection with predefined objects.

Method Summary

void	addCallBackResultListener(ICallBackResultListener pListener) Adds an ICallBackResultListener to the list of registered listeners.
void	addPropertyChangedListener(IConnectionPropertyChangedListener pListener) Adds an IConnectionPropertyChangedListener to the list of registered listeners.
java.lang.Object[]	call(ConnectionInfo pConnectionInfo, java.lang.String[] pObjectName, java.lang.String[] pMethod, java.lang.Object[][] pParams, ICallBackListener[] pCallBack) Calls a list of methods from objects identified by name(s).
void	close(ConnectionInfo pConnectionInfo) Close the connection to the server.
java.lang.Object	get(java.lang.String pName) Gets a specific object from the list of known objects.
java.util.Hashtable<java.lang.String,java.lang.Object>	getProperties(ConnectionInfo pConnectionInfo) Gets a clone of all connection properties.
java.lang.Object	getProperty(ConnectionInfo pConnectionInfo, java.lang.String pName) Gets a connection property.
boolean	isCalling() Gets whether a call is active.
boolean	isOpen(ConnectionInfo pConnectionInfo) The connection is always open.
void	open(ConnectionInfo pConnectionInfo) Sets a random connection ID.
void	openSub(ConnectionInfo pConnectionInfo, ConnectionInfo pConnectionInfoSub) Sets a random connection ID for the sub connection.
java.lang.Object	put(java.lang.String pName, java.lang.Object pObject) Puts an object to the list of known objects.
java.lang.Object	remove(java.lang.String pName) Removes an object from the list of known objects.
void	removeCallBackResultListener(ICallBackResultListener pListener) Removes an ICallBackResultListener from the list of registered listeners.
void	removePropertyChangedListener(IConnectionPropertyChangedListener pListener) Removes an IConnectionPropertyChangedListener from the list of registered listeners.
void	reopen(ConnectionInfo pConnectionInfo) Not supported.
ConnectionInfo[]	setAndCheckAlive(ConnectionInfo pConnectionInfo, ConnectionInfo[] pSubConnections) Returns null.
void	setNewPassword(ConnectionInfo pConnectionInfo, java.lang.String pOldPassword, java.lang.String pNewPassword) Sets a new password for the connected user.
void	setProperty(ConnectionInfo pConnectionInfo, java.lang.String pName, java.lang.Object pValue) Sets a connection property.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectObjectConnection

public DirectObjectConnection()

Creates a new instance of DirectObjectConnection without any object.

DirectObjectConnection

public DirectObjectConnection(java.util.Map<java.lang.String,java.lang.Object> pObjects)

Creates a new instance of DirectObjectConnection with predefined objects.

Parameters:

pObjects - the initial objects.

Method Detail

call

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

Calls a list of methods from objects identified by name(s). The object is searched in the known map of objects. It's not possible to use callback listeners and it's also not possible to call actions. Only specific object calls are implemented.

Specified by:

call in interface IConnection

Parameters:

pConnectionInfo - the connection info

pObjectName - the object names

pMethod - the method names

pParams - the method params

pCallBack - the callback listeners

Returns:

the result of the method calls

Throws:

java.lang.Throwable - if an exception occurs

isCalling

public boolean isCalling()

Gets whether a call is active.

Specified by:

isCalling in interface IConnection

Returns:

true if a call is active, false otherwise

close

public void close(ConnectionInfo pConnectionInfo)
           throws java.lang.Throwable

Close the connection to the server.

Specified by:

close in interface IConnection

Parameters:

pConnectionInfo - the connection information

Throws:

java.lang.Throwable - if the connection can not be established

getProperties

public java.util.Hashtable<java.lang.String,java.lang.Object> getProperties(ConnectionInfo pConnectionInfo)
                                                                     throws java.lang.Throwable

Gets a clone of all connection properties.

Specified by:

getProperties in interface IConnection

Parameters:

pConnectionInfo - the connection information

Returns:

a Hashtable with property names and values

Throws:

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

getProperty

public java.lang.Object getProperty(ConnectionInfo pConnectionInfo,
                                    java.lang.String pName)
                             throws java.lang.Throwable

Gets a connection property.

Specified by:

getProperty in interface IConnection

Parameters:

pConnectionInfo - the connection information

pName - the property name

Returns:

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

Throws:

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

isOpen

public boolean isOpen(ConnectionInfo pConnectionInfo)

The connection is always open.

Specified by:

isOpen in interface IConnection

Parameters:

pConnectionInfo - the connection info

Returns:

true

open

public void open(ConnectionInfo pConnectionInfo)

Sets a random connection ID.

Specified by:

open in interface IConnection

Parameters:

pConnectionInfo - the connection info

openSub

public void openSub(ConnectionInfo pConnectionInfo,
                    ConnectionInfo pConnectionInfoSub)

Sets a random connection ID for the sub connection.

Specified by:

openSub in interface IConnection

Parameters:

pConnectionInfo - the connection info

pConnectionInfoSub - the sub connection info

reopen

public void reopen(ConnectionInfo pConnectionInfo)

Not supported.

Parameters:

pConnectionInfo - the connection info

setAndCheckAlive

public ConnectionInfo[] setAndCheckAlive(ConnectionInfo pConnectionInfo,
                                         ConnectionInfo[] pSubConnections)

Returns null.

Specified by:

setAndCheckAlive in interface IConnection

Parameters:

pConnectionInfo - the connection info

pSubConnections - the current sub connection infos

Returns:

null

setNewPassword

public void setNewPassword(ConnectionInfo pConnectionInfo,
                           java.lang.String pOldPassword,
                           java.lang.String pNewPassword)
                    throws java.lang.Throwable

Sets a new password for the connected user.

Specified by:

setNewPassword in interface IConnection

Parameters:

pConnectionInfo - the connection information

pOldPassword - the old password

pNewPassword - the new password

Throws:

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

setProperty

public void setProperty(ConnectionInfo pConnectionInfo,
                        java.lang.String pName,
                        java.lang.Object pValue)
                 throws java.lang.Throwable

Sets a connection property.

Specified by:

setProperty in interface IConnection

Parameters:

pConnectionInfo - the connection information

pName - the property name

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

Throws:

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

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

addPropertyChangedListener

public void addPropertyChangedListener(IConnectionPropertyChangedListener pListener)

Adds an IConnectionPropertyChangedListener to the list of registered listeners.

Specified by:

addPropertyChangedListener in interface IConnection

Parameters:

pListener - the new property changed listener.

removePropertyChangedListener

public void removePropertyChangedListener(IConnectionPropertyChangedListener pListener)

Removes an IConnectionPropertyChangedListener from the list of registered listeners.

Specified by:

removePropertyChangedListener in interface IConnection

Parameters:

pListener - the property changed listener to remove

addCallBackResultListener

public void addCallBackResultListener(ICallBackResultListener pListener)

Adds an ICallBackResultListener to the list of registered listeners.

Specified by:

addCallBackResultListener in interface IConnection

Parameters:

pListener - the new callback result listener.

removeCallBackResultListener

public void removeCallBackResultListener(ICallBackResultListener pListener)

Removes an ICallBackResultListener from the list of registered listeners.

Specified by:

removeCallBackResultListener in interface IConnection

Parameters:

pListener - the callback result listener to remove

put

public java.lang.Object put(java.lang.String pName,
                            java.lang.Object pObject)

Puts an object to the list of known objects.

Parameters:

pName - the object name

pObject - the object or null to remove the object with the specified name

Returns:

the previous object if the key is present

get

public java.lang.Object get(java.lang.String pName)

Gets a specific object from the list of known objects.

Parameters:

pName - the object name

Returns:

the object or null if object wasn't found

remove

public java.lang.Object remove(java.lang.String pName)

Removes an object from the list of known objects.

Parameters:

pName - the object name

Returns:

the object for the object name