Websphere MQ Everyplace

com.ibm.mqe.mqbridge
Class MQeMQBridgeQueueAdminMsg

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--com.ibm.mqe.MQeFields
              |
              +--com.ibm.mqe.MQeMsgObject
                    |
                    +--com.ibm.mqe.MQeAdminMsg
                          |
                          +--com.ibm.mqe.administration.MQeQueueAdminMsg
                                |
                                +--com.ibm.mqe.administration.MQeRemoteQueueAdminMsg
                                      |
                                      +--com.ibm.mqe.mqbridge.MQeMQBridgeQueueAdminMsg
All Implemented Interfaces:
MQeExceptionCodes

public class MQeMQBridgeQueueAdminMsg
extends MQeRemoteQueueAdminMsg

Used to administer MQeMQBridgeQueue resources on a bridge-enabled queue manager.

See Also:
MQBridgeQueueCreator

Field Summary
static java.lang.String Queue_BridgeName
          Name of a field in the admin message which holds the name of the Websphere MQ-bridge the bridge queue should use to convey message data to the Websphere MQ queue manager.
static java.lang.String Queue_ClientConnection
          The name of the field which is set to hold the name of the client connection resource used to convey messages to the Websphere MQ queue manager.
static java.lang.String Queue_MaxIdleTime
          The name of the field containing the MaxIdleTime configuration parameter.
static java.lang.String Queue_MQQMgr
          The name of the field which is set to hold the name of the MQ queue manager proxy resource used to convey messages to the Websphere MQ queue manager.
static java.lang.String Queue_RemoteQName
          The name of the field which holds the true name of the queue on the Websphere MQ queue manager to which messages are first put.
static java.lang.String Queue_Transformer
          The name of the field which holds the name of the transformer class the bridge queue will use when converting an WebSphere MQ Everyplace message into a Websphere MQ message.
 
Fields inherited from class com.ibm.mqe.administration.MQeRemoteQueueAdminMsg
Queue_CloseIdle, Queue_DefaultTransporter, Queue_Transporter, Queue_TransporterXOR
 
Fields inherited from class com.ibm.mqe.administration.MQeQueueAdminMsg
Queue_Active, Queue_Asynchronous, Queue_AttrRule, Queue_Authenticator, Queue_Compressor, Queue_CreationDate, Queue_Cryptor, Queue_CurrentSize, Queue_Description, Queue_Expiry, Queue_FileDesc, Queue_MaxMsgSize, Queue_MaxQSize, Queue_Mode, Queue_NoLimit, Queue_Priority, Queue_QAliasNameList, Queue_QMgrName, Queue_RegistryNone, Queue_RegistryQMgr, Queue_RegistryQueue, Queue_Rule, Queue_Synchronous, Queue_TargetRegistry
 
Fields inherited from class com.ibm.mqe.MQeAdminMsg
Action_AddAlias, Action_Create, Action_Delete, Action_Inquire, Action_InquireAll, Action_RemoveAlias, Action_Start, Action_Stop, Action_Unknown, Action_Update, Admin_Action, Admin_Class, Admin_Errors, Admin_MaxAttempts, Admin_Name, Admin_Parms, Admin_RC, Admin_Reason, Admin_TargetQMgr, RC_Fail, RC_Mixed, RC_Success
 
Fields inherited from class com.ibm.mqe.MQeFields
ArraySeparator, TypeArrayElements, TypeAscii, TypeBoolean, TypeByte, TypeDouble, TypeFields, TypeFloat, TypeInt, TypeLong, TypeShort, TypeUnicode, TypeUnTyped
 
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
MQeMQBridgeQueueAdminMsg()
          This simple constructor creates and initializes a default administration message to administer the Websphere MQ-bridge queue.
MQeMQBridgeQueueAdminMsg(java.lang.String bridgeName, java.lang.String mqQMgrProxyName, java.lang.String clientConnectionName, int maxIdleTimeout)
          This constructor includes initial values for the name of the Websphere MQ-bridge, the name of the proxy, and the name of the client connection.
 
Method Summary
 MQeFields characteristics()
          Create a fields object containing the valid characteristics of a queue.
 
Methods inherited from class com.ibm.mqe.administration.MQeQueueAdminMsg
addAlias, changeAlias, removeAlias, setName
 
Methods inherited from class com.ibm.mqe.MQeAdminMsg
create, delete, duplicate, getAction, getErrorFields, getFieldInError, getInputFields, getMaxAttempts, getName, getOutputFields, getRC, getReason, getTargetQMgr, inquire, inquireAll, setAction, setMaxAttempts, setName, setTargetQMgr, update
 
Methods inherited from class com.ibm.mqe.MQeMsgObject
getMsgUIDFields, getOriginQMgr, getTimeStamp, putOriginQMgr, resetMsgUIDFields, unwrapMsgObject
 
Methods inherited from class com.ibm.mqe.MQeFields
contains, copy, copy, dataType, deepCopy, delete, dump, dumpedType, dumpToString, equals, fields, getArrayLength, getArrayOfByte, getArrayOfDoubleAsLong, getArrayOfFloatAsInt, getArrayOfInt, getArrayOfLong, getArrayOfShort, getAscii, getAsciiArray, getAttribute, getBoolean, getByte, getDoubleAsLong, getFields, getFieldsArray, getFloatAsInt, getInt, getIntArray, getLong, getLongArray, getObject, getShort, getShortArray, getUnicode, getUnicodeArray, includes, isEqualTo, putArrayLength, putArrayOfByte, putArrayOfDoubleAsLong, putArrayOfFloatAsInt, putArrayOfInt, putArrayOfLong, putArrayOfShort, putAscii, putAsciiArray, putBoolean, putByte, putByteArray, putDoubleAsLong, putFields, putFieldsArray, putFloatAsInt, putInt, putIntArray, putLong, putLongArray, putObject, putShort, putShortArray, putUnicode, putUnicodeArray, rename, restore, restoreFromString, restoreFromString, restoreFromString, setAttribute, updateValue
 
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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Queue_BridgeName

public static final java.lang.String Queue_BridgeName

Name of a field in the admin message which holds the name of the Websphere MQ-bridge the bridge queue should use to convey message data to the Websphere MQ queue manager.

A field of this name is of type Ascii. It sits nested within the Input/Output fields structure of the admin message. It is a mandatory field in the message.

See Also:
Constant Field Values

Queue_MQQMgr

public static final java.lang.String Queue_MQQMgr

The name of the field which is set to hold the name of the MQ queue manager proxy resource used to convey messages to the Websphere MQ queue manager.

A field of this name is of type Ascii. It sits nested within the Input/Output fields structure of the admin message.

See Also:
Constant Field Values

Queue_ClientConnection

public static final java.lang.String Queue_ClientConnection

The name of the field which is set to hold the name of the client connection resource used to convey messages to the Websphere MQ queue manager.

A field of this name is of type Ascii. It sits nested within the Input/Output fields structure of the admin message.

See Also:
Constant Field Values

Queue_RemoteQName

public static final java.lang.String Queue_RemoteQName

The name of the field which holds the true name of the queue on the Websphere MQ queue manager to which messages are first put.

A field of this name is of type Ascii. It is an optional field. If missing, then the name of the queue will assume that the queue's local name is the same as that on the MQSeries system.

A field with this name sits nested within the Input/Output fields structure of the admin message.

See Also:
Constant Field Values

Queue_Transformer

public static final java.lang.String Queue_Transformer

The name of the field which holds the name of the transformer class the bridge queue will use when converting an WebSphere MQ Everyplace message into a Websphere MQ message.

A field of this name is of type Ascii. It is optional. If missing, a transformer dictated by the configuration of the Bridge resource is used to transform messages. It sits nested within the Input/Output fields structure of the admin message.

See Also:
Constant Field Values

Queue_MaxIdleTime

public static final java.lang.String Queue_MaxIdleTime

The name of the field containing the MaxIdleTime configuration parameter. It indicates how long an Websphere MQ-bridge queue is allowed to keep an idle connection before the connection is returned to the connection pool.

A field of this name sits nested within the Input/Output fields structure of the admin message.

The field is of type Integer.

The "idle time" parameter indicates the maximum number of minutes that the queue can hold an MQ connection, before it has to be released back to an "idle connection pool" maintained by the bridge's client connection object. For example, if the queue is unused for a while, the underlying MQ connection will be released back to a "pool" where another queue could pick it up, and use it.

When the original idle queue has any message activity, it can go to the pool for another possibly different connection, and start using that.

The fact that the MQ connections logically underpinning an MQ bridge queue may be freed, and re-allocated, is transparent to users of the queue, except that a small time penulty is incurred releasing and getting an idle connection to or from the connection pool.

Units of 1 minute.

Values of 0 .. MAXINT are valid.

The timer parameter is directly dependent on the granularity of the bridge heartbeat parameter. See bridge resource configuration parameters for more details.

In the extreme case, specifying an idle time of 0 means "always free a connection to the pool once you have used it". Although this allows a very small number of MQ client connection channels to be effectively "shared" between a large number of MQBridge queues , provided they all use the same Bridge/MQProxy/ClientConnection details, it is at the cost of the release-too-pool and aquire-from-pool operations on a per-message basis.

We recommend a default of 5 minutes. For example, if the queue is activated once by a message being put, a WMQ connection will be aquired and used to put the message. If the queue is not used for 5 minutes, the WMQ connection will be returned to the connection pool for some other MQbridge queue to use.

See Also:
Constant Field Values
Constructor Detail

MQeMQBridgeQueueAdminMsg

public MQeMQBridgeQueueAdminMsg()
                         throws java.lang.Exception

This simple constructor creates and initializes a default administration message to administer the Websphere MQ-bridge queue.

Throws:
java.lang.Exception - If the message cannot be created.
Example:
 MQeMQBridgeQueueAdminMsg msg;
 
 msg = new MQeMQBridgeQueueAdminMsg();
 
 

MQeMQBridgeQueueAdminMsg

public MQeMQBridgeQueueAdminMsg(java.lang.String bridgeName,
                                java.lang.String mqQMgrProxyName,
                                java.lang.String clientConnectionName,
                                int maxIdleTimeout)
                         throws java.lang.Exception

This constructor includes initial values for the name of the Websphere MQ-bridge, the name of the proxy, and the name of the client connection.

Parameters:
maxIdleTimeout - The number of minutes the queue is allowed to keep hold of a connection to the Websphere MQ system without using it. When the queue has been unused for this duration, the connection is returned to the connection pool. If 0, the connection is returned to the connection pool immediately after use.
Throws:
java.lang.Exception - If the message cannot be created.
Example:
 MQeMQBridgeQueueAdminMsg msg;
 
 msg = new MQeMQBridgeQueueAdminMsg("MQBridgeV100",
             "lizzieQM",
             "svrconn",
             5);
 
 
Method Detail

characteristics

public MQeFields characteristics()
                          throws java.lang.Exception

Create a fields object containing the valid characteristics of a queue.

Overrides:
characteristics in class MQeAdminMsg
Returns:
An MQeFields object containing the characteristics of the queue. It does not contain the value of each characteristic. It can be used to determine the name and type of all valid characteristics.
Throws:
java.lang.Exception - If the MQeFields object cannot be created.
Example:
 MQeMQBridgeQueueAdminMsg msg;
 
 msg = new MQeMQBridgeQueueAdminMsg("MQBridgeV100",
             "lizzieQM",
             "svrconn",
             5);
 MQeFields adminMsgChars = msg.characteristics();
 
 return adminMsgChars;
 
 

Websphere MQ Everyplace