This topic type will be removed in a future release
@Deprecated public interface ChildListTopicDetails extends TopicDetails
Child List
topic.
This topic type automatically maintains a list of its child topics.
The topic state (the value returned when a client subscribes or requests a
snapshot of the topic) will be maintained as a Record.FIELD_DELIMITER
list of fields containing the node names of all child topics.
Content received may be read using a RecordContentReader
.
Content of type UpdateType.SNAPSHOT
will be delivered when a client
subscribes to or fetches such a topic.
When a new child topic is added, content of type UpdateType.DELTA
with a single header of CHILD_ADDED
and a value of the child node
name will be delivered.
When a child topic is removed, content of type UpdateType.DELTA
with
a single header of CHILD_REMOVED
and a value of the child node name
will be delivered.
Note that when a topic is removed causing all of its descendants to also be removed then there will only be notifications sent out for the parent of the top level topic removed.
At this release of the Unified API it is possible to create such topics for use by Classic API clients. However, Unified API clients cannot yet be consumers of such topics and only the content will be delivered and not the header values.
The easiest way to create an instance of such details is using
TopicControl.newDetails(TopicType)
, for example:
TopicControl control = session.feature(TopicControl.class);
TopicDetails details = control.newDetails(TopicType.CHILD_LIST);
Alternatively the details can be created using a builder obtained as follows:
ChildListTopicDetails.Builder builder = control.newDetailsBuilder(ChildListTopicDetails.Builder.class);
Modifier and Type | Interface and Description |
---|---|
static interface |
ChildListTopicDetails.Attributes
Deprecated.
Child List topic details attributes.
|
static interface |
ChildListTopicDetails.Builder
Deprecated.
Builder for Child List topic details.
|
static interface |
ChildListTopicDetails.Schema
Deprecated.
Child List topic details schema.
|
TopicDetails.Level
Modifier and Type | Field and Description |
---|---|
static String |
CHILD_ADDED
Deprecated.
Header value used in delta messages to indicate that a new child topic
has been added.
|
static String |
CHILD_REMOVED
Deprecated.
Header value used in delta messages to indicate that a child topic has
been removed.
|
Modifier and Type | Method and Description |
---|---|
ChildListTopicDetails.Builder |
newBuilder()
Deprecated.
Returns a new builder initialized with the values from these details.
|
getAttributes, getLevel, getSchema, getType
static final String CHILD_ADDED
static final String CHILD_REMOVED
ChildListTopicDetails.Builder newBuilder()
Copyright © 2016 Push Technology Ltd. All Rights Reserved.