IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.services.mq
Interface MQConnectionService

All Superinterfaces:
CommonCommunicationsService, Notifier
All Known Implementing Classes:
MQConnection

public interface MQConnectionService
extends CommonCommunicationsService

The MQConnectionService interface provides MQConnection services.


Field Summary
static java.lang.String CODEPAGE
           
static java.lang.String DSEUSER
           
static int MQ_CHANNEL_NAME_LENGTH
           
static int MQCACH_CHANNEL_NAME
           
static int MQCC_OK
           
static int MQCCSI_DEFAULT
           
static int MQCFC_LAST
           
static int MQCFH_STRUC_LENGTH
           
static int MQCFH_VERSION_1
           
static int MQCFIN_STRUC_LENGTH
           
static int MQCFST_STRUC_LENGTH_FIXED
           
static int MQCFT_COMMAND
           
static int MQCFT_INTEGER
           
static int MQCFT_STRING
           
static int MQCHS_BINDING
           
static int MQCHS_INACTIVE
           
static int MQCHS_INITIALIZING
           
static int MQCHS_PAUSED
           
static int MQCHS_REQUESTING
           
static int MQCHS_RETRYING
           
static int MQCHS_RUNNING
           
static int MQCHS_STARTING
           
static int MQCHS_STOPPED
           
static int MQCHS_STOPPING
           
static int MQCMD_INQUIRE_CHANNEL_STATUS
           
static int MQCMD_RESET_CHANNEL
           
static int MQCMD_START_CHANNEL
           
static int MQCMD_STOP_CHANNEL
           
static int MQIACH_CHANNEL_STATUS
           
static int MQIACH_MSG_SEQUENCE_NUMBER
           
static int MQRC_NONE
           
static int MQRCCF_CHANNEL_IN_USE
           
static java.lang.String NORC
           
 
Fields inherited from interface com.ibm.btt.services.comms.CommonCommunicationsService
CLOSED, DATA, DATASENT, ERROR, OPENED, RECEIVERC, TIMEOUT
 
Method Summary
 void addQueueListener(QueueListener newListener)
          Adds a listener to the queue.
 void closeConnection()
          Disconnects the service from the MQManager and removes the used queues.
 void establishConnection()
          Establishes a connection with an MQManager.
 void fireMessageReceived(QueueEvent event)
          Provides support for listener events.
 boolean getAutomaticConnectionEstablishment()
          Gets the AutomaticConnectionEstablishment property (boolean) value.
 java.lang.String getDeadLetterQName()
          Gets the deadLetterQName property (String) value.
 java.lang.String getStatus()
          Gets the communication status.
 java.lang.Object receive(byte[] aCorrelationId)
          Performs the receive method.
 java.lang.Object receive(byte[] aCorrelationId, long aTimeout)
          Performs the receive method.
 void removeQueueListener(QueueListener newListener)
          Removes the queue listener.
 byte[] send(java.lang.Object inputMessage)
          Sends a message to the queue.
 byte[] send(java.lang.String inputMessage)
          Sends a message to the queue.
 void terminate()
          Terminates the conversation.
 
Methods inherited from interface com.ibm.btt.services.comms.CommonCommunicationsService
ccClose, ccOpen, ccReceiveData, ccSendData, ccSendReceive, getCcClosedEventName, getCcDataReceivedEventName, getCcErrorReceivedEventName, getCcOpenedEventName, isFree, isOffline, setInUse
 
Methods inherited from interface com.ibm.btt.base.Notifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent
 

Field Detail

MQCHS_INACTIVE

static final int MQCHS_INACTIVE
See Also:
Constant Field Values

MQCHS_BINDING

static final int MQCHS_BINDING
See Also:
Constant Field Values

MQCHS_STARTING

static final int MQCHS_STARTING
See Also:
Constant Field Values

MQCHS_RUNNING

static final int MQCHS_RUNNING
See Also:
Constant Field Values

MQCHS_STOPPING

static final int MQCHS_STOPPING
See Also:
Constant Field Values

MQCHS_RETRYING

static final int MQCHS_RETRYING
See Also:
Constant Field Values

MQCHS_STOPPED

static final int MQCHS_STOPPED
See Also:
Constant Field Values

MQCHS_REQUESTING

static final int MQCHS_REQUESTING
See Also:
Constant Field Values

MQCHS_PAUSED

static final int MQCHS_PAUSED
See Also:
Constant Field Values

MQCHS_INITIALIZING

static final int MQCHS_INITIALIZING
See Also:
Constant Field Values

NORC

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

CODEPAGE

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

MQCFST_STRUC_LENGTH_FIXED

static final int MQCFST_STRUC_LENGTH_FIXED
See Also:
Constant Field Values

MQCFIN_STRUC_LENGTH

static final int MQCFIN_STRUC_LENGTH
See Also:
Constant Field Values

MQ_CHANNEL_NAME_LENGTH

static final int MQ_CHANNEL_NAME_LENGTH
See Also:
Constant Field Values

MQCFT_COMMAND

static final int MQCFT_COMMAND
See Also:
Constant Field Values

MQCFH_STRUC_LENGTH

static final int MQCFH_STRUC_LENGTH
See Also:
Constant Field Values

MQCFH_VERSION_1

static final int MQCFH_VERSION_1
See Also:
Constant Field Values

MQCMD_RESET_CHANNEL

static final int MQCMD_RESET_CHANNEL
See Also:
Constant Field Values

MQCMD_START_CHANNEL

static final int MQCMD_START_CHANNEL
See Also:
Constant Field Values

MQCMD_STOP_CHANNEL

static final int MQCMD_STOP_CHANNEL
See Also:
Constant Field Values

MQCMD_INQUIRE_CHANNEL_STATUS

static final int MQCMD_INQUIRE_CHANNEL_STATUS
See Also:
Constant Field Values

MQCFC_LAST

static final int MQCFC_LAST
See Also:
Constant Field Values

MQCC_OK

static final int MQCC_OK
See Also:
Constant Field Values

MQRC_NONE

static final int MQRC_NONE
See Also:
Constant Field Values

MQCFT_STRING

static final int MQCFT_STRING
See Also:
Constant Field Values

MQCFT_INTEGER

static final int MQCFT_INTEGER
See Also:
Constant Field Values

MQCACH_CHANNEL_NAME

static final int MQCACH_CHANNEL_NAME
See Also:
Constant Field Values

MQCCSI_DEFAULT

static final int MQCCSI_DEFAULT
See Also:
Constant Field Values

MQIACH_CHANNEL_STATUS

static final int MQIACH_CHANNEL_STATUS
See Also:
Constant Field Values

MQIACH_MSG_SEQUENCE_NUMBER

static final int MQIACH_MSG_SEQUENCE_NUMBER
See Also:
Constant Field Values

MQRCCF_CHANNEL_IN_USE

static final int MQRCCF_CHANNEL_IN_USE
See Also:
Constant Field Values

DSEUSER

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

addQueueListener

void addQueueListener(QueueListener newListener)
Adds a listener to the queue.

Parameters:
newListener - com.ibm.btt.services.mq.QueueListener

closeConnection

void closeConnection()
                     throws java.lang.Exception
Disconnects the service from the MQManager and removes the used queues.

Throws:
java.lang.Exception

establishConnection

void establishConnection()
                         throws java.lang.Exception
Establishes a connection with an MQManager.

Throws:
java.lang.Exception

fireMessageReceived

void fireMessageReceived(QueueEvent event)
Provides support for listener events.

Parameters:
event - com.ibm.btt.services.mq.QueueEvent

getAutomaticConnectionEstablishment

boolean getAutomaticConnectionEstablishment()
Gets the AutomaticConnectionEstablishment property (boolean) value.

Returns:
The AutomaticConnectionEstablishment property value

getDeadLetterQName

java.lang.String getDeadLetterQName()
Gets the deadLetterQName property (String) value.

Returns:
- The dead letter queue name

getStatus

java.lang.String getStatus()
Gets the communication status. Possible return values are:

Returns:
- The sessionStatus property value.
See Also:
#setSessionStatus

receive

java.lang.Object receive(byte[] aCorrelationId)
                         throws java.lang.Exception
Performs the receive method.

Parameters:
correlationId - The message correlation identifier to get the correct message
Returns:
java.lang.String
Throws:
java.lang.Exception

receive

java.lang.Object receive(byte[] aCorrelationId,
                         long aTimeout)
                         throws java.lang.Exception
Performs the receive method.

Parameters:
correlationId - The message correlation identifier to get the correct message
timeout -
Returns:
java.lang.String
Throws:
java.lang.Exception

removeQueueListener

void removeQueueListener(QueueListener newListener)
Removes the queue listener.

Parameters:
newListener - com.ibm.btt.services.mq.QueueListener

send

byte[] send(java.lang.Object inputMessage)
            throws java.lang.Exception
Sends a message to the queue.

Parameters:
aString - The message to be sent
Throws:
java.lang.Exception

send

byte[] send(java.lang.String inputMessage)
            throws java.lang.Exception
Sends a message to the queue.

Parameters:
aString - java.lang.String - The message to be sent
Throws:
java.lang.Exception

terminate

void terminate()
Terminates the conversation. This method terminates the internal thread and closes the conversation ABNORMALY if it is in a RECEIVE state.

Specified by:
terminate in interface Notifier

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011