IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.services.comms
Interface CommonCommunicationsService

All Superinterfaces:
Notifier
All Known Subinterfaces:
MQConnectionService
All Known Implementing Classes:
MQConnection

public interface CommonCommunicationsService
extends Notifier

The CommonCommunicationsService interface is the common interface for communication services.


Field Summary
static java.lang.String CLOSED
           
static java.lang.String DATA
           
static java.lang.String DATASENT
           
static java.lang.String ERROR
           
static java.lang.String OPENED
           
static java.lang.String RECEIVERC
           
static java.lang.String TIMEOUT
           
 
Method Summary
 void ccClose()
          Closes the communications sevice.
 void ccOpen()
          Opens the communications chanel.
 CCMessage ccReceiveData(long aTimeout)
          Reads the data that has been received.
 void ccSendData(java.lang.String aString)
          Sends aData thought the communications channel.
 CCMessage ccSendReceive(java.lang.String aString, long aTimeout)
          Sends aString to the communication services and waits for aTimeout to receive the data.
 java.lang.String getCcClosedEventName()
          Returns the name of the closed event.
 java.lang.String getCcDataReceivedEventName()
          Returns the name of the dataReceived event.
 java.lang.String getCcErrorReceivedEventName()
          Returns the name of the errorReceived event.
 java.lang.String getCcOpenedEventName()
          Returns the name of the opened event.
 boolean isFree()
          Returns true if the communication service is ready to be used.
 boolean isOffline()
          Returns true if the communication service is offline.
 void setInUse(boolean inUse)
          Sets service inUse attribute.
 
Methods inherited from interface com.ibm.btt.base.Notifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, terminate
 

Field Detail

RECEIVERC

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

TIMEOUT

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

DATASENT

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

OPENED

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

CLOSED

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

DATA

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

ERROR

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

ccClose

void ccClose()
             throws DSECCException
Closes the communications sevice. It returns control immediately. When the communications channel is started correctly, the event ChanelClosed is signaled.

Throws:
DSECCException

ccOpen

void ccOpen()
            throws DSECCException
Opens the communications chanel. It returns control inmediately. When the communications channel is started correctly, the event ChanelOpened is signaled.

Throws:
DSECCException

ccReceiveData

CCMessage ccReceiveData(long aTimeout)
                        throws DSECCException
Reads the data that has been received. If the data is not ready, it waits only for the timeout.

Parameters:
aTimeout - long
Throws:
DSECCException

ccSendData

void ccSendData(java.lang.String aString)
                throws DSECCException
Sends aData thought the communications channel. It returns control immediately. When a response is received, two events might be signaled: DataReceived event (in case of data received) or ErrorReceived (in case of error).

Parameters:
aString - java.lang.String
Throws:
DSECCException

ccSendReceive

CCMessage ccSendReceive(java.lang.String aString,
                        long aTimeout)
                        throws DSECCException
Sends aString to the communication services and waits for aTimeout to receive the data.

Parameters:
aString - java.lang.String
aTimeout - long
Throws:
DSECCException

getCcClosedEventName

java.lang.String getCcClosedEventName()
Returns the name of the closed event.


getCcDataReceivedEventName

java.lang.String getCcDataReceivedEventName()
Returns the name of the dataReceived event.


getCcErrorReceivedEventName

java.lang.String getCcErrorReceivedEventName()
Returns the name of the errorReceived event.


getCcOpenedEventName

java.lang.String getCcOpenedEventName()
Returns the name of the opened event.


isFree

boolean isFree()
Returns true if the communication service is ready to be used.


isOffline

boolean isOffline()
Returns true if the communication service is offline.


setInUse

void setInUse(boolean inUse)
Sets service inUse attribute.

Parameters:
inUse - boolean

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011