Namespace: OpenEdge.Messaging
Type: Class TopicConfigurationBuilder
Parent Classes:
Progress.Lang.Object
OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Messaging.TopicConfigurationBuilder

Inherits: OpenEdge.Core.Util.ConfigBuilder

/*
Copyright © 2021 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
Purpose:
This builder handles generating topic configurations. A topic configuration
is used by the producer to handle topic specific configuration such as
custom serializers, timeouts, etc, that may be different from the options
configured for the producer.



Method Summary
  Options Name Purpose
  OpenEdge.Messaging.ITopicConfiguration Build () /** Build a topic configuration using the current state of the builder. */
  OpenEdge.Messaging.ITopicConfiguration CreateTopicConfiguration () /** Create a topic configuration instance. This method may be overridden by sub classes to create a producer specific topic configuration. @return A new topic configuration built from the current state of this builder. */
  OpenEdge.Messaging.TopicConfigurationBuilder SetBodyDeserializer (character) /** Provide the name of a class which must implement OpenEdge.Messaging.IDeserializer. An instance of this class will be created to convert the body MEMPTR values of messages to an ABL object. */
  OpenEdge.Messaging.TopicConfigurationBuilder SetBodyDeserializer (IDeserializer) /** Provide an implementation of OpenEdge.Messaging.IDeserializer that will be used to convert the message content MEMPTR to a body value for a message. */
  OpenEdge.Messaging.TopicConfigurationBuilder SetBodyDeserializerCodePage (character) /** Set the codepage used to deserialize memptr to a string based message body. */
  OpenEdge.Messaging.TopicConfigurationBuilder SetBodySerializer (character) /** Provide the name of a class which must implement OpenEdge.Messaging.ISerializer. An instance of this class will be created to convert the body values of messages to MEMPTR. */
  OpenEdge.Messaging.TopicConfigurationBuilder SetBodySerializer (ISerializer) /** Provide an implementation of OpenEdge.Messaging.ISerializer that will be used to convert the body values of messages to MEMPTR. */
  OpenEdge.Messaging.TopicConfigurationBuilder SetBodySerializerCodePage (character) /** Set the codepage used to serialize string based message bodies. */
  OpenEdge.Messaging.TopicConfigurationBuilder SetTopicName (character)
  OpenEdge.Messaging.TopicConfigurationBuilder SetTopicOption (character, character) /** Set a generic name=value pair that can be used to provide per-topic configuration. It is up to the producer implementation to make use of the values to provide per topic configuration to the implementation. @param name The name of the topic option to store. @param val The value of the topic option to store. @return This topic config builder. If name is specified as unknown or is empty, return ? */

Method Detail
Top

OpenEdge.Messaging.ITopicConfiguration Build ()

Purpose:
Build a topic configuration using the current state of the builder.
Returns OpenEdge.Messaging.ITopicConfiguration
 
Top

OpenEdge.Messaging.ITopicConfiguration CreateTopicConfiguration ()

Purpose:
Create a topic configuration instance. This method
may be overridden by sub classes to create a producer
specific topic configuration.
Returns OpenEdge.Messaging.ITopicConfiguration
  A new topic configuration built from the current state of this builder.
Top

OpenEdge.Messaging.TopicConfigurationBuilder SetBodyDeserializer (character)

Purpose:
Provide the name of a class which must implement OpenEdge.Messaging.IDeserializer.
An instance of this class will be created to convert the body MEMPTR values of messages
to an ABL object.
Parameters:
bodyDeserializerClassName CHARACTER
 
Returns OpenEdge.Messaging.TopicConfigurationBuilder
 
Top

OpenEdge.Messaging.TopicConfigurationBuilder SetBodyDeserializer (IDeserializer)

Purpose:
Provide an implementation of OpenEdge.Messaging.IDeserializer that will be used to convert
the message content MEMPTR to a body value for a message.
Parameters:
deserializer OpenEdge.Messaging.IDeserializer
 
Returns OpenEdge.Messaging.TopicConfigurationBuilder
 
Top

OpenEdge.Messaging.TopicConfigurationBuilder SetBodyDeserializerCodePage (character)

Purpose:
Set the codepage used to deserialize memptr to a string based message body.
Parameters:
characterEncoding CHARACTER
 
Returns OpenEdge.Messaging.TopicConfigurationBuilder
 
Top

OpenEdge.Messaging.TopicConfigurationBuilder SetBodySerializer (character)

Purpose:
Provide the name of a class which must implement OpenEdge.Messaging.ISerializer.
An instance of this class will be created to convert the body values of messages
to MEMPTR.
Parameters:
bodySerializerClassName CHARACTER
 
Returns OpenEdge.Messaging.TopicConfigurationBuilder
 
Top

OpenEdge.Messaging.TopicConfigurationBuilder SetBodySerializer (ISerializer)

Purpose:
Provide an implementation of OpenEdge.Messaging.ISerializer that will be used to convert
the body values of messages to MEMPTR.
Parameters:
serializer OpenEdge.Messaging.ISerializer
 
Returns OpenEdge.Messaging.TopicConfigurationBuilder
 
Top

OpenEdge.Messaging.TopicConfigurationBuilder SetBodySerializerCodePage (character)

Purpose:
Set the codepage used to serialize string based message bodies.
Parameters:
characterEncoding CHARACTER
 
Returns OpenEdge.Messaging.TopicConfigurationBuilder
 
Top

OpenEdge.Messaging.TopicConfigurationBuilder SetTopicName (character)

Parameters:
topicName CHARACTER
 
Returns OpenEdge.Messaging.TopicConfigurationBuilder
 
Top

OpenEdge.Messaging.TopicConfigurationBuilder SetTopicOption (character, character)

Purpose:
Set a generic name=value pair that can be used to provide per-topic configuration.
It is up to the producer implementation to make use of the values to provide
per topic configuration to the implementation.
Parameters:
name CHARACTER
  The name of the topic option to store.
val CHARACTER
  The value of the topic option to store.
Returns OpenEdge.Messaging.TopicConfigurationBuilder
  This topic config builder. If name is specified as unknown or is empty, return ?