IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.event
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 fireAndSignalCSInactivityClientEvent(CSInactivityClientEvent 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.
 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 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.event.Notifier
getName, setName, signalEvent, signalEvent, terminate
 

Field Detail

CS_INACTIVITY_CLIENT_EVENT

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

CS_SESSION_EXPIRED

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

addCSInactivityClientListener

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

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

addCSNotificationListener

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

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

fireAndSignalCSInactivityClientEvent

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

Parameters:
anEvent - com.ibm.dse.btt.event.CSInactivityClientEvent
eventName - java.lang.String

fireHandleCSInactivityClientEvent

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

Parameters:
event - com.ibm.dse..btt.event.CSInactivityClientEvent

fireHandleCSNotificationEvent

public void fireHandleCSNotificationEvent(CSNotificationEvent event)
Supports listener events.

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

getAppSessionTimeout

public long getAppSessionTimeout()
Gets the appSessionTimeout

Returns:
long - Returns a long

getInactivityClientTimeout

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

Returns:
long - The current value of inactivityClientTimeout

getMinTimeStamp

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

Returns:
long - The current value of minTimeStamp

getServerStatus

public int getServerStatus()
Gets the CSServer status.

Returns:
int

getSynchronizedEvents

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

Returns:
java.util.Hashtable

getTimeBetweenSessionCheck

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

Returns:
long - The current value of timeBetweenSessionCheck

initiateServer

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

Throws:
DSECSServerNotStartedException
DSECSInvalidRequestException

isSessionAffinity

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

Returns:
boolean

isSessionPersistence

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

Returns:
boolean

removeCSInactivityClientListener

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

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

removeCSNotificationListener

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

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

sendEvent

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

Parameters:
ws - java.lang.String
anEvent - java.util.EventObject

sendEvent

public 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:
ws - java.lang.String
anEvent - java.util.EventObject
waitForDelivery - boolean
Throws:
DSECSSocketException

setAppSessionTimeout

public void setAppSessionTimeout(long appSessionTimeout)
Sets the appSessionTimeout

Parameters:
appSessionTimeout - long - The appSessionTimeout to set

setInactivityClientTimeout

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

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

setMinTimeStamp

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

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

setOutputTimeout

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

Parameters:
aOutputTimeout - long

setPersistTimeout

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

Parameters:
aPersistTimeout - long

setTimeBetweenSessionCheck

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

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

stopServer

public void stopServer()
                throws DSECSInvalidRequestException
Stops the server.

Throws:
DSECSInvalidRequestException

getPermanentConnectionForEvents

public boolean getPermanentConnectionForEvents()
Gets the permanentConnectionForEvents value.

Returns:
boolean

setPermanentConnectionForEvents

public void setPermanentConnectionForEvents(boolean permanent)
Sets the permanentConnectionForEvents value.

Parameters:
permanent - boolean

sendEvent

public 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 - java.util.EventObject
waitForDelivery - boolean
Throws:
DSECSSocketException - - Error sending the event to the listener

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005