Websphere MQ Everyplace

com.ibm.mqe
Class MQeChannelManager

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--com.ibm.mqe.MQeChannelManager
All Implemented Interfaces:
MQeExceptionCodes

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 manager for the WebSphere MQ Everyplace logical channels.

This class is a descendant of MQe

public class MQeChannelManager
extends MQe


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.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
MQeChannelManager()
          Deprecated. Constructs an MQeChannelManager object.
 
Method Summary
 int numberOfChannels(int newLimit)
          Deprecated. Called to get the number of currently active logical channels.
 void process(MQeCommunicationsAdapter adapter)
          Deprecated. Called to process data (bytes) received, destined for an WebSphere MQ Everyplace logical channel.
 byte[] process(MQeCommunicationsAdapter adapter, byte[] byteContent)
          Deprecated. Called to process data (bytes) received, destined for an WebSphere MQ Everyplace logical channel.
 void timeOut(long age)
          Deprecated. Called to force any logical channels to be timed out if they have been idle for more than a specified interval.
 long totalNumberOfChannels()
          Deprecated. Called to get the total number of channels that have been used since the channel manager was activated.
 
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
 

Constructor Detail

MQeChannelManager

public MQeChannelManager()
Deprecated. 

Constructs an MQeChannelManager object.

Example:
 MQeChannelManager cm = new MQeChannelManager();
 
 
Method Detail

numberOfChannels

public int numberOfChannels(int newLimit)
Deprecated. 

Called to get the number of currently active logical channels.

This method returns the maximum number of permissible channels.

Parameters:
newLimit - The new maximum number of concurrent channels allowed by this channel manager, a value of 0 implies no limit.
Returns:
An integer value that is the limit used before this method was called.
Example:
 MQeChannelManager cm = new MQeChannelManager();
 int count = cm.numberOfChannels(0);
 
 return (count);
 
 

process

public void process(MQeCommunicationsAdapter adapter)
             throws java.lang.Exception
Deprecated. 

Called to process data (bytes) received, destined for an WebSphere MQ Everyplace logical channel.

An MQeAdapter object as the only parameter. This is used to read the data to be passed on to the logical channel.

Parameters:
adapter - An MQeAdapter object to be used for any I/O operations.
Returns:
void
Throws:
MQeException - Invalid channel or not allowed.
java.lang.Exception

process

public byte[] process(MQeCommunicationsAdapter adapter,
                      byte[] byteContent)
               throws java.lang.Exception
Deprecated. 

Called to process data (bytes) received, destined for an WebSphere MQ Everyplace logical channel.

An MQeAdapter (or null ) and an array of bytes. The array contains the data to be processed by the logical channel.

This method is called in order to process a "Channel" request. The data passed in the ByteContent parameter contains the encrypted and/or compressed channel data.

Parameters:
adapter - An MQeAdapter object to be used for any I/O operations.
Returns:
A byte array containing the processed data.
Throws:
MQeException - Invalid channel or not allowed.
java.lang.Exception
Example:
 try {
     MQeChannelManager cm = new MQeChannelManager();
 
     cm.process(null, data);
 
 } catch (Exception e) {// hanlde the exception here.
         }
 

timeOut

public void timeOut(long age)
Deprecated. 

Called to force any logical channels to be timed out if they have been idle for more than a specified interval.

This method is used to check all channels or one specific channel to see if they have been idle for more than age milliseconds. Any channels that have exceeded this time are closed.

Parameters:
age - An interval in milliseconds. If the channel has been idle for more than this interval it is considered to have timed out, and is closed.
Returns:
void
Example:
 MQeChannelManager cm = new MQeChannelManager();
 
 cm.timeOut(30 * 60 * 1000);
 
 

totalNumberOfChannels

public long totalNumberOfChannels()
Deprecated. 

Called to get the total number of channels that have been used since the channel manager was activated.

Returns:
A long integer value that is the total number of channels.
Example:
 MQeChannelManager cm = new MQeChannelManager();
 long count = cm.totalNumberOfChannels();
 
 return (count);
 
 

Websphere MQ Everyplace