|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CSClientService
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.btt.event.Notifier |
---|
getName, setName, signalEvent, signalEvent, terminate |
Field Detail |
---|
static final int RESET
static final int OK
static final int DOWN
static final int NOT_ESTABLISHED
static final java.lang.String CS_STATUS_CHANGED_EVENT
static final java.lang.String CS_SESSION_STATUS
static final java.lang.String CS_REPLY_EVENT
static final java.lang.String CS_REQUEST_ID
static final java.lang.String ENABLESSL
static final java.lang.String SSLENABLER
Method Detail |
---|
void addCSConnectionCookies(java.util.Vector clientCookiesVector)
clientCookiesVector
- java.util.Vectorvoid addCSConnectionCookies(java.lang.String clientCookieStr)
clientCookieStr
- java.lang.Stringvoid addCSNotificationListener(CSNotificationListener newListener)
newListener
- com.ibm.btt.clientserver.CSNotificationListenervoid addCSReplyListener(CSReplyListener newListener)
newListener
- com.ibm.btt.clientserver.CSReplyListenervoid addCSSessionStatusChangedListener(CSSessionStatusChangedListener newListener)
newListener
- com.ibm.btt.clientserver.CSSessionStatusChangedListenervoid closeSession() throws DSECSInvalidRequestException
DSECSInvalidRequestException
void establishSession() throws DSECSInvalidRequestException, DSECSSessionNotEstablishedException
DSECSInvalidRequestException
DSECSSessionNotEstablishedException
void establishSession(boolean newSession) throws DSECSInvalidRequestException, DSECSSessionNotEstablishedException
boolean
- newSession
DSECSInvalidRequestException
DSECSSessionNotEstablishedException
long getDefaultOperationTimeout()
boolean getKeepAliveConnection()
java.lang.String getProxyCredentials()
java.lang.String getProxyHost()
int getProxyPort()
int getReconnectionAttempts()
java.lang.String getServerCredentials()
java.lang.String getServerName()
java.lang.String getServerTID()
java.lang.String getSessionId()
int getSessionStatus()
long getTimeBetweenReconnectionAttempts()
boolean getUsedForSrvToClEventsNotif()
boolean getUseProxy()
void receive(ClientOperation aClientOperation, java.lang.Integer requestId) throws DSECSInvalidRequestException, DSECSTimeoutException, DSECSRemoteOperationException
aClientOperation
- ClientOperationrequesId
- java.lang.Integer
DSECSInvalidRequestException
DSECSTimeoutException
DSECSRemoteOperationException
void receive(ClientOperation aClientOperation, java.lang.Integer requestId, long timeout) throws DSECSInvalidRequestException, DSECSTimeoutException, DSECSRemoteOperationException
aClientOperation
- ClientOperationrequesId
- java.lang.Integertimeout
- long
DSECSInvalidRequestException
DSECSTimeoutException
DSECSRemoteOperationException
void receive(Context aContext, java.lang.Integer requestId) throws DSECSInvalidRequestException, DSECSTimeoutException, DSECSRemoteOperationException
aContext
- ContextrequesId
- java.lang.Integer
DSECSInvalidRequestException
DSECSTimeoutException
DSECSRemoteOperationException
void receive(Context aContext, java.lang.Integer requestId, long timeout) throws DSECSInvalidRequestException, DSECSTimeoutException, DSECSRemoteOperationException
aContext
- ContextrequesId
- java.lang.Integertimeout
- long
DSECSInvalidRequestException
DSECSTimeoutException
DSECSRemoteOperationException
void removeCSNotificationListener(CSNotificationListener newListener)
newListener
- com.ibm.btt.clientserver.CSNotificationListenervoid removeCSReplyListener(CSReplyListener newListener)
newListener
- com.ibm.btt.clientserver.CSReplyListenervoid removeCSSessionStatusChangedListener(CSSessionStatusChangedListener newListener)
newListener
- com.ibm.btt.clientserver.CSSessionStatusChangedListenerjava.lang.Integer send(ClientOperation aClientOperation) throws DSECSInvalidRequestException
aClientOperation
- ClientOperation
DSECSInvalidRequestException
void sendAndWait(ClientOperation aClientOperation) throws DSECSTimeoutException, DSECSInvalidRequestException, DSECSRemoteOperationException
aClientOperation
- ClientOperation
DSECSTimeoutException
DSECSInvalidRequestException
DSECSRemoteOperationException
void sendAndWait(ClientOperation aClientOperation, long timeout) throws DSECSTimeoutException, DSECSInvalidRequestException, DSECSRemoteOperationException
aClientOperation
- ClientOperationtimeout
- long
DSECSTimeoutException
DSECSInvalidRequestException
DSECSRemoteOperationException
void sendEvent(java.util.EventObject myEvent) throws DSECSInvalidRequestException
evt
- EventObject
DSECSInvalidRequestException
void setDefaultOperationTimeout(long aTimeout)
aTimeout
- longvoid setKeepAliveConnection(boolean value)
value
- booleanvoid setProxyCredentials(java.lang.String aProxyCredentials)
aProxyCredentials
- java.lang.Stringvoid setProxyHost(java.lang.String value)
value
- java.lang.Stringvoid setProxyPort(int value)
value
- intvoid setReconnectionAttempts(int value)
value
- intvoid setServerCredentials(java.lang.String aServerCredentials)
aServerCredentials
- java.lang.Stringvoid setServerName(java.lang.String serverName)
serverName
- java.lang.Stringvoid setTimeBetweenReconnectionAttempts(long value)
value
- longvoid setUsedForSrvToClEventNotif(boolean used)
used
- booleanvoid setUseProxy(boolean value)
used
- booleanint getEventsPort()
java.net.ServerSocket getServerSocket()
boolean getPermanentConnectionForEvents()
void setEventsPort(int aPort)
aPort
- intvoid setServerSocket(java.net.ServerSocket aSocket)
aSocket
- java.net.ServerSocketvoid setPermanentConnectionForEvents(boolean permanent)
boolean
- permanentboolean isEnableSSL()
void setEnableSSL(boolean enableSSL)
enableSSL
- - The enableSSL to setSSLEnabler getSSLEnabler()
void setSSLEnabler(SSLEnabler sslEnabler)
sslEnabler
- - The sslEnabler to set
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |