Overloaded message for creating a configuration command that adds a queue. More...

Inheritance diagram for Apac.Messaging.Messages.AddQueueConfigMessage:

Public Member Functions
	AddQueueConfigMessage (string configQueue, Configuration.QueueConfigElement config, string initiatingUser)
	Creates a new message to initiate the addition of a queue to the system. More...

Public Member Functions inherited from Apac.Messaging.Message
	Message (string queue, MessageType type, string subject, string body, string initiatingProcess, string initiatingUser)
	Creates a new message instance. More...

	Message ()
	Parameterless constructor provided for XML serialization. More...

void	AddProperty (string propertyName, object data)
	Puts an object in the property bag, which is the extended data for the message, apart from the message content. This data is stored with the message but is not delivered along with it. It can be used to drive any special handling required for the message, but standard handlers ignore it. More...

object	GetProperty (string propertyName)
	Dips into the property bag and returns the extended data with the given name. More...

List< DeliveryStatus >	GetHistoryByProtocol (MessagingProtocols protocol)
	Gets sublist of delivery status messages that match the requested protocol sorted by timestamp (ascending). More...

void	GetObjectData (SerializationInfo info, StreamingContext context)
	The serializing method for binary data. More...

System.Xml.Schema.XmlSchema	GetSchema ()
	This method is a no-op. We have opted to use the System.Xml.Serialization.XmlSchemaProviderAttribute instead. More...

void	ReadXml (System.Xml.XmlReader reader)
	Deserializes object data from XML format. More...

void	WriteXml (System.Xml.XmlWriter writer)
	Serializes object data to XML format. More...

Static Public Member Functions
static Configuration.QueueConfigElement	GetQueueConfig (Message msg)
	Retrieves the Configuration.QueueConfigElement from the property bag of msg . More...

Protected Member Functions
	AddQueueConfigMessage (SerializationInfo info, StreamingContext context)
	Deserializes an AddQueueConfigMessage. More...

Protected Member Functions inherited from Apac.Messaging.Messages.ConfigurationMessage
	ConfigurationMessage (string configQueue, MessagingConfigurationOperations op, string initiatingProcess, string initiatingUser)
	Creates a new ConfigurationMessage. More...

	ConfigurationMessage (SerializationInfo info, StreamingContext context)
	Deserializes a ConfigurationMessage. More...

Protected Member Functions inherited from Apac.Messaging.Message
	Message (SerializationInfo info, StreamingContext context)
	Deserializes a message from binary format. More...

virtual void	OnReadXml (System.Xml.XmlReader reader)
	The virtual plug-in point for XML deserialization, for subclasses to participate. More...

virtual void	OnWriteXml (System.Xml.XmlWriter writer)
	The virtual plug-in point for XML serialization, for subclasses to participate. More...

Additional Inherited Members
Properties inherited from Apac.Messaging.Messages.ConfigurationMessage
MessagingConfigurationOperations	Operation `[get]`
	Returns the configuration operation to be done for this message. More...

Properties inherited from Apac.Messaging.Message
Guid	Id `[get]`
	Gets the auto-generated unique ID for this message. More...

string	Queue `[get, protected set]`
	Gets the designated queue for the message. This provides scope isolation within the messaging system and can be used to securely partition storage space between different security contexts (eg: two banks using the same server can have their messages segregated by queue, each with its own exclusive permissions). More...

MessageType	Type `[get, protected set]`
	The category to which this message belongs. This provides message routing within the message handling control structures. See MessageType for details about each type. More...

string	Subject `[get, protected set]`
	Gets the brief summary or topic for the message. More...

string	Body `[get, protected set]`
	Gets the content of the message. More...

string	BodyAsHTML `[get]`
	Gets the content of the message wrapped in an HTML document. More...

string	InitiatingProcess `[get, protected set]`
	Gets the name of the process (or class and method) that created the notification request for this message. This information is included as an auditing and statistical analysis metric. More...

string	InitiatingUser `[get, protected set]`
	Gets the name of the user identity under which the InitiatingProcess is executing. Thei information is included as an auditing and statistical analysis metric. More...

List< DeliveryStatus >	DeliveryHistory `[get]`
	Gets the whole unsorted list of delivery status entries for the life of the message. More...

string	AuditID `[get]`
	Returns the Audit Identification value that can be used to track this message. More...

string	Hostname `[get]`
	The hostname of the system where the message was originally created. More...

string	Text `[get]`
	Returns the Body and AuditID concatenated together. More...

Detailed Description

Overloaded message for creating a configuration command that adds a queue.

Constructor & Destructor Documentation

◆ AddQueueConfigMessage() [1/2]

Apac.Messaging.Messages.AddQueueConfigMessage.AddQueueConfigMessage	(	string	configQueue,
		Configuration.QueueConfigElement	config,
		string	initiatingUser
	)

inline

Creates a new message to initiate the addition of a queue to the system.

Parameters

configQueue	The name of the queue into which this message will be place (the configuration queue).
config	The queue configuration for the new queue.
initiatingUser	The initiating user.

◆ AddQueueConfigMessage() [2/2]

Apac.Messaging.Messages.AddQueueConfigMessage.AddQueueConfigMessage	(	SerializationInfo	info,
		StreamingContext	context
	)

inlineprotected

Deserializes an AddQueueConfigMessage.

Parameters

info	See SerializationInfo.
context	See StreamingContext.

Member Function Documentation

◆ GetQueueConfig()

static Configuration.QueueConfigElement Apac.Messaging.Messages.AddQueueConfigMessage.GetQueueConfig ( Message msg )

inlinestatic

Retrieves the Configuration.QueueConfigElement from the property bag of msg .

Parameters

msg	The message to be operated on.

Returns: Returns Configuration.QueueConfigElement.

This was done with a static method because deserializing and casting to a specific type did not work.

The documentation for this class was generated from the following file:

/var/lib/jenkins/workspace/apac/APAC/APACCore/Messaging/Messages/AddQueueConfigMessage.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AddQueueConfigMessage() [1/2]

◆ AddQueueConfigMessage() [2/2]

Member Function Documentation

◆ GetQueueConfig()