Home > Class Reference > ENSLIB namespace > EnsLib.JMS.Common

EnsLib.JMS.Common

abstract class EnsLib.JMS.Common extends %Library.RegisteredObject

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter ISINBOUND = 0;
parameter SETTINGS = JavaGatewayHost,JavaGatewayPort,JavaGatewayTimeout,JMSServer,JMSFactory,JMSQueue,JMSClientID,JMSCredentials:Basic:credentialsSelector,JMSLogFileName;

Properties (Including Private)

property %JavaGateway as %Net.Remote.Java.JavaGateway;
The JavaGateway connection object
Property methods: %JavaGatewayGet(), %JavaGatewayGetSwizzled(), %JavaGatewayIsValid(), %JavaGatewayNewObject(), %JavaGatewayProxyGet(), %JavaGatewayProxyGetSwizzled(), %JavaGatewayProxyIsValid(), %JavaGatewayProxyNewObject(), %JavaGatewayProxySet(), %JavaGatewaySet()
property %JavaGatewayProxy as %RegisteredObject;
The proxy object for the JavaGateway connection
Property methods: %JavaGatewayProxyGet(), %JavaGatewayProxyGetSwizzled(), %JavaGatewayProxyIsValid(), %JavaGatewayProxyNewObject(), %JavaGatewayProxySet()
property JMSClientID as %String;
ClientID to use for the connection
Property methods: JMSClientIDDisplayToLogical(), JMSClientIDGet(), JMSClientIDIsValid(), JMSClientIDLogicalToDisplay(), JMSClientIDLogicalToOdbc(), JMSClientIDNormalize(), JMSClientIDSet()
property JMSCredentials as %String [ InitialExpression = "None" ];
This is the ID name of the set of credentials values (Username, Password) to be used to access the HTTP server
Property methods: JMSCredentialsDisplayToLogical(), JMSCredentialsGet(), JMSCredentialsIsValid(), JMSCredentialsLogicalToDisplay(), JMSCredentialsLogicalToOdbc(), JMSCredentialsNormalize(), JMSCredentialsSet()
property JMSFactory as %String;
Name of QueueConnectionFactory
Property methods: JMSFactoryDisplayToLogical(), JMSFactoryGet(), JMSFactoryIsValid(), JMSFactoryLogicalToDisplay(), JMSFactoryLogicalToOdbc(), JMSFactoryNormalize(), JMSFactorySet()
property JMSLogFileName as %String;
Log file name
Property methods: JMSLogFileNameDisplayToLogical(), JMSLogFileNameGet(), JMSLogFileNameIsValid(), JMSLogFileNameLogicalToDisplay(), JMSLogFileNameLogicalToOdbc(), JMSLogFileNameNormalize(), JMSLogFileNameSet()
property JMSQueue as %String;
Name of Queue
Property methods: JMSQueueDisplayToLogical(), JMSQueueGet(), JMSQueueIsValid(), JMSQueueLogicalToDisplay(), JMSQueueLogicalToOdbc(), JMSQueueNormalize(), JMSQueueSet()
property JMSServer as %String;
URL for JMS Server
Property methods: JMSServerDisplayToLogical(), JMSServerGet(), JMSServerIsValid(), JMSServerLogicalToDisplay(), JMSServerLogicalToOdbc(), JMSServerNormalize(), JMSServerSet()
property JavaGatewayTimeout as %Numeric (MAXVAL = 30000, MINVAL = 0) [ InitialExpression = 5 ];
Number of seconds to wait on each attempt to connect to the Java Gateway
Property methods: JavaGatewayTimeoutDisplayToLogical(), JavaGatewayTimeoutGet(), JavaGatewayTimeoutIsValid(), JavaGatewayTimeoutLogicalToDisplay(), JavaGatewayTimeoutNormalize(), JavaGatewayTimeoutSet()

Methods (Including Private)

method CheckGatewayConnection() as %Status
method CheckGatewayDisconnection() as %Boolean
method Connect() as %Status
method Disconnect() as %Status
method OnInit() as %Status
method OnTearDown() as %Status

Inherited Members

Inherited Methods (Including Private)

Subclasses