javax.rad.server
Interface IServer

All Known Subinterfaces:

IDirectServer

All Known Implementing Classes:

Server

public interface IServer

The IServer interface defines the methods which are necessary for remote server implementations.

Method Summary

java.lang.Object	createSession(ChangedHashtable<java.lang.String,java.lang.Object> pProperties) Creates a new session for an application.
java.lang.Object	createSubSession(java.lang.Object pSessionId, ChangedHashtable<java.lang.String,java.lang.Object> pProperties) Creates a sub session of an application.
void	destroySession(java.lang.Object pSessionId) Destroyes a session with given identifier.
java.lang.Object	execute(java.lang.Object pSessionId, java.lang.String pObjectName, java.lang.String pMethod, java.lang.Object... pParams) Executes a method call.
java.lang.Object	executeAction(java.lang.Object pSessionId, java.lang.String pAction, java.lang.Object... pParams) Executes an action call.
void	executeActionCallBack(java.lang.Object pSessionId, java.lang.Object pCallBackId, java.lang.String pAction, java.lang.Object... pParams) Executes an asynchronous action call.
void	executeCallBack(java.lang.Object pSessionId, java.lang.Object pCallBackId, java.lang.String pObjectName, java.lang.String pMethod, java.lang.Object... pParams) Executes an asynchronous method call.
java.util.List<ResultObject>	getCallBackResults(java.lang.Object pSessionId) Returns all available objects of an asynchronous execution.
AbstractObjectProvider	getObjectProvider() Gets the AbstractObjectProvider.
ChangedHashtable<java.lang.String,java.lang.Object>	getProperties(java.lang.Object pSessionId) Gets all session properties.
java.lang.Object	getProperty(java.lang.Object pSessionId, java.lang.String pName) Gets the value of a session property.
AbstractSessionManager	getSessionManager() Gets the AbstractSessionManager.
java.lang.Object[]	setAndCheckAlive(java.lang.Object pSessionId, java.lang.Object... pSubSessionId) Sets the alive state for a session and validates the alive state of sub sessions.
void	setNewPassword(java.lang.Object pSessionId, java.lang.String pOldPassword, java.lang.String pNewPassword) Sets a new password for the user of a session.
void	setProperty(java.lang.Object pSessionId, java.lang.String pName, java.lang.Object pValue) Sets a session property.

Method Detail

getObjectProvider

AbstractObjectProvider getObjectProvider()

Gets the AbstractObjectProvider.

Returns:

the object provider.

getSessionManager

AbstractSessionManager getSessionManager()

Gets the AbstractSessionManager.

Returns:

the session manager.

createSession

java.lang.Object createSession(ChangedHashtable<java.lang.String,java.lang.Object> pProperties)
                               throws java.lang.Throwable

Creates a new session for an application. The credentials are stored in the properties.

Parameters:

pProperties - the initial session properties

Returns:

session identifier of newly created Session

Throws:

java.lang.Throwable - if the session can not be created

createSubSession

java.lang.Object createSubSession(java.lang.Object pSessionId,
                                  ChangedHashtable<java.lang.String,java.lang.Object> pProperties)
                                  throws java.lang.Throwable

Creates a sub session of an application. The name/alias of the sub session is stored in the properties.

Parameters:

pSessionId - session identifier

pProperties - the initial session properties

Returns:

session identifier of newly created SubSession

Throws:

java.lang.Throwable - if the session can not be created

destroySession

void destroySession(java.lang.Object pSessionId)

Destroyes a session with given identifier.

Parameters:

pSessionId - session identifier

execute

java.lang.Object execute(java.lang.Object pSessionId,
                         java.lang.String pObjectName,
                         java.lang.String pMethod,
                         java.lang.Object... pParams)
                         throws java.lang.Throwable

Executes a method call.

Parameters:

pSessionId - session identifier

pObjectName - server object name/alias

pMethod - method name which should be called

pParams - parameters for the method call

Returns:

result of method call

Throws:

java.lang.Throwable - if an error occurs during execution

executeCallBack

void executeCallBack(java.lang.Object pSessionId,
                     java.lang.Object pCallBackId,
                     java.lang.String pObjectName,
                     java.lang.String pMethod,
                     java.lang.Object... pParams)
                     throws java.lang.Throwable

Executes an asynchronous method call.

Parameters:

pSessionId - session identifier

pCallBackId - the callback identifier

pObjectName - server object name/alias

pMethod - method name which should be called

pParams - parameters for the method call

Throws:

java.lang.Throwable - if an error occurs during execution

executeAction

java.lang.Object executeAction(java.lang.Object pSessionId,
                               java.lang.String pAction,
                               java.lang.Object... pParams)
                               throws java.lang.Throwable

Executes an action call.

Parameters:

pSessionId - session identifier

pAction - action which should be called

pParams - parameters for the action call

Returns:

result of action call

Throws:

java.lang.Throwable - if an error occurs during execution

executeActionCallBack

void executeActionCallBack(java.lang.Object pSessionId,
                           java.lang.Object pCallBackId,
                           java.lang.String pAction,
                           java.lang.Object... pParams)
                           throws java.lang.Throwable

Executes an asynchronous action call.

Parameters:

pSessionId - session identifier

pCallBackId - the callback identifier

pAction - action which should be called

pParams - parameters for the action call

Throws:

java.lang.Throwable - if an error occurs during execution

getCallBackResults

java.util.List<ResultObject> getCallBackResults(java.lang.Object pSessionId)
                                                throws java.lang.Throwable

Returns all available objects of an asynchronous execution.

Parameters:

pSessionId - session identifier

Returns:

result objects or null if there are no result objects

Throws:

java.lang.Throwable - if an error occurs during execution

setProperty

void setProperty(java.lang.Object pSessionId,
                 java.lang.String pName,
                 java.lang.Object pValue)
                 throws java.lang.Throwable

Sets a session property.

Parameters:

pSessionId - the session identifier

pName - the property name

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

Throws:

java.lang.Throwable - if an error occurs during execution

getProperty

java.lang.Object getProperty(java.lang.Object pSessionId,
                             java.lang.String pName)
                             throws java.lang.Throwable

Gets the value of a session property.

Parameters:

pSessionId - the session identifier

pName - the property name

Returns:

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

Throws:

java.lang.Throwable - if an error occurs during execution

getProperties

ChangedHashtable<java.lang.String,java.lang.Object> getProperties(java.lang.Object pSessionId)
                                                                  throws java.lang.Throwable

Gets all session properties.

Parameters:

pSessionId - the session identifier

Returns:

a ChangedHashtable with property names and values

Throws:

java.lang.Throwable - if an error occurs during execution

setAndCheckAlive

java.lang.Object[] setAndCheckAlive(java.lang.Object pSessionId,
                                    java.lang.Object... pSubSessionId)
                                    throws java.lang.Throwable

Sets the alive state for a session and validates the alive state of sub sessions.

Parameters:

pSessionId - the session id

pSubSessionId - the sub session ids

Returns:

the invalid/expired sub session ids

Throws:

java.lang.Throwable - if an error occurs during execution

setNewPassword

void setNewPassword(java.lang.Object pSessionId,
                    java.lang.String pOldPassword,
                    java.lang.String pNewPassword)
                    throws java.lang.Throwable

Sets a new password for the user of a session.

Parameters:

pSessionId - the session id

pOldPassword - the old password

pNewPassword - the new password

Throws:

java.lang.Throwable - if an error occurs during execution