Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.MQSeries.InboundAdapter
Private  Storage   

EnsLib.MQSeries.InboundAdapter


class EnsLib.MQSeries.InboundAdapter extends
Ens.InboundAdapter

This adapter is for connecting to IBM WebSphere MQ.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 9 4


Summary


Properties
%CredentialsObj %WarnedLatest %initQueueNeeded BusinessHost
CallInterval Channel CharSet ContentStreamClassname
Credentials ErrorFile KeepaliveInterval QueueManager
QueueName RegistryID

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
AssignOneSetting ClearAllAppData ClearRuntimeAppData ClearStaticAppData
CredentialsSet EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch
GetSettings InitQueue OnInit OnKeepalive
OnTask OnTearDown


Parameters


• parameter SETTINGS = "QueueManager:Basic,Channel:Basic,QueueName:Basic,CharSet,ErrorFile:Dev";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties


• 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 the job will not start if 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 ContentStreamClassname as %String [ InitialExpression = "*%Stream.GlobalCharacter" ];
In your Service's OnInit() method, set this property to the name of a class you would like to receive as the Stream property of the pInput Message argument to your OnProcessInput method. If this value is empty or begins with a * character then the Body string property will be used unless the input is too long for the system maximum string size. If this value is empty or *, the class "%Stream.GlobalCharacter" will be used if the input is too long.
• 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.

Methods


• 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 OnTask() as %Status
default InboundAdapter behavior: always call ProcessInput on CallInterval
• method OnTearDown() as %Status
This user callback method is called just before %OnClose()