com.ibm.dse.clientserver
Interface CSServerService

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.
 long getInactivityClientTimeout()
          Returns the value of the inactivityClientTimeout property.
 int getServerStatus()
          Gets the CSServer status.
 long getTimeBetweenSessionCheck()
          Returns the value of the timeBetweenSessionCheck property.
 void initiateServer()
          Initiates the server.
 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 setInactivityClientTimeout(long value)
          Sets the value of the inactivityClientTimeout property.
 void setTimeBetweenSessionCheck(long value)
          Sets the value of the timeBetweenSessionCheck property.
 void stopServer()
          Stops the server.
 
Methods inherited from interface com.ibm.dse.base.Notifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, terminate
 

Field Detail

CS_INACTIVITY_CLIENT_EVENT

public static final java.lang.String CS_INACTIVITY_CLIENT_EVENT

CS_SESSION_EXPIRED

public static final java.lang.String CS_SESSION_EXPIRED
Method Detail

addCSInactivityClientListener

public void addCSInactivityClientListener(CSInactivityClientListener newListener)
Adds the specified CSInactivityClientListener to recieve CSInactivityClientEvents from this interface.
Parameters:
newListener - com.ibm.dse.clientserver.CSInactivityClientListener

addCSNotificationListener

public void addCSNotificationListener(CSNotificationListener newListener)
Adds the specified CSNotificationListener to recieve CSNotificationEvents from this interface.
Parameters:
newListener - com.ibm.dse.clientserver.CSNotificationListener

getInactivityClientTimeout

public long getInactivityClientTimeout()
Returns the value of the inactivityClientTimeout property.
Returns:
long - The current value of inactivityClientTimeout.

getServerStatus

public int getServerStatus()
Gets the CSServer status.
Returns:
int

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.

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.dse.clientserver.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:
wk - java.lang.String
anEvent - Event

setInactivityClientTimeout

public void setInactivityClientTimeout(long value)
Sets the value of the inactivityClientTimeout property.
Parameters:
value - long The new value of the property.

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.