public enum TopicProperty extends Enum<TopicProperty>
TopicDefinition
s.Enum Constant and Description |
---|
ALIASING
Deprecated.
since 5.5 this property no longer has any effect. Aliasing
will be determined by publisher settings.
|
ATTACHMENT
This property defines the topic attachment.
|
ATTACHMENT_CLASS
This property defines the a Topic attachment class.
|
AUTO_SUBSCRIBE
Deprecated.
since 5.5, auto-subscription is always enabled
|
CUSTOM_HANDLER
Specifies a Custom Topic Handler.
|
CUSTOM_HANDLER_CLASS
Specifies a Custom Topic Handler.
|
DATA_INITIALISER
Specifies a Topic Data Initialiser.
|
DATA_INITIALISER_CLASS
Specifies a Topic Data Initialiser class.
|
DELTA_ACK_REQUIRED
Specifies that delta messages require acknowledgment.
|
DELTA_ENCODING
Delta Encoding.
|
DELTA_MESSAGE_CAPACITY
Specifies the default delta message capacity.
|
INTROSPECTION_MASK
Introspection mask.
|
LOAD_ACK_REQUIRED
Specifies that load messages require acknowledgment.
|
LOAD_ENCODING
Load Encoding.
|
LOAD_HEADERS
Specifies headers to be associated with load messages.
|
LOAD_MESSAGE_CAPACITY
Specifies the default load message capacity.
|
LOCK_TIMEOUT
Deprecated.
since 5.6. All API topic locking methods are deprecated and
will be removed in a future release, see
Topic.lock()
for details. |
LOCKABLE
Deprecated.
since 5.6
The lock API was deprecated in 5.6, see |
NOTIFY_ALL_TOPICS
Specifies whether a Topic Notify Topic notifies all Topics or only those
owned by the same Publisher as the notifier.
|
NOTIFY_METADATA_CACHING
Specifies whether a Topic Notify Topic supports metadata caching.
|
PAGED_COMPARATOR
Specifies a Paged Topic Comparator.
|
PAGED_COMPARATOR_CLASS
Specifies a Paged Topic Comparator class.
|
PAGED_DUPLICATES_POLICY
Specifies Paged Topic Data Duplicates Policy.
|
PB_CLASS
Specifies a Protocol Buffer proto class name.
|
PB_DELETION_VALUE
Specifies the Protocol Buffers Topic Data Deletion Value.
|
PB_NAME
Specifies a Protocol Buffers Message name.
|
PB_UPDATE_MODE
Specifies the Protocol Buffers Topic Data Update Mode.
|
RECORD_EMPTY_FIELD_VALUE
Specifies a value to use to represent empty fields.
|
REFERENCE
This specifies the Topic reference.
|
ROUTING_HANDLER
Specifies a Routing Topic Subscription Handler.
|
ROUTING_HANDLER_CLASS
Specifies a Routing Topic Subscription Handler.
|
SERVICE_HANDLER
Specifies a Service handler.
|
SERVICE_HANDLER_CLASS
Specifies a Service handler.
|
SERVICE_HEADERS
Specifies service header options.
|
SERVICE_TARGET_TOPIC
Specifies a service target topic name.
|
SERVICE_TIMEOUT
Specifies a service request timeout.
|
SERVICE_TYPE
Specifies Service Type.
|
SLAVE_MASTER_TOPIC
Specifies the master Topic name for a Slave Topic.
|
SUBSCRIPTION_HANDLER
Deprecated.
since 5.5. Consider using routing topics instead.
|
SUBSCRIPTION_HANDLER_CLASS
Deprecated.
since 5.5. Consider using routing topics instead.
|
TIDY_ON_UNSUBSCRIBE
Tidy on Unsubscribe.
|
Modifier and Type | Method and Description |
---|---|
static TopicProperty |
fromKey(String key)
Returns TopicProperty enum from key representation.
|
String |
getKey()
Returns the property key value.
|
static String |
toListValue(List<String> entries)
Converts a list of Strings to a suitable format for a list type property
|
static String |
toListValue(String... entries)
Converts a list of Strings to a suitable format for a list type property
|
static TopicProperty |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static TopicProperty[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
@Deprecated public static final TopicProperty LOCKABLE
The lock API was deprecated in 5.6, see Topic.lock()
for details. From 5.9, all topics are lockable and this
property has no effect.
public static final TopicProperty ATTACHMENT
This is an optional Object to be attached to the topic.
See Topic.attach(Object)
for details.
public static final TopicProperty ATTACHMENT_CLASS
This is an optional String property specifying a full class name.
If specified then the no arguments constructor of the class will be used to create an instance of the class and attach it to the topic.
This property would be ignored if ATTACHMENT
is specified.
See Topic.attach(Object)
for details.
public static final TopicProperty REFERENCE
This is an optional String property.
See Topic.setReference(String)
for details.
@Deprecated public static final TopicProperty SUBSCRIPTION_HANDLER
This is an optional Object property where the Object must be of type
TopicSubscriptionHandler
.
If specified then the subscription handler will be attached to the topic on creation.
@Deprecated public static final TopicProperty SUBSCRIPTION_HANDLER_CLASS
This is an optional String property specifying the full name of a
loadable class of type TopicSubscriptionHandler
.
If specified then the class must have a no arguments constructor which will be used to create and associate the handler object when the topic is created.
This is ignored if SUBSCRIPTION_HANDLER
is specified.
public static final TopicProperty LOAD_MESSAGE_CAPACITY
This is an optional Integer property.
See Topic.setDefaultLoadMessageCapacity(int)
for details.
public static final TopicProperty DELTA_MESSAGE_CAPACITY
This is an optional Integer property.
See Topic.setDefaultDeltaMessageCapacity(int)
for details.
public static final TopicProperty INTROSPECTION_MASK
This is optional Byte property.
See Topic.setIntrospectionMask(byte)
for details.
@Deprecated public static final TopicProperty LOCK_TIMEOUT
Topic.lock()
for details.This is an optional Long property.
See Topic.setLockTimeout(long)
for details.
public static final TopicProperty TIDY_ON_UNSUBSCRIBE
This is optional Boolean property.
See Topic.setTidyOnUnsubscribe(boolean)
for details.
@Deprecated public static final TopicProperty AUTO_SUBSCRIBE
This is an optional boolean property.
@Deprecated public static final TopicProperty ALIASING
public static final TopicProperty LOAD_ENCODING
This is an optional Byte property. The value must be one of the
Encoding.byteValue()
values.
See
TopicData.setLoadEncoding(Encoding)
for details.
public static final TopicProperty DELTA_ENCODING
This is an optional Byte value. The value must be on of the
Encoding.byteValue()
values.
See
TopicData.setLoadEncoding(Encoding)
for details.
public static final TopicProperty DATA_INITIALISER
This is used with Topics of type
PublishingTopicData
but
would be ignored for all other types.
This is an Object property of type
TopicDataInitialiser
.
This is ignored if DATA_INITIALISER
is specified.
See
PublishingTopicData.setInitialiser(TopicDataInitialiser)
for details.
public static final TopicProperty DATA_INITIALISER_CLASS
This is used with Topics of type
PublishingTopicData
but
would be ignored for all other types.
This is a String property specifying a loadable class of type
TopicDataInitialiser
which
must have a no arguments constructor which will be used to create an
instance of the handler when the Topic is created.
This is ignored if DATA_INITIALISER
is specified.
See
PublishingTopicData.setInitialiser(TopicDataInitialiser)
for details.
public static final TopicProperty LOAD_HEADERS
This is an optional String property that only applies to Topics that have
data of type
PublishingTopicData
.
It is specified as list value as generated by toListValue(java.util.List<java.lang.String>)
.
See
PublishingTopicData.setLoadHeaders(String...)
for details.
public static final TopicProperty LOAD_ACK_REQUIRED
This is an optional Boolean property that only applies to Topics that
have data of type
PublishingTopicData
.
See
PublishingTopicData.setLoadAckRequired(boolean)
for details.
public static final TopicProperty DELTA_ACK_REQUIRED
This is an optional Boolean property that only applies to Topics that
have data of type
PublishingTopicData
.
See
PublishingTopicData.setDeltaAckRequired(boolean)
for details.
public static final TopicProperty PAGED_COMPARATOR
This may optionally be used with Topics of type
TopicDataType.PAGED_RECORD
or
TopicDataType.PAGED_STRING
but would be ignored for all other types.
It is an Object property where the object must be of type
Comparator
with a generic type of either
Record
or
String
depending on Topic Data type.
If a comparator is specified then the Topic Data will be ordered using the comparator.
See
TopicDataFactory.newPagedRecordData(MRecord, Comparator)
or
TopicDataFactory.newPagedStringData(Comparator)
for details.
public static final TopicProperty PAGED_COMPARATOR_CLASS
This may optionally be used with Topics of type
TopicDataType.PAGED_RECORD
or
TopicDataType.PAGED_STRING
but would be ignored for all other types.
This is a String property specifying a loadable class of type
Comparator
which must have a no arguments constructor which will
be used to create an instance of the handler when the Topic is created.
The comparator should have a generic type of either
Record
or
String
depending on Topic Data type.
This is ignored if PAGED_COMPARATOR
is specified.
If a comparator is specified then the Topic Data will be ordered using the comparator.
See
TopicDataFactory.newPagedRecordData(MRecord, Comparator)
or
TopicDataFactory.newPagedStringData(Comparator)
for details.
public static final TopicProperty PAGED_DUPLICATES_POLICY
This is an optional property that only has meaning for Topics that have
data of type
TopicDataType.PAGED_RECORD
or
TopicDataType.PAGED_STRING
.
It is ignored for all other types.
It is a String property that may be one of the update mode code values as
obtained from
PagedTopicData.Duplicates.getCode()
.
If not specified then
PagedTopicData.Duplicates.NOT_ALLOWED
is assumed.
See
PagedTopicData.setDuplicatesPolicy(Duplicates)
for more details.
public static final TopicProperty PB_CLASS
This is a String property that that is mandatory for Topics that have
data of type
TopicDataType.PROTOCOL_BUFFER
. It is ignored for all other types.
See
TopicDataFactory.newPBData(String, String)
for details.
public static final TopicProperty PB_NAME
This is a String property that is mandatory for Topics that have data of
type
TopicDataType.PROTOCOL_BUFFER
. It is ignored for all other types.
See
TopicDataFactory.newPBData(String, String)
for details.
public static final TopicProperty PB_UPDATE_MODE
This is an optional property that only has meaning for Topics that have
data of type
TopicDataType.PROTOCOL_BUFFER
. It is ignored for all other types.
It is a String property that may be one of the update mode code values as
obtained from
PBTopicData.UpdateMode.getCode()
.
If not specified then
PBTopicData.UpdateMode.PARTIAL
is assumed.
See
PBTopicData.setUpdateMode(UpdateMode)
for more details.
public static final TopicProperty PB_DELETION_VALUE
This is an optional property that only has meaning for Topics that have
data of type
TopicDataType.PROTOCOL_BUFFER
. It is ignored for all other types.
It is a String property that specifies a value used to represent field deletions.
If not specified then
PBTopicData.DEFAULT_DELETION_VALUE
is assumed.
See
PBTopicData.setDeletionValue(String)
for more details.
public static final TopicProperty CUSTOM_HANDLER
This is used with Topics of type
TopicDataType.CUSTOM
but
would be ignored for all other types.
It is an Object property where the object must be of type
CustomTopicDataHandler
.
To create a Topic of type
TopicDataType.CUSTOM
either
this property or CUSTOM_HANDLER_CLASS
must be supplied.
See
TopicDataFactory.newCustomData(CustomTopicDataHandler)
for details.
public static final TopicProperty CUSTOM_HANDLER_CLASS
This is used with Topics of type
TopicDataType.CUSTOM
but
would be ignored for all other types.
This is a String property specifying a loadable class of type
CustomTopicDataHandler
which must have a no arguments constructor which will be used to create
an instance of the handler when the Topic is created.
This is ignored if CUSTOM_HANDLER
is specified.
To create a Topic of type
TopicDataType.CUSTOM
either
this property or CUSTOM_HANDLER
must be supplied.
See
TopicDataFactory.newCustomData(CustomTopicDataHandler)
for details.
public static final TopicProperty RECORD_EMPTY_FIELD_VALUE
This is an optional String property for use with Topics of type
TopicDataType.RECORD
and
would be ignored for all other types.
See
RecordTopicData.setEmptyFieldValue(String)
for details.
public static final TopicProperty SERVICE_TYPE
This is a mandatory String property for Topics of type
TopicDataType.SERVICE
and
is ignored for all other types.
See
TopicDataFactory.newServiceData(String, ServiceHandler)
for details.
public static final TopicProperty SERVICE_HANDLER
This is an Object property which only applies to Topics of type
TopicDataType.SERVICE
and
would be ignored for all other types. The object specified must be of
type ServiceHandler
.
To create a Topic of type
TopicDataType.SERVICE
either this property or SERVICE_HANDLER
must be supplied.
See
TopicDataFactory.newServiceData(String, ServiceHandler)
for details.
public static final TopicProperty SERVICE_HANDLER_CLASS
This is a String property which only applies to Topics of type
TopicDataType.SERVICE
and
would be ignored for all other types. It specifies a loadable class of
type ServiceHandler
which must have a no arguments constructor which will be used to create
an instance of the handler to attach to the Topic.
This is ignored is SERVICE_HANDLER
is specified.
To create a Topic of type
TopicDataType.SERVICE
either this property or SERVICE_HANDLER
must be supplied.
See
TopicDataFactory.newServiceData(String, ServiceHandler)
for details.
public static final TopicProperty SERVICE_TIMEOUT
This is an optional Long property only applies for Topics of type
TopicDataType.SERVICE
and
would be ignored for all other types.
See
ServiceTopicData.setRequestTimeout(long)
for details.
public static final TopicProperty SERVICE_TARGET_TOPIC
This is an optional String property that only applies to Topics of type
TopicDataType.SERVICE
and
would be ignored for all other types.
See
ServiceTopicData.setTargetTopicName(String)
for details.
public static final TopicProperty SERVICE_HEADERS
This is an optional String property that only applies for Topics of type
TopicDataType.SERVICE
and
would be ignored for all other types.
It is specified as list value as generated by toListValue(java.util.List<java.lang.String>)
. Each
value should be one of the code values of
ServiceHeader
.
See
ServiceTopicData.setHeaderOptions(ServiceHeader...)
for details.
public static final TopicProperty SLAVE_MASTER_TOPIC
This is a mandatory String property for topics of type
TopicDataType.SLAVE
and
will be ignored for all other types.
See
TopicDataFactory.newSlaveData(PublishingTopicData)
for details.
public static final TopicProperty ROUTING_HANDLER
This is an Object property used with Topics of type
TopicDataType.ROUTING
and
would be ignored for all other types. The object specified must be of
type
RoutingTopicDataSubscriptionHandler
.
To create a Topic of type
TopicDataType.ROUTING
either this property or ROUTING_HANDLER
must be supplied.
See
TopicDataFactory.newRoutingData(RoutingTopicDataSubscriptionHandler)
for details.
public static final TopicProperty ROUTING_HANDLER_CLASS
This is a String property used with Topics of type
TopicDataType.ROUTING
and
would be ignored for all other types. It specifies a loadable class of
type
RoutingTopicDataSubscriptionHandler
which must have a no arguments constructor which that be used to create
an instance of the handler to attach to the Topic.
This will be ignored if ROUTING_HANDLER
is specified.
To create a Topic of type
TopicDataType.ROUTING
either this property or ROUTING_HANDLER
must be supplied.
See
TopicDataFactory.newRoutingData(RoutingTopicDataSubscriptionHandler)
for details.
public static final TopicProperty NOTIFY_METADATA_CACHING
This is an Optional boolean property which applies only to Topics of type
TopicDataType.TOPIC_NOTIFY
.
See
TopicDataFactory.newTopicNotifyData(boolean)
for details.
public static final TopicProperty NOTIFY_ALL_TOPICS
This is an optional Boolean property which applies only to Topics of type
TopicDataType.TOPIC_NOTIFY
.
See
TopicNotifyTopicData.setNotifyAllTopics(boolean)
for details.
public static TopicProperty[] values()
for (TopicProperty c : TopicProperty.values()) System.out.println(c);
public static TopicProperty valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic static TopicProperty fromKey(String key)
key
- property key in either lower or upper casepublic String getKey()
public static String toListValue(List<String> entries)
entries
- the listMessage.LIST_DELIMITER
.public static String toListValue(String... entries)
entries
- the listMessage.LIST_DELIMITER
.Copyright © 2016 Push Technology Ltd. All Rights Reserved.