|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The CSClientService interface provides the C/S service interface on the client side.
Field Summary | |
---|---|
static java.lang.String |
CS_REPLY_EVENT
|
static java.lang.String |
CS_REQUEST_ID
|
static java.lang.String |
CS_SESSION_STATUS
|
static java.lang.String |
CS_STATUS_CHANGED_EVENT
|
static int |
DOWN
|
static java.lang.String |
ENABLESSL
|
static int |
NOT_ESTABLISHED
|
static int |
OK
|
static int |
RESET
|
static java.lang.String |
SSLENABLER
|
Method Summary | |
---|---|
void |
addCSConnectionCookies(java.lang.String clientCookieStr)
Adds a client cookie for the connection. |
void |
addCSConnectionCookies(java.util.Vector clientCookiesVector)
Adds client cookies for the connection. |
void |
addCSNotificationListener(CSNotificationListener newListener)
Registers the notification of events. |
void |
addCSReplyListener(CSReplyListener newListener)
Registers the notification of a request reply |
void |
addCSSessionStatusChangedListener(CSSessionStatusChangedListener newListener)
Registers the notification of client/server status changes |
void |
closeSession()
Closes the session. |
void |
establishSession()
Establishes a session with the server. |
void |
establishSession(boolean newSession)
Establishes a session with the server Should the request attempt to create a session or use an existing session |
long |
getDefaultOperationTimeout()
Returns the timeout used in the methods sendAndWait(ClientOperation), receive(ClientOperation, Integer), receive (Context, Integer). |
int |
getEventsPort()
Gets the events port. |
boolean |
getKeepAliveConnection()
Returns false if the connection with the server is used only for one request. |
boolean |
getPermanentConnectionForEvents()
Gets the permanentConnectionForEvents attribute |
java.lang.String |
getProxyCredentials()
Returns the authentification proxy info. |
java.lang.String |
getProxyHost()
Returns the name of the proxy address (HTTP address). |
int |
getProxyPort()
Gets the proxy port. |
int |
getReconnectionAttempts()
Returns the number of attempts to reestablish the connection. |
java.lang.String |
getServerCredentials()
Returns the authentification server info. |
java.lang.String |
getServerName()
Returns the name of the server address (HTTP address). |
java.net.ServerSocket |
getServerSocket()
Gets the server socket. |
java.lang.String |
getServerTID()
Gets the server terminal ID. |
java.lang.String |
getSessionId()
Gets the session ID assigned by the server. |
int |
getSessionStatus()
Gets the session status. |
SSLEnabler |
getSSLEnabler()
Returns the sslEnabler. |
long |
getTimeBetweenReconnectionAttempts()
Gets the time between reconnection attempts when the session is down. |
boolean |
getUsedForSrvToClEventsNotif()
Gets true if the CSClient is used on the server for client event notification. |
boolean |
getUseProxy()
Returns true if the CSClientService establish a connection through a proxy. |
boolean |
isEnableSSL()
Returns the enableSSL. |
void |
receive(ClientOperation aClientOperation,
java.lang.Integer requestId)
Used together with the asynchronous send(...) method. |
void |
receive(ClientOperation aClientOperation,
java.lang.Integer requestId,
long timeout)
Used together with the asynchronous send(...) method. |
void |
receive(Context aContext,
java.lang.Integer requestId)
Used together with the asynchronous send(...) method. |
void |
receive(Context aContext,
java.lang.Integer requestId,
long timeout)
Used together with the asynchronous send(...) method. |
void |
removeCSNotificationListener(CSNotificationListener newListener)
Removes the specified CSNotificationListener so that it no longer receives CSNotificationEvents from this interfice. |
void |
removeCSReplyListener(CSReplyListener newListener)
Removes the specified CSReplyListener so that it no longer receives CSReplyEvents from this interfice. |
void |
removeCSSessionStatusChangedListener(CSSessionStatusChangedListener newListener)
Removes the specified CSSessionStatusChangedListener so that it no longer receives CSSessionStatusChangedEvents from this interfice. |
java.lang.Integer |
send(ClientOperation aClientOperation)
Instantiates the remote execution of the operation on the server side. |
void |
sendAndWait(ClientOperation aClientOperation)
Initiates the remote execution of the operation on the server side and waits. |
void |
sendAndWait(ClientOperation aClientOperation,
long timeout)
Initiates the remote execution of the operation on the server side and waits for a timeout. |
void |
sendEvent(java.util.EventObject myEvent)
Sends an event to the server. |
void |
setDefaultOperationTimeout(long aTimeout)
Sets the defaultOperationTimeout property (long) value. |
void |
setEnableSSL(boolean enableSSL)
Sets the enableSSL. |
void |
setEventsPort(int aPort)
Sets the events port. |
void |
setKeepAliveConnection(boolean value)
Sets the option to use the connection with the server for more than one request. |
void |
setPermanentConnectionForEvents(boolean permanent)
Sets the permanentConnectionForEvents attribute. |
void |
setProxyCredentials(java.lang.String aProxyCredentials)
Sets the authentification proxy info. |
void |
setProxyHost(java.lang.String value)
Sets set the name of the proxy address (HTTP address) |
void |
setProxyPort(int value)
Sets the proxy port. |
void |
setReconnectionAttempts(int value)
Sets the number of attempts to reestablish the connection. |
void |
setServerCredentials(java.lang.String aServerCredentials)
Sets the authentification server info. |
void |
setServerName(java.lang.String serverName)
Sets the name of the server address (HTTP address). |
void |
setServerSocket(java.net.ServerSocket aSocket)
Sets the server socket. |
void |
setSSLEnabler(SSLEnabler sslEnabler)
Sets the sslEnabler. |
void |
setTimeBetweenReconnectionAttempts(long value)
Sets the time between reconnection attempts when the session is down. |
void |
setUsedForSrvToClEventNotif(boolean used)
|
void |
setUseProxy(boolean value)
Sets the option to establish a connection with the server through a proxy. |
Methods inherited from interface com.ibm.dse.base.Notifier |
---|
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, terminate |
Field Detail |
public static final int RESET
public static final int OK
public static final int DOWN
public static final int NOT_ESTABLISHED
public static final java.lang.String CS_STATUS_CHANGED_EVENT
public static final java.lang.String CS_SESSION_STATUS
public static final java.lang.String CS_REPLY_EVENT
public static final java.lang.String CS_REQUEST_ID
public static final java.lang.String ENABLESSL
public static final java.lang.String SSLENABLER
Method Detail |
public void addCSConnectionCookies(java.util.Vector clientCookiesVector)
clientCookiesVector
- java.util.Vectorpublic void addCSConnectionCookies(java.lang.String clientCookieStr)
clientCookieStr
- java.lang.Stringpublic void addCSNotificationListener(CSNotificationListener newListener)
newListener
- com.ibm.dse.clientserver.CSNotificationListenerpublic void addCSReplyListener(CSReplyListener newListener)
newListener
- com.ibm.dse.clientserver.CSReplyListenerpublic void addCSSessionStatusChangedListener(CSSessionStatusChangedListener newListener)
newListener
- com.ibm.dse.clientserver.CSSessionStatusChangedListenerpublic void closeSession() throws DSECSInvalidRequestException
DSECSInvalidRequestException
public void establishSession() throws DSECSInvalidRequestException, DSECSSessionNotEstablishedException
DSECSInvalidRequestException
DSECSSessionNotEstablishedException
public void establishSession(boolean newSession) throws DSECSInvalidRequestException, DSECSSessionNotEstablishedException
DSECSInvalidRequestException
DSECSSessionNotEstablishedException
public long getDefaultOperationTimeout()
public boolean getKeepAliveConnection()
public java.lang.String getProxyCredentials()
public java.lang.String getProxyHost()
public int getProxyPort()
public int getReconnectionAttempts()
public java.lang.String getServerCredentials()
public java.lang.String getServerName()
public java.lang.String getServerTID()
public java.lang.String getSessionId()
public int getSessionStatus()
public long getTimeBetweenReconnectionAttempts()
public boolean getUsedForSrvToClEventsNotif()
public boolean getUseProxy()
public void receive(ClientOperation aClientOperation, java.lang.Integer requestId) throws DSECSInvalidRequestException, DSECSTimeoutException, DSECSRemoteOperationException
aClientOperation
- ClientOperation
DSECSInvalidRequestException
DSECSTimeoutException
DSECSRemoteOperationException
public void receive(ClientOperation aClientOperation, java.lang.Integer requestId, long timeout) throws DSECSInvalidRequestException, DSECSTimeoutException, DSECSRemoteOperationException
aClientOperation
- ClientOperationtimeout
- long
DSECSInvalidRequestException
DSECSTimeoutException
DSECSRemoteOperationException
public void receive(Context aContext, java.lang.Integer requestId) throws DSECSInvalidRequestException, DSECSTimeoutException, DSECSRemoteOperationException
aContext
- Context
DSECSInvalidRequestException
DSECSTimeoutException
DSECSRemoteOperationException
public void receive(Context aContext, java.lang.Integer requestId, long timeout) throws DSECSInvalidRequestException, DSECSTimeoutException, DSECSRemoteOperationException
aContext
- Contexttimeout
- long
DSECSInvalidRequestException
DSECSTimeoutException
DSECSRemoteOperationException
public void removeCSNotificationListener(CSNotificationListener newListener)
newListener
- com.ibm.dse.clientserver.CSNotificationListenerpublic void removeCSReplyListener(CSReplyListener newListener)
newListener
- com.ibm.dse.clientserver.CSReplyListenerpublic void removeCSSessionStatusChangedListener(CSSessionStatusChangedListener newListener)
newListener
- com.ibm.dse.clientserver.CSSessionStatusChangedListenerpublic java.lang.Integer send(ClientOperation aClientOperation) throws DSECSInvalidRequestException
aClientOperation
- ClientOperation
DSECSInvalidRequestException
public void sendAndWait(ClientOperation aClientOperation) throws DSECSTimeoutException, DSECSInvalidRequestException, DSECSRemoteOperationException
aClientOperation
- ClientOperation
DSECSTimeoutException
DSECSInvalidRequestException
DSECSRemoteOperationException
public void sendAndWait(ClientOperation aClientOperation, long timeout) throws DSECSTimeoutException, DSECSInvalidRequestException, DSECSRemoteOperationException
aClientOperation
- ClientOperationtimeout
- long
DSECSTimeoutException
DSECSInvalidRequestException
DSECSRemoteOperationException
public void sendEvent(java.util.EventObject myEvent) throws DSECSInvalidRequestException
DSECSInvalidRequestException
public void setDefaultOperationTimeout(long aTimeout)
aTimeout
- longpublic void setKeepAliveConnection(boolean value)
value
- booleanpublic void setProxyCredentials(java.lang.String aProxyCredentials)
aProxyCredentials
- java.lang.Stringpublic void setProxyHost(java.lang.String value)
value
- java.lang.Stringpublic void setProxyPort(int value)
value
- intpublic void setReconnectionAttempts(int value)
value
- intpublic void setServerCredentials(java.lang.String aServerCredentials)
aServerCredentials
- java.lang.Stringpublic void setServerName(java.lang.String serverName)
serverName
- java.lang.Stringpublic void setTimeBetweenReconnectionAttempts(long value)
value
- longpublic void setUsedForSrvToClEventNotif(boolean used)
used
- booleanpublic void setUseProxy(boolean value)
public int getEventsPort()
public java.net.ServerSocket getServerSocket()
public boolean getPermanentConnectionForEvents()
public void setEventsPort(int aPort)
aPort
- intpublic void setServerSocket(java.net.ServerSocket aSocket)
aSocket
- java.net.ServerSocketpublic void setPermanentConnectionForEvents(boolean permanent)
public boolean isEnableSSL()
public void setEnableSSL(boolean enableSSL)
enableSSL
- - The enableSSL to setpublic SSLEnabler getSSLEnabler()
public void setSSLEnabler(SSLEnabler sslEnabler)
sslEnabler
- - The sslEnabler to set
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |