Websphere MQ Everyplace

com.ibm.mqe
Class MQeChannelListener

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--com.ibm.mqe.MQeChannelListener
All Implemented Interfaces:
MQeExceptionCodes, MQePropertyProvider, java.lang.Runnable

Deprecated. (from V2.0) This class is now deprecated. It formed part of the cluster of classes used to provide 'Server' (ie listener) capability for queue managers. This functionality is now provided by other classes which can be controlled (indirectly) through the MQeCommunicationsListenerAdminMsg, you can use this class to add, delete, start and stop a communications listener. See java doc of this class for more info.

This class is used to create a listener for incoming WebSphere MQ Everyplace logical channels.

This class is a descendant of MQe.

public class MQeChannelListener
extends MQe
implements java.lang.Runnable, MQePropertyProvider


Field Summary
 
Fields inherited from class com.ibm.mqe.MQe
Admin_Queue_Name, Admin_Reply_Queue_Name, copyright, DeadLetter_Queue_Name, Event_Activate, Event_Attribute, Event_Authenticate, Event_Close, Event_Logoff, Event_Logon, Event_MiniCert_Validate, Event_Queue, Event_QueueManager, Event_UserBase, JMS_Version, MQ_Headers, MQe_Log_Audit_Failure, MQe_Log_Audit_Success, MQe_Log_Error, MQe_Log_Information, MQe_Log_Success, MQe_Log_Warning, Msg_BackoutCount, Msg_CorrelID, Msg_ExpireTime, Msg_LockID, Msg_MsgID, Msg_OriginQMgr, Msg_Priority, Msg_ReplyToQ, Msg_ReplyToQMgr, Msg_Resend, Msg_Style, Msg_Style_Datagram, Msg_Style_Reply, Msg_Style_Request, Msg_Time, Msg_WrapMsg, sccsid, System_Default_Queue_Name, version
 
Fields inherited from interface com.ibm.mqe.MQePropertyProvider
version
 
Fields inherited from interface com.ibm.mqe.MQeExceptionCodes
Except_Active, Except_AdapterException, Except_AdapterMissingRemoteAddress, Except_Admin_ActionNotSupported, Except_Admin_InvalidField, Except_Admin_NotAdminMsg, Except_AdminAction, Except_Authenticate, Except_BadRequest, Except_BridgeListener, Except_Chnl_Attributes, Except_Chnl_ID, Except_Chnl_Limit, Except_Chnl_Overrun, Except_Closed, Except_Con_AdapterRequired, Except_Con_AliasAlreadyExists, Except_Con_AlreadyExists, Except_Con_InvalidName, Except_Connect_Failure, Except_ConnectonType, Except_Cryptor, Except_Data, Except_Duplicate, Except_JmxProperties, Except_Listener, Except_MessageStore, Except_MiniCertReg_ActivateFailed, Except_MiniCertReg_BadPIN, Except_MiniCertReg_NotOpen, Except_NotActive, Except_NotAllowed, Except_NotFound, Except_NotSupported, Except_PrivateReg_ActivateFailed, Except_PrivateReg_BadPIN, Except_PrivateReg_NotOpen, Except_PublicReg_ActivateFailed, Except_PublicReg_InvalidAddress, Except_PublicReg_InvalidRequest, Except_Q_Full, Except_Q_InvalidName, Except_Q_InvalidPriority, Except_Q_MsgTooLarge, Except_Q_NoMatchingMsg, Except_Q_TargetRegistryRequired, Except_QMgr_Activated, Except_QMgr_AlreadyExists, Except_QMgr_InvalidQMgrName, Except_QMgr_InvalidQName, Except_QMgr_NotActive, Except_QMgr_NotBridgeEnabled, Except_QMgr_NotConfigured, Except_QMgr_QDoesNotExist, Except_QMgr_QExists, Except_QMgr_QNotEmpty, Except_QMgr_RegistryDataVersion, Except_QMgr_UnknownQMgr, Except_QMgr_WrongQType, Except_Reg_AddFailed, Except_Reg_AlreadyExists, Except_Reg_AlreadyOpen, Except_Reg_CRTKeyDecFailed, Except_Reg_CRTKeySignFailed, Except_Reg_DeleteFailed, Except_Reg_DeleteRegistryFailed, Except_Reg_DoesNotExist, Except_Reg_InvalidSession, Except_Reg_ListFailed, Except_Reg_NotDefined, Except_Reg_NotSecure, Except_Reg_NullName, Except_Reg_OpenFailed, Except_Reg_ReadFailed, Except_Reg_RenameFailed, Except_Reg_ResetPINFailed, Except_Reg_SearchFailed, Except_Reg_UpdateFailed, Except_RemoteException, Except_Rule, Except_S_BadIntegrity, Except_S_BadSubject, Except_S_CertificateExpired, Except_S_Cipher, Except_S_InvalidAttribute, Except_S_InvalidSignature, Except_S_MiniCertNotAvailable, Except_S_MissingSection, Except_S_NoPresetKeyAvailable, Except_S_RegistryNotAvailable, Except_Stopped, Except_Syntax, Except_TimeOut, Except_Transporter, Except_TriggerTransmission, Except_Trnsport_QMgr, Except_Trnsport_Request, Except_Type, Except_UdpipAdapterStateException, Except_UdpipAdapterTimeOut, Except_UdpipAdapterUnableToConfirmSuccess, Except_UnCoded, Except_Uncontactable_DontTransmit
 
Constructor Summary
MQeChannelListener()
          Deprecated. Constructs an MQeChannelListener object.
MQeChannelListener(java.lang.Object listener, java.lang.String fileType, java.lang.Object processor)
          Deprecated. Constructs an MQeChannelListener object taking the following parameters.
 
Method Summary
 void activate(java.lang.Object listener, java.lang.String fileType, java.lang.Object processor)
          Deprecated. Activates the channel listener if it was not activated by the class constructor.
 java.lang.String getProperty(java.lang.String key)
          Deprecated.  Implementors of the MQePropertyProvider interface must provide the getProperty method which will return a String containing the given value for the key provided.
 void setTimer(int interval)
          Deprecated. Called to set up a time-out interval for any channels accepted by this channel listener.
 void stop()
          Deprecated. Called to stop the channel listener accepting any new inbound requests.
 
Methods inherited from class com.ibm.mqe.MQe
abbreviate, alias, asciiToByte, byteToAscii, byteToHex, byteToHex, byteToInt, byteToLong, byteToShort, byteToUnicode, fileSeparator, getEventLogHandler, hexToAscii, hexToByte, intToByte, isCLDC, loadClass, loadObject, log, setEventLogHandler, setLoader, sliceByteArray, type, unicodeToByte, uniqueValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.lang.Runnable
run
 

Constructor Detail

MQeChannelListener

public MQeChannelListener()
                   throws java.lang.Exception
Deprecated. 

Constructs an MQeChannelListener object.

The class is instantiated but not activated. In order to activate the class the activate() method must be called.

Throws:
java.lang.Exception
Example:
 try {
     MQeChannelListener cl = new MQeChannelListener();
 } catch (Exception e) {
     System.err.println("Failure ! " + e.toString());
 }
 
 

MQeChannelListener

public MQeChannelListener(java.lang.Object listener,
                          java.lang.String fileType,
                          java.lang.Object processor)
                   throws java.lang.Exception
Deprecated. 

Constructs an MQeChannelListener object taking the following parameters.

Throws:
java.lang.Exception
Example:
 try {
     MQeChannelListener cl = new MQeChannelListener(listener, fileType, new MQeChannelManager());
 } catch (Exception e) {
     System.err.println("Failure ! " + e.toString());
 }
 
 
Method Detail

getProperty

public java.lang.String getProperty(java.lang.String key)
Deprecated. 
Description copied from interface: MQePropertyProvider

Implementors of the MQePropertyProvider interface must provide the getProperty method which will return a String containing the given value for the key provided.

Specified by:
getProperty in interface MQePropertyProvider
Parameters:
key - A string containing the name of the property to retrieve from the available properties. The key follows the same naming convention as Java properties, for instance com.ibm.mqe.adapters.MQeTcpipLengthAdapter.Timeout would be used to retrieve the timeout property for the MQeTcpipLengthAdapter class. If the implementing class does not have the required information it can then use the key to interrogate the Java properties.
Returns:
A string containing the value of the property or null if no property found

setTimer

public void setTimer(int interval)
              throws java.lang.Exception
Deprecated. 

Called to set up a time-out interval for any channels accepted by this channel listener.

This method is used to set a channel time-out interval for any channels accepted by this channel listener.

Parameters:
interval - An integer value in seconds of the desired time out interval.
Throws:
MQeException - Invalid channel or not allowed.
java.io.IOException - Error performing I/O operations.
java.lang.Exception
Example:
 try {
     MQeChannelListener cl = new MQeChannelListener();
 
     cl.activate(listener, fileType, new MQeChannelManager());
     cl.setTimer(300);
 } catch (Exception e) {
     System.err.println("Failure ! " + e.toString());
 }
 
 

activate

public void activate(java.lang.Object listener,
                     java.lang.String fileType,
                     java.lang.Object processor)
              throws java.lang.Exception
Deprecated. 

Activates the channel listener if it was not activated by the class constructor.

Activates an MQeChannelListener object. This is normally used only if the class was instantiated using a constructor with no parameters.

Throws:
java.lang.Exception
Example:
 try {
     MQeChannelListener cl = new MQeChannelListener();
 
     cl.activate(listener, fileType, new MQeChannelManager());
 } catch (Exception e) {
     System.err.println("Failure ! " + e.toString());
 }
 
 

stop

public void stop()
Deprecated. 

Called to stop the channel listener accepting any new inbound requests.

Example:
 try {
     MQeChannelListener cl = new MQeChannelListener();
 
     cl.activate(listener, fileType, new MQeChannelManager());
     cl.stop();
 } catch (Exception e) {
     System.err.println("Failure ! " + e.toString());
 }
 
 

Websphere MQ Everyplace