IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.clientserver
Interface CSServerService

All Superinterfaces:
Notifier
All Known Implementing Classes:
CSServer

public interface CSServerService
extends Notifier

The CSServerService interface is the C/S service interface on the server side


Field Summary
static java.lang.String CS_INACTIVITY_CLIENT_EVENT
           
static java.lang.String CS_SESSION_EXPIRED
           
 
Method Summary
 void addCSInactivityClientListener(CSInactivityClientListener newListener)
          Adds the specified CSInactivityClientListener to recieve CSInactivityClientEvents from this interface.
 void addCSNotificationListener(CSNotificationListener newListener)
          Adds the specified CSNotificationListener to recieve CSNotificationEvents from this interface.
 void addCSProcessorInactivityListener(CSProcessorInactivityListener newListener)
          Insert the method's description here.
 void addCSReplyErrorEventListener(CSReplyErrorEventListener newListener)
          Adds the specified CSReplyErrorEventListener to recieve CSReplyErrorEvents from this class.
 void checkExpiredSessions()
          When an expired session is found, fire an event and mark the session as expired.
 void fireAndSignalCSInactivityClientEvent(CSInactivityClientEvent anEvent, java.lang.String eventName)
          Method to support listener events.
 void fireAndSignalCSProcessorInactivityEvent(CSProcessorInactivityEvent anEvent, java.lang.String eventName)
          Method to support listener events.
 void fireHandleCSInactivityClientEvent(CSInactivityClientEvent event)
          Method to support listener events.
 void fireHandleCSNotificationEvent(CSNotificationEvent event)
          Supports listener events.
 void fireHandleCSProcessorInactivityEvent(CSProcessorInactivityEvent event)
          Method to support listener events.
 long getAppSessionTimeout()
          Gets the appSessionTimeout
 long getInactivityClientTimeout()
          Returns the value of the inactivityClientTimeout property.
 long getMinTimeStamp()
          Returns the value of the minTimeStamp property.
 boolean getPermanentConnectionForEvents()
          Gets the permanentConnectionForEvents value.
 int getServerStatus()
          Gets the CSServer status.
 java.util.Hashtable getSynchronizedEvents()
          Returns information about clients who are waiting for events.
 long getTimeBetweenSessionCheck()
          Returns the value of the timeBetweenSessionCheck property.
 void initiateServer()
          Initiates the server.
 boolean isSessionAffinity()
          Returns the value of the attribute sessionAffinity.
 boolean isSessionPersistence()
          Returns the value of the attribute sessionPersistence.
 void removeCSInactivityClientListener(CSInactivityClientListener newListener)
          Removes the specified CSInactivityClientListener so that it no longer receives CSInactivityClientEvents from this interfice.
 void removeCSNotificationListener(CSNotificationListener newListener)
          Removes the specified CSNotificationListener so that it no longer receives CSNotificationEvents from this interfice.
 void removeCSProcessorInactivityListener(CSProcessorInactivityListener newListener)
          Insert the method's description here.
 void sendEvent(java.lang.String ws, java.util.EventObject anEvent)
          Sends an event from the server to the specified client workstation.
 void sendEvent(java.lang.String ws, java.util.EventObject anEvent, boolean waitForDelivery)
          Sends an event from the server to the specified client workstation.
 void sendEvent(java.lang.String ipAddress, int port, java.util.EventObject anEvent, boolean waitForDelivery)
          Sends an event from the server to the specified ipAddress and port.
 void setAppSessionTimeout(long appSessionTimeout)
          Sets the appSessionTimeout
 void setInactivityClientTimeout(long value)
          Sets the value of the inactivityClientTimeout property.
 void setMinTimeStamp(long value)
          Sets the value of the minTimeStamp property.
 void setOutputTimeout(long aOutputTimeout)
          Sets the outputTimeout property (long) value.
 void setPermanentConnectionForEvents(boolean permanent)
          Sets the permanentConnectionForEvents value.
 void setPersistTimeout(long aPersistTimeout)
          Sets the persistTimeout property (long) value.
 void setTimeBetweenSessionCheck(long value)
          Sets the value of the timeBetweenSessionCheck property.
 void stopServer()
          Stops the server.
 
Methods inherited from interface com.ibm.btt.base.Notifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, terminate
 

Field Detail

CS_INACTIVITY_CLIENT_EVENT

static final java.lang.String CS_INACTIVITY_CLIENT_EVENT
See Also:
Constant Field Values

CS_SESSION_EXPIRED

static final java.lang.String CS_SESSION_EXPIRED
See Also:
Constant Field Values
Method Detail

addCSInactivityClientListener

void addCSInactivityClientListener(CSInactivityClientListener newListener)
Adds the specified CSInactivityClientListener to recieve CSInactivityClientEvents from this interface.

Parameters:
newListener - com.ibm.btt.clientserver.CSInactivityClientListener

addCSNotificationListener

void addCSNotificationListener(CSNotificationListener newListener)
Adds the specified CSNotificationListener to recieve CSNotificationEvents from this interface.

Parameters:
newListener - com.ibm.btt.clientserver.CSNotificationListener

addCSProcessorInactivityListener

void addCSProcessorInactivityListener(CSProcessorInactivityListener newListener)
Insert the method's description here. Creation date: (10/11/2001 1:18:53 PM)

Parameters:
newListener - com.ibm.btt.cs.servlet.CSProcessorInactivityListener

addCSReplyErrorEventListener

void addCSReplyErrorEventListener(CSReplyErrorEventListener newListener)
Adds the specified CSReplyErrorEventListener to recieve CSReplyErrorEvents from this class.

Parameters:
newListener - com.ibm.btt.cs.servlet.CSReplyErrorEventListener

checkExpiredSessions

void checkExpiredSessions()
                          throws DSEInvalidRequestException,
                                 DSEObjectNotFoundException
When an expired session is found, fire an event and mark the session as expired. Method called from the ExpiredSessionsChecker thread. It is synchronized with the addSession and removeSession methods.

Throws:
DSEInvalidRequestException
DSEObjectNotFoundException

fireAndSignalCSInactivityClientEvent

void fireAndSignalCSInactivityClientEvent(CSInactivityClientEvent anEvent,
                                          java.lang.String eventName)
Method to support listener events.

Parameters:
event - com.ibm.btt.cs.servlet.CSInactivityClientEvent

fireAndSignalCSProcessorInactivityEvent

void fireAndSignalCSProcessorInactivityEvent(CSProcessorInactivityEvent anEvent,
                                             java.lang.String eventName)
Method to support listener events.

Parameters:
event - com.ibm.btt.cs.servlet.CSProcessorInactivityEvent

fireHandleCSInactivityClientEvent

void fireHandleCSInactivityClientEvent(CSInactivityClientEvent event)
Method to support listener events.

Parameters:
event - com.ibm.btt.cs.servlet.CSInactivityClientEvent

fireHandleCSNotificationEvent

void fireHandleCSNotificationEvent(CSNotificationEvent event)
Supports listener events.

Parameters:
event - com.ibm.btt.clientserver.CSNotificationEvent

fireHandleCSProcessorInactivityEvent

void fireHandleCSProcessorInactivityEvent(CSProcessorInactivityEvent event)
Method to support listener events.

Parameters:
event - com.ibm.btt.cs.servlet.CSProcessorInactivityEvent

getAppSessionTimeout

long getAppSessionTimeout()
Gets the appSessionTimeout

Returns:
Returns a long

getInactivityClientTimeout

long getInactivityClientTimeout()
Returns the value of the inactivityClientTimeout property.

Returns:
long - The current value of inactivityClientTimeout

getMinTimeStamp

long getMinTimeStamp()
Returns the value of the minTimeStamp property.

Returns:
long - The current value of minTimeStamp

getServerStatus

int getServerStatus()
Gets the CSServer status.

Returns:
int

getSynchronizedEvents

java.util.Hashtable getSynchronizedEvents()
Returns information about clients who are waiting for events.

Returns:
Hashtable

getTimeBetweenSessionCheck

long getTimeBetweenSessionCheck()
Returns the value of the timeBetweenSessionCheck property.

Returns:
long - The current value of timeBetweenSessionCheck

initiateServer

void initiateServer()
                    throws DSECSServerNotStartedException,
                           DSECSInvalidRequestException
Initiates the server. The server waits for client requests.

Throws:
DSECSServerNotStartedException
DSECSInvalidRequestException

isSessionAffinity

boolean isSessionAffinity()
Returns the value of the attribute sessionAffinity. If this attribute has not been yet initialized, the initialization is invoked.

Returns:
boolean

isSessionPersistence

boolean isSessionPersistence()
Returns the value of the attribute sessionPersistence. If this attribute has not been yet initialized, the initialization is invoked.

Returns:
boolean

removeCSInactivityClientListener

void removeCSInactivityClientListener(CSInactivityClientListener newListener)
Removes the specified CSInactivityClientListener so that it no longer receives CSInactivityClientEvents from this interfice.

Parameters:
newListener - com.ibm.btt.clientserver.servlet.CSInactivityClientListener

removeCSNotificationListener

void removeCSNotificationListener(CSNotificationListener newListener)
Removes the specified CSNotificationListener so that it no longer receives CSNotificationEvents from this interfice.

Parameters:
newListener - com.ibm.btt.clientserver.CSNotificationListener

removeCSProcessorInactivityListener

void removeCSProcessorInactivityListener(CSProcessorInactivityListener newListener)
Insert the method's description here. Creation date: (10/11/2001 1:21:41 PM)

Parameters:
newListener - com.ibm.btt.cs.servlet.CSProcessorInactivityListener

sendEvent

void sendEvent(java.lang.String ws,
               java.util.EventObject anEvent)
Sends an event from the server to the specified client workstation.

Parameters:
wk - java.lang.String
anEvent - Event

sendEvent

void sendEvent(java.lang.String ws,
               java.util.EventObject anEvent,
               boolean waitForDelivery)
               throws DSECSSocketException
Sends an event from the server to the specified client workstation.

Parameters:
wk - java.lang.String
anEvent - Event
waitForDelivery - boolean
Throws:
DSECSSocketException

setAppSessionTimeout

void setAppSessionTimeout(long appSessionTimeout)
Sets the appSessionTimeout

Parameters:
appSessionTimeout - - The appSessionTimeout to set

setInactivityClientTimeout

void setInactivityClientTimeout(long value)
Sets the value of the inactivityClientTimeout property.

Parameters:
value - long - The new value of the property

setMinTimeStamp

void setMinTimeStamp(long value)
Sets the value of the minTimeStamp property.

Parameters:
value - long - The new value of the property

setOutputTimeout

void setOutputTimeout(long aOutputTimeout)
Sets the outputTimeout property (long) value.

Parameters:
aOutputTimeout - long

setPersistTimeout

void setPersistTimeout(long aPersistTimeout)
Sets the persistTimeout property (long) value.

Parameters:
aPersistTimeout - long

setTimeBetweenSessionCheck

void setTimeBetweenSessionCheck(long value)
Sets the value of the timeBetweenSessionCheck property.

Parameters:
value - long - The new value of the property.

stopServer

void stopServer()
                throws DSECSInvalidRequestException
Stops the server.

Throws:
DSECSInvalidRequestException

getPermanentConnectionForEvents

boolean getPermanentConnectionForEvents()
Gets the permanentConnectionForEvents value.

Returns:
boolean

setPermanentConnectionForEvents

void setPermanentConnectionForEvents(boolean permanent)
Sets the permanentConnectionForEvents value.

Parameters:
permanent - boolean

sendEvent

void sendEvent(java.lang.String ipAddress,
               int port,
               java.util.EventObject anEvent,
               boolean waitForDelivery)
               throws DSECSSocketException
Sends an event from the server to the specified ipAddress and port. Executes the following process: - Creates a socket using the IPaddress and port number - Writes the event data to the socket output stream - Closes the socket

Parameters:
ipAddress - java.lang.String
port - int
anEvent - EventObject
waitForDelivery - boolean
Throws:
DSEException - - Error sending the event to the listener
DSECSSocketException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011