This section describes the characteristics of the different types of administered objects associated with the WebSphere MQ Everyplace WebSphere MQ-bridge. Characteristics are object attributes that can be queried using an inquireAll() administration message. The results can be read and used by the application, or they can be sent in an update or create administration message to set the values of the characteristics. Some characteristics can also be set using the create and update administration messages. Each characteristic has a unique label associated with it and this label is used to set and get the characteristic value.
The following lists show the attributes that apply to each administered object. The attributes are described in detail in alphabetical order in Attribute details. The label constants are defined in the header file published/MQe_MQBridge_Constants.h. If you include published/MQe_API.h in you installation, this file is included automatically.
MQE_FIELD_LABEL_ADAPTER
If this attribute is not specified, a default value of com.ibm.mqe.mqbridge.MQeMQAdapter is used.
This parameter is not validated
MQE_FIELD_LABEL_ADMINISTERED_OBJECT
This attribute describes the Java class that is used to provide the function for the bridge administered object. The value set depends on the type of administered object being configured.
This field should not be set, or changed without detailed instructions from IBM staff.
If this parameter is not specified when the object is created, it defaults
to the following allowable values:
Object being configured | Value |
---|---|
A bridge object | com.ibm.mqe.mqbridge.MQeMQBridge |
WebSphere MQ queue manager proxy object | com.ibm.mqe.mqbridge.MQeMQQMgrProxy |
WebSphere MQ client connection object | com.ibm.mqe.mqbridge.MQeClientConnection |
WebSphere MQ transmission queue listener object | com.ibm.mqe.mqbridge.MQeListener |
Valid characters are: '0-9' 'A-Z' 'a-z' - . % /
MQE_FIELD_LABEL_BRIDGE_NAME
MQE_FIELD_LABEL_CCSID
Valid values are: 0 to MAXINT. The default is 0.
MQE_FIELD_LABEL_CHILD
MQE_FIELD_LABEL_CHILDREN
MQE_FIELD_LABEL_CLIENT_CONNECTION_NAME
MQE_FIELD_LABEL_DEAD_LETTER_Q_NAME
The default value is SYSTEM.DEAD.LETTER.QUEUE.
MQE_FIELD_LABEL_DEFAULT_TRANSFORMER
When a message is sent from WebSphere MQ Everyplace to WebSphere MQ, the transmission queue listener moving the message onto WebSphere MQ Everyplace may have a transformer class defined. If a transformer is not defined, this class is used to transform the WebSphere MQ Everyplace message into the WebSphere MQ format.
No validation of the value in this field is performed.
The default value is com.ibm.mqebridge.MQeBaseTransformer
MQE_FIELD_LABEL_DESCRIPTION
MQE_FIELD_LABEL_HEARTBEAT_INTERVAL
The default value is 5 minutes.
MQE_FIELD_LABEL_HOST_NAME
MQE_FIELD_LABEL_LISTENER_NAME
MQE_FIELD_LABEL_LISTENER_STATE_STORE_ADAPTER
The disk adapter is generally quicker than using the WebSphere MQ-based
adapter. The classname can be followed by a colon separated list of
arguments, although only the MQeDiskFieldsAdapter uses them. In this
case the MQeDiskFieldsAdapter can be followed by a colon and a fully qualified
path name to a file that contains the state information. For example,
in order to use the disk fields adapter to store the listener's state
information in the file c:\folder\state.sta, the
listener-state-store-adapter field should contain the value
com.ibm.mqe.Adapters.MQeDiskFieldsAdapter:c:\folder\state.sta
A file specified by this parameter need not currently exist. If the
supplied path name ends in a folder separator, for example '\' in
DOS. It is assumed that the supplied parameter is a directory, and a
state file called
<ListenerName>-listener.sta is created inside it, where
<ListenerName> is the name of the listener, from the registry entry.
If no path name is supplied, the listener uses a file called
<ListenerName>-listener.sta inside the current Java working
directory If the MQeMQAdapter is being used, no additional arguments are
required.
The default value of the ListenerStateStoreAdapter field is
com.ibm.mqe.Adapters.MQeDiskFieldsAdapter.
MQE_FIELD_LABEL_MAX_CONNECTION_IDLE_TIME
When a WebSphere MQ connection becomes idle through lack of use, a timer is started. If the timer reaches the current value of this parameter, then the idle connection is thrown away. This is known as reaping the connection. This saves resources when the connection is idle. The connection pool is an efficiency device that is used within the WebSphere MQ-bridge. The creation of new WebSphere MQ client connections is a resource intensive operation. If there are idle connections in the pool, one of these is reused, thus avoiding a creation operation. The higher the MaxConnectionIdleTime value, the more likely it is that an idle connection will be waiting in the pool, but idle client connections consume resources in the JVM. Setting this value lower, decreases the likelihood of an idle connection being available, but also decreases the number of idle connections , so less resources are consumed.
The time is expressed in units of 1 minute.
The Valid range: Between 0 and 720 (12 hours). The default is 5 (minutes).
Setting this value to 0 is not recommended as it effectively means 'don't use a connection pool', and whenever a WebSphere MQ client connection is idle, it is reaped or discarded.
This time-out is only checked at the interval set by the
heartbeatInterval parameter.
MaxConnectionIdleTime can have a direct effect on the
length of time it takes to shut down an WebSphere MQ Everyplace system.
Refer to
WebSphere MQ-bridge considerations when shutting down a WebSphere MQ queue manager for more details.
MQE_FIELD_LABEL_PASSWORD
MQE_FIELD_LABEL_MQ_Q_MGR_PROXY_NAME
MQE_FIELD_LABEL_USER_ID
MQE_FIELD_LABEL_PORT
Valid range 0 to MAXINT.
MQE_FIELD_LABEL_RECEIVE_EXIT
This parameter is not validated.
MQE_FIELD_LABEL_RUN_STATE
MQE_FIELD_LABEL_SECURITY_EXIT
This parameter is not validated.
MQE_FIELD_LABEL_SEND_EXIT
This parameter is not validated.
MQE_FIELD_LABEL_STARTUP_RULE_CLASS
The rule class dictates whether the administered object is started, and whether or not its children are started. The default rule is com.ibm.mqe.mqbridge .MQeStartupRule This default causes the administered object and all its parents to start. If this field is set to "" (blank) , the administered object is not started.Rules are not directly supported by the C Bindings. SeeWebSphere MQ Everyplace Application Programming Guide for information about writing rules in Java.
MQE_FIELD_LABEL_SYNC_Q_NAME
The default is MQE.SYNCQ.DEFAULT.
MQE_FIELD_LABEL_SYNC_Q_PURGE_INTERVAL
When this interval elapses, the sync queue is scanned. If a message that has not been confirmed is found on the Sync queue, then the SyncQPurgerRules class is invoked to deal with this situation.
Zero indicates that the sync queue should never be purged.
The default is 60 minutes.
The actual granularity of the purging operation is dictated by the heartbeat-interval of the owning bridge definition. For example: If the hearbeat interval is set to 10 minutes, but the purge interval is set to 9 minutes, then the purge operation occurs after 10 minutes. If, however, the purge interval is changed to 11 minutes, the purge operation still occurs after 10 minutes.
MQE_FIELD_LABEL_SYNC_Q_PURGER_RULES_CLASS
The default is a classname that just reports the condition in the WebSphere MQ Everyplace trace.
This parameter is not validated.
MQE_FIELD_LABEL_TRANSFORMER
The default value is ""
Transformers are not directly supported by the C Bindings. SeeWebSphere MQ Everyplace Application Programming Guide for information about writing transformers in Java.
MQE_FIELD_LABEL_UNDELIVERED_MESSAGE_RULE_CLASS
The default value is: com.ibm.mqe.mqbridge.MQeUndeliveredMessageRule. Rules are not directly supported by the C Bindings. SeeWebSphere MQ Everyplace Application Programming Guide for information about writing rules in Java.