Namespace: OpenEdge.Messaging
Type: Interface ITopicConfiguration
Parent Classes:
Inherits: Progress.Lang.Object

/*
Copyright © 2021 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
/*
The topic configuration stores name=value pairs that are to be passed
to the producer or consumer messaging client. The messaging client expected to
consume this configuration information to provide per-topic configuration that may be different
from the default configured for a messaging client. For example,
the StringSerializer will attempt to use the string encoding
option specific to the topic, before falling back to using
the producer's encoding option.



Method Summary
  Options Name Purpose
  Progress.Lang.Object GetOption (character) /** Retrieve a topic configuration value by its option name. @param name The name of the option. @return the value of the option. */
  CHARACTER GetOptionNames () /** Returns an array of the option names that have been configured for this topic. @return The names of all the option values that have been stored. */
  LOGICAL HasOption (character) /** Returns true if the topic option has been set. @param name The name of the option. @return True if an option with the given name has been set. */

Property Summary
  Options Name Purpose
  OpenEdge.Messaging.IDeserializer BodyDeserializer
  OpenEdge.Messaging.ISerializer BodySerializer
  CHARACTER TopicName


Method Detail
Top

Progress.Lang.Object GetOption (character)

Purpose:
Retrieve a topic configuration value by its option name.
Parameters:
name CHARACTER
  The name of the option.
Returns Progress.Lang.Object
  the value of the option.
Top

CHARACTER GetOptionNames ()

Purpose:
Returns an array of the option names that have been configured for this topic.
Returns CHARACTER
  The names of all the option values that have been stored.
Top

LOGICAL HasOption (character)

Purpose:
Returns true if the topic option has been set.
Parameters:
name CHARACTER
  The name of the option.
Returns LOGICAL
  True if an option with the given name has been set.


Property Detail
Top

OpenEdge.Messaging.IDeserializer BodyDeserializer

Returns OpenEdge.Messaging.IDeserializer
 
Top

OpenEdge.Messaging.ISerializer BodySerializer

Returns OpenEdge.Messaging.ISerializer
 
Top

CHARACTER TopicName

Returns CHARACTER