Client Class Reference

Inheritance diagram for Client:

Collaboration diagram for Client:

Public Member Functions
_.Library.Status	Close ()
	Close connections and release resources.
_.Library.Status	Connect (_.Library.String jclientClass, _.Library.String settings, _.Library.String additionalClasspaths)
	Connect to gateway and instantiate Java messaging client.
_.Library.Status	CreateQueueOrTopic (_.Library.String queueOrTopicName, _.Library.String settings)
	Applicable to all except JMS. More...
_.Library.Status	DeleteQueueOrTopic (_.Library.String queueOrTopicName)
	Applicable to all except JMS.
_.Library.Status	ReceiveMessage (_.Library.String queueOrTopicName, _.Library.ListOfObjects messages, _.Library.String settings)
	Applicable to all except SNS. More...
_.Library.Status	SendMessage (_.External.Messaging.Message message)
	Applicable to all. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.External.Messaging.Client	CreateClient (_.External.Messaging.Settings settings, _.Library.Status sc, _.Library.String additionalClasspaths)
	Factory method to create an instance of messaging client. More...
_.External.Messaging.JMSClient	CreateJMSClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
	Connects to JMS using the passed in settings JSON string. More...
_.External.Messaging.KafkaClient	CreateKafkaClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
	Connects to Kafka using the passed in settings JSON string. More...
_.External.Messaging.RabbitMQClient	CreateRabbitMQClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
	Connects to RabbitMQ using the passed in settings JSON string. More...
_.External.Messaging.SNSClient	CreateSNSClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
	Connects to SNS using the passed in settings JSON string. More...
_.External.Messaging.SQSClient	CreateSQSClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
	Connects to SQS using the passed in settings JSON string. More...

Public Attributes
	gateway
	Connection to a Java Gateway. More...
	jclient
	Remote Java messaging client object. More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Member Function Documentation

CreateClient()

_.External.Messaging.Client CreateClient ( _.External.Messaging.Settings  settings, _.Library.Status  sc, _.Library.String  additionalClasspaths  )

static

Factory method to create an instance of messaging client.

The type of the client is dertermined by the type of the settings class. Supported settings classes are SNSSettings, SQSSettings, KafkaSettings, JMSSettings and RabbitMQSettings. additionalClasspaths: Additional Java class paths needed by the Java Gateway to instantiate the messaging client. If there are multiple paths, pass in a ListOfDataTypes.

CreateJMSClient()

_.External.Messaging.JMSClient CreateJMSClient ( _.Library.String  settings, _.Library.Status  sc, _.Library.String  additionalClasspaths  )

static

Connects to JMS using the passed in settings JSON string.

CreateKafkaClient()

_.External.Messaging.KafkaClient CreateKafkaClient ( _.Library.String  settings, _.Library.Status  sc, _.Library.String  additionalClasspaths  )

static

Connects to Kafka using the passed in settings JSON string.

CreateQueueOrTopic()

_.Library.Status CreateQueueOrTopic	(	_.Library.String	queueOrTopicName,
		_.Library.String	settings
	)

Applicable to all except JMS.

settings: JSON string representing attributes required to create the queue/topic. The settings are only required for Kafka, SQS and RabbitMQ. The corresponding settings classes are KafkaTopicSettings, SQSQueueSettings and RabbitMQQueueSettings.

CreateRabbitMQClient()

_.External.Messaging.RabbitMQClient CreateRabbitMQClient ( _.Library.String  settings, _.Library.Status  sc, _.Library.String  additionalClasspaths  )

static

Connects to RabbitMQ using the passed in settings JSON string.

CreateSNSClient()

_.External.Messaging.SNSClient CreateSNSClient ( _.Library.String  settings, _.Library.Status  sc, _.Library.String  additionalClasspaths  )

static

Connects to SNS using the passed in settings JSON string.

CreateSQSClient()

_.External.Messaging.SQSClient CreateSQSClient ( _.Library.String  settings, _.Library.Status  sc, _.Library.String  additionalClasspaths  )

static

Connects to SQS using the passed in settings JSON string.

ReceiveMessage()

_.Library.Status ReceiveMessage	(	_.Library.String	queueOrTopicName,
		_.Library.ListOfObjects	messages,
		_.Library.String	settings
	)

Applicable to all except SNS.

Receives a List of Messages. queueOrTopicName: Name of the queue/topic to receive messages from. messages: Output list of received messages(External.Messaging.___Message objects). settings: Optional attributes in JSON string required by the underlying messaging provider to receive messages. Corresponding settings classes are KafkaReceiveSettings, SQSReceiveSettings, JMSReceiveSettings and RabbitMQReceiveSettings.

SendMessage()

_.Library.Status SendMessage

(

_.External.Messaging.Message

message

)

Applicable to all.

Sends a message that is passed in as a parameter, which can be any External.Messaging.___Message objects.

Member Data Documentation

gateway

gateway

Connection to a Java Gateway.

 

jclient

jclient

Remote Java messaging client object.