abstract class EnsLib.MQSeries.CommonAdapter
extends Ens.Adapter
This is common adapter code used by inbound and outbound adapters for connecting to IBM WebSphere MQ.
• parameter SETTINGS = "QueueManager:Basic,Channel:Basic,QueueName:Basic,Credentials:Basic:credentialsSelector,CharSet,ErrorFile:Dev";
List of properties can be set as settings in the configuration file
format is a comma separated list of property names
• property %initQueueNeeded
as %Boolean [ InitialExpression = 0 ];
This is set if the queue needs to be initialized again after the job has started.
Default is 0 since OnInit() calls initialize and will set to 1 if InitQueue errors.
The job will will still start if InitQueue not successful.
• property Channel
as %String(MAXLEN=256);
The specification for the channel, in the following form: "channel_name/transport/host_name(port)".
Transport can be one of the following: TCP, LU62, NETBIOS, SPX
If you omit this setting, the system uses the default channel specification, as configured in
IBM WebSphere MQ.
Or, if the system has been the configured so that the channel is determined by the queue name, the system
uses the channel that is appropriate for the given queue name.
• property CharSet
as %Integer;
This setting specifies the IBM Coded Character Set Id. If you do not specify a value, the MQ system assumes the messages use the default character set
specified for the MQ client.
• property Credentials
as %String;
Optional ID name of the set of credentials values (Username, Password) to be used to access the MQ Series system
• property ErrorFile
as %String(MAXLEN=1023);
Specifies the log file to write error messages to.
If you omit this setting, no logging occurs.
• property QueueManager
as %String(MAXLEN=256);
If you omit this setting, the system uses the default queue manager, as configured in IBM WebSphere MQ.
Or, if IBM WebSphere MQ has been the configured so that the queue manager is determined by the queue name,
the system uses the queue manager that is appropriate for the given queue name.
• property QueueName
as %String(MAXLEN=256);
(Required) Specifies the queue name; this should be a valid queue for the specified queue manager.
Also, you must have permission to use this queue.
• method InitQueue()
as %Status
This user callback method is called for the first poll and after if there is an error.
• method OnInit()
as %Status
This user callback method is called just after %OnNew()
• method OnTearDown()
as %Status
This user callback method is called just before %OnClose()
