com.ibm.dse.services.mq
Interface MQConnectionService

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.dse.services.comms.CommonCommunicationsService
CLOSED, DATA, DATASENT, ERROR, OPENED, RECEIVERC, TIMEOUT
 
Method Summary
 void addQueueListener(QueueListener newListener)
          Adds a listener to Queue
 void closeConnection()
          Disconnects from queue manager, and removes the used queues.
 void establishConnection()
          Establishes a connection with a MQManager.
 void fireMessageReceived(QueueEvent event)
          Supports 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 value.
 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 queue listener.
 byte[] send(java.lang.Object inputMessage)
          Performs the send method.
 byte[] send(java.lang.String inputMessage)
          Performs the send method.
 void terminate()
          Terminates the conversation.
 
Methods inherited from interface com.ibm.dse.services.comms.CommonCommunicationsService
ccClose, ccOpen, ccReceiveData, ccSendData, ccSendReceive, getCcClosedEventName, getCcDataReceivedEventName, getCcErrorReceivedEventName, getCcOpenedEventName, isFree, isOffline, setInUse
 
Methods inherited from interface com.ibm.dse.base.Notifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent
 

Field Detail

MQCHS_INACTIVE

public static final int MQCHS_INACTIVE

MQCHS_BINDING

public static final int MQCHS_BINDING

MQCHS_STARTING

public static final int MQCHS_STARTING

MQCHS_RUNNING

public static final int MQCHS_RUNNING

MQCHS_STOPPING

public static final int MQCHS_STOPPING

MQCHS_RETRYING

public static final int MQCHS_RETRYING

MQCHS_STOPPED

public static final int MQCHS_STOPPED

MQCHS_REQUESTING

public static final int MQCHS_REQUESTING

MQCHS_PAUSED

public static final int MQCHS_PAUSED

MQCHS_INITIALIZING

public static final int MQCHS_INITIALIZING

NORC

public static final java.lang.String NORC

CODEPAGE

public static final java.lang.String CODEPAGE

MQCFST_STRUC_LENGTH_FIXED

public static final int MQCFST_STRUC_LENGTH_FIXED

MQCFIN_STRUC_LENGTH

public static final int MQCFIN_STRUC_LENGTH

MQ_CHANNEL_NAME_LENGTH

public static final int MQ_CHANNEL_NAME_LENGTH

MQCFT_COMMAND

public static final int MQCFT_COMMAND

MQCFH_STRUC_LENGTH

public static final int MQCFH_STRUC_LENGTH

MQCFH_VERSION_1

public static final int MQCFH_VERSION_1

MQCMD_RESET_CHANNEL

public static final int MQCMD_RESET_CHANNEL

MQCMD_START_CHANNEL

public static final int MQCMD_START_CHANNEL

MQCMD_STOP_CHANNEL

public static final int MQCMD_STOP_CHANNEL

MQCMD_INQUIRE_CHANNEL_STATUS

public static final int MQCMD_INQUIRE_CHANNEL_STATUS

MQCFC_LAST

public static final int MQCFC_LAST

MQCC_OK

public static final int MQCC_OK

MQRC_NONE

public static final int MQRC_NONE

MQCFT_STRING

public static final int MQCFT_STRING

MQCFT_INTEGER

public static final int MQCFT_INTEGER

MQCACH_CHANNEL_NAME

public static final int MQCACH_CHANNEL_NAME

MQCCSI_DEFAULT

public static final int MQCCSI_DEFAULT

MQIACH_CHANNEL_STATUS

public static final int MQIACH_CHANNEL_STATUS

MQIACH_MSG_SEQUENCE_NUMBER

public static final int MQIACH_MSG_SEQUENCE_NUMBER

MQRCCF_CHANNEL_IN_USE

public static final int MQRCCF_CHANNEL_IN_USE

DSEUSER

public static final java.lang.String DSEUSER
Method Detail

addQueueListener

public void addQueueListener(QueueListener newListener)
Adds a listener to Queue
Parameters:
newListener - com.ibm.dse.services.mq.QueueListener

closeConnection

public void closeConnection()
                     throws java.lang.Exception

Disconnects from queue manager, and removes the used queues.


establishConnection

public void establishConnection()
                         throws java.lang.Exception

Establishes a connection with a MQManager.


fireMessageReceived

public void fireMessageReceived(QueueEvent event)
Supports listener events.
Parameters:
event - com.ibm.dse.services.mq.QueueEvent

getAutomaticConnectionEstablishment

public boolean getAutomaticConnectionEstablishment()
Gets the AutomaticConnectionEstablishment property (boolean) value.
Returns:
The AutomaticConnectionEstablishment property value.

getDeadLetterQName

public java.lang.String getDeadLetterQName()
Gets the deadLetterQName property (String) value.
Returns:
The dead letter queue name.

getStatus

public java.lang.String getStatus()

Gets the communication status value. Possible values are:

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

receive

public 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

receive

public 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

removeQueueListener

public void removeQueueListener(QueueListener newListener)
Removes queue listener.
Parameters:
newListener - com.ibm.dse.services.mq.QueueListener

send

public byte[] send(java.lang.Object inputMessage)
            throws java.lang.Exception
Performs the send method.
Parameters:
aString(java.lang.Object). - The message to send.

send

public byte[] send(java.lang.String inputMessage)
            throws java.lang.Exception
Performs the send method.
Parameters:
aString - java.lang.String.The message to be sent.

terminate

public void terminate()

Terminates the conversation. This method terminates the internal thread and closes conversation ABNORMALY, if required (if in a RECEIVE state).