DiffusionTM Java API 5.9.4
A B C D E F G H I J K L M N O P Q R S T U V W X 

A

abort() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Sends an abort notification to the Client and then closes the connection.
abortUpdate() - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
This is called when PublishingTopicData.abortUpdate() is called.
abortUpdate() - Method in class com.pushtechnology.diffusion.api.data.custom.SimpleCustomTopicDataHandler
Deprecated.
 
abortUpdate() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Allows an update to be aborted.
AbstractCustomTopicDataHandler - Class in com.pushtechnology.diffusion.api.data.custom
Deprecated.
since 5.9

See CustomTopicData.

AbstractCustomTopicDataHandler() - Constructor for class com.pushtechnology.diffusion.api.data.custom.AbstractCustomTopicDataHandler
Deprecated.
 
ACCECPT_RANGES - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Accept-Ranges header
acknowledge(TopicMessage) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
acknowledge(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Acknowledges a message that is 'Pending Acknowledgement'.
acknowledge(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Acknowledges a Message that is 'Pending Acknowledgement'.
add(PagedTopicHandler, PageStatus, Lines) - Method in interface com.pushtechnology.diffusion.api.client.paging.PagedTopicListener
Deprecated.
Notifies lines added to the end of the current page.
add(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Adds data from a message.
add(Record) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Add a line to the data.
add(int, Record) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Add (insert) a line to the data at the specified index.
add(List<Record>) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Add one or more lines to the data.
add(int, List<Record>) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Add (insert) one or more lines to the data at the specified index.
add(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Add data from a message.
add(String) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Add a line to the data.
add(int, String) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Add (insert) a line to the data at the specified index.
add(List<String>) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Add one or more lines to the end of the data.
add(int, List<String>) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Add (insert) one or more lines to the data at the specified index.
addAddress(String) - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Add an address.
addChild(WhoIsData) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsData
Adds a child object.
addClient(TopicClient) - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Adds a client to the group.
addConnection(String) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConfig
Add a new connection to a primary server.
addConnectionValidationPolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Add a new connection validation policy for the connector.
addConnector(String) - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Add a connector.
addCustomField(String, Multiplicity, CustomFieldHandler) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Adds a new child field with custom data type.
addCustomField(String, Multiplicity, String) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Adds a new child field with custom data type.
addDirectory(String) - Method in interface com.pushtechnology.diffusion.api.config.UserLibrariesConfig
Add a user directory.
addEventListener(ServerEventListener) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Add a single threaded event listener to receive all event notifications.
addEventListener(ServerEventListener, int) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Add a single threaded event listener to receive selected event notifications.
addEventListener(ServerEventListener, ThreadPool, int) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Add an event listener.
addField(String) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Adds a new child field with default multiplicity and data type.
addField(String, Multiplicity) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Adds a new child field with default data type.
addField(String, MDataType) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Adds a new child field with default multiplicity.
addField(String, MDataType, Multiplicity) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Adds a new child field.
addField(String, Multiplicity, CustomFieldHandler) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
addField(int, String) - Method in class com.pushtechnology.diffusion.api.message.Record
Inserts a field at a specified index within the record, moving subsequent fields along the record.
addFields(String...) - Method in class com.pushtechnology.diffusion.api.message.Record
Adds one or more fields to the end of the record.
addFields(Collection<?>) - Method in class com.pushtechnology.diffusion.api.message.Record
Adds one or more fields to the end of the record.
addHandler(Handler) - Static method in class com.pushtechnology.diffusion.api.Logs
Adds a log handler to the root logger which is the parent of all logs.
addHandler(Handler) - Method in interface com.pushtechnology.diffusion.api.LogWriter
Add a log handler.
addHostName(String) - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Add a host name.
addHTTPService(String, String, String) - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Add an HTTP Service.
addIgnoreErrorsFrom(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Add an IP address to ignore errors from.
addLifecycleListener(EmbeddedDiffusion.LifecycleListener) - Method in class com.pushtechnology.diffusion.api.server.DiffusionServer
 
addLifecycleListener(EmbeddedDiffusion.LifecycleListener) - Method in interface com.pushtechnology.diffusion.api.server.EmbeddedDiffusion
Register for lifecycle events.
addLink(String) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Adds a topic tree link to be replicated.
addListener(TopicDataListener) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Adds a (@link TopicDataListener listener} for changes to the topic data.
addLocale(String, String) - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Adds a Locale to the policy.
addLog(String) - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Add a new log definition.
addMime(String, String) - Method in interface com.pushtechnology.diffusion.api.config.MimesConfig
Add a mime.
addMultiplexer(String) - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Add a new multiplexer configuration.
addPolicy(String, ConflationPolicyConfig.Mode) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Add a Conflation Policy which uses the default Message Matcher and no Message Merger.
addPolicy(String, ConflationPolicyConfig.Mode, MessageMerger) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Add a Conflation Policy which uses the default Message Matcher and a specified Message Merger.
addPolicy(String, ConflationPolicyConfig.Mode, String, String) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Adds a conflation policy
addPolicy(String, ConflationPolicyConfig.Mode, MessageMatcher, MessageMerger) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Adds a conflation policy.
addPool(String, int) - Method in interface com.pushtechnology.diffusion.api.config.SelectorThreadPoolsConfig
Add a selector thread pool to the set of those available.
addPool(String) - Method in interface com.pushtechnology.diffusion.api.config.ThreadsConfig
Add a new thread pool definition.
addProperty(String, String) - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Add a service property.
addProperty(String, String, String) - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Add a service property.
addProperty(String, String) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Add a publisher property.
addProperty(String, String, String) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Add a publisher property.
addPublisher(String, String) - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Adds a new Publisher to the list of configured Publishers.
addQueue(String) - Method in interface com.pushtechnology.diffusion.api.config.QueuesConfig
Add a queue definition.
addQueueMessageFilter(String, MessageFilter) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Adds a Message Filter to be applied to Messages being queued for the Client.
addRealm(String, String) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Add a realm.
addRecord(String) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Adds a new child record with default multiplicity.
addRecord(String, Multiplicity) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Adds a new child record.
addRemoteServer(String, String, int) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Deprecated.
addReporter(String, ReporterConfig.Type) - Method in interface com.pushtechnology.diffusion.api.config.StatisticsConfig
Add a new Reporter to the statistics config.
addResolvedName(String) - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Add a resolved name.
addServerConnection(String, String, int) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Deprecated.
addServerConnection(String, ServerDetails) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Deprecated.
addSubscriptionValidationPolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Add a new subscription validation policy for the publisher.
addTopic(String) - Method in interface com.pushtechnology.diffusion.api.config.SubscriptionValidationPolicyConfig
Add a named topic (or Topic pattern) to map to this policy.
addTopic(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
addTopic(String, TopicTreeNode) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
addTopic(String, TopicDefinition) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
addTopic(String, TopicTreeNode, TopicDefinition) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
addTopic(String, TopicData) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
addTopic(String, TopicTreeNode, TopicData) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
addTopic(String) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Add a Topic to this Topic.
addTopic(String, TopicData) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Add a Topic to this Topic.
addTopic(String, TopicDefinition) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Add a Topic to this Topic.
addTopic(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Add a Topic to the root of the Topic tree.
addTopic(String, TopicTreeNode) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Adds a Topic to a specified parent Topic.
addTopic(String, TopicDefinition) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Add a Topic to the root of the Topic tree.
addTopic(String, TopicTreeNode, TopicDefinition) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Adds a Topic to a specified parent Topic.
addTopic(String, TopicData) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Add a Topic to the root of the Topic tree.
addTopic(String, TopicTreeNode, TopicData) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Adds a Topic to a specified parent Topic.
addTopicDeletionListener(TopicDeletionListener) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTree
Adds a listener for Topic deletions.
addTopicListener(TopicListener, String...) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
addTopicListener(TopicListener, TopicSet) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
addTopicListener(TopicListener, MessageSourceType, String...) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
addTopicListener(TopicListener, MessageSourceType, TopicSet) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
addTopicListener(TopicListener, TopicSet) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
addTopicListener(TopicListener, String...) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
addTopicLoader(TopicLoader, String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
addTopicLoader(TopicLoader, String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Adds a new Topic Loader.
addTopics(TopicSet, TopicTreeNode) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
addTopics(TopicSet) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
addTopics(TopicSet, TopicTreeNode) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Add a set of Topics to a specified parent node.
addTopics(TopicSet) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Add a set of Topics.
addTopicTreeListener(TopicTreeListener) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTree
Add a listener for Topic events.
addUser(String) - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Deprecated.
Remote JMX users should be configured in the system authentication store, or with a custom authentication handler.
addUser(String, String) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostRealmConfig
Add a realm user.
addValues(Map<String, String>) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsData
Adds values to the object from a given map of values.
addVirtualHost(String, String, String, String) - Method in interface com.pushtechnology.diffusion.api.config.FileServiceConfig
Add a new virtual host configuration.
addWebServer(String) - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Add a new Web Server Configuration.
allowsEmpty() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MField
Indicates whether the field allows an empty value when parsed from String input.
APIException - Exception in com.pushtechnology.diffusion.api
This is the base exception class for all Diffusion API exceptions.
APIException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.api.APIException
Create a new APIException.
APIException(String) - Constructor for exception com.pushtechnology.diffusion.api.APIException
Create a new APIException.
APIProperties - Class in com.pushtechnology.diffusion.api
Deprecated.
this class has been deprecated and will be removed at a later release. All of the methods have alternatives - see individual methods for details
appendToField(String, Object...) - Method in class com.pushtechnology.diffusion.api.message.Record
Appends one or more values to a repeating field.
appendToField(String, Collection<?>) - Method in class com.pushtechnology.diffusion.api.message.Record
Appends one or more values to a repeating field.
appliesToTopic(String) - Method in interface com.pushtechnology.diffusion.api.config.SubscriptionValidationPolicyConfig
Does this policy apply to a given topic name?
areEqual(Object, Object) - Method in interface com.pushtechnology.diffusion.api.data.metadata.CustomFieldHandler
Compares two objects for equality assuming that they are already of the internal value of this data type (i.e parsed).
asByteBuffer() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns the whole message data content as a newly allocated ByteBuffer.
asBytes() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns the whole message as a new byte array.
asDate(XMLGregorianCalendar) - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Converts an XMLGregorianCalendar to an instance of java.util.Date.
asFields() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns the whole message body as fields.
asRecords() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns the whole message body as records.
asRecords(MRecord) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns the whole message body as records.
asString() - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
Renders the current state of the data as a String.
asString() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Renders the state of the data as a String.
asString() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns the whole message body as a String.
asXMLGregorianCalendar(Date) - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Converts a java.util.Date into an instance of XMLGregorianCalendar.
attach(Object) - Method in class com.pushtechnology.diffusion.api.Credentials
Attaches the given object to the Credentials.
attach(Object) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Attaches the given object to this Topic.
attach(Object) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Attaches the given object to the client.
AttachableTopicMessage - Interface in com.pushtechnology.diffusion.api.message
This is the interface of a TopicMessage that has an attachment.
attachment() - Method in class com.pushtechnology.diffusion.api.Credentials
Retrieves the current attachment.
attachment() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Retrieves the current attachment.
attachment() - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Retrieves the current attachment.
AuthenticationHandlerConfig - Interface in com.pushtechnology.diffusion.api.config
An authentication handler.
AuthorisationException - Exception in com.pushtechnology.diffusion.api
This indicates that the server has not authorised a connection.
AuthorisationException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.api.AuthorisationException
Create a new AuthorisationException.
AuthorisationException(String) - Constructor for exception com.pushtechnology.diffusion.api.AuthorisationException
Create a new AuthorisationException.
AuthorisationHandler - Interface in com.pushtechnology.diffusion.api.publisher
This is the interface for the handler to authorization related events.
AutoDeploymentConfig - Interface in com.pushtechnology.diffusion.api.config
Auto Deployment Configuration Details.
available() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Indicates the free space available for writing to in bytes.

B

base64Decode(String) - Static method in class com.pushtechnology.diffusion.api.Utils
Decodes a Base 64 encoded string
base64Encode(String) - Static method in class com.pushtechnology.diffusion.api.Utils
Encodes a String in Base64 notation
boostrap(ServerThreadPools) - Static method in class com.pushtechnology.diffusion.api.topic.TopicSelector
 
bootstrap(ServerConfig) - Static method in class com.pushtechnology.diffusion.api.config.ConfigManager
 
bootstrap(ApplicationContainer, InternalTopicDataFactory) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
 
bootstrap(ManagementService) - Static method in class com.pushtechnology.diffusion.api.management.Management
Deprecated.
 
bootstrap(PublisherTopicTree, ClientSessions, ServerConfig, PublisherManager, AuthorisationManager, ServerEventManager) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
 
bootstrap(Scheduler) - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
 
bootstrap(ClassLoader) - Static method in class com.pushtechnology.diffusion.api.Utils
 
bootstrap(GeoIPManager) - Static method in class com.pushtechnology.diffusion.api.whois.GeoIPUtils
 
byteBufferToAscii(ByteBuffer) - Static method in class com.pushtechnology.diffusion.api.Utils
Converts the ByteBuffer in the default Character set for diagnostic purposes from the current buffer position
byteBufferToAscii(ByteBuffer, int) - Static method in class com.pushtechnology.diffusion.api.Utils
Converts the ByteBuffer in the default Character set for diagnostic purposes from the current buffer position, up to a limit
byteBufferToHex(ByteBuffer) - Static method in class com.pushtechnology.diffusion.api.Utils
Converts the contents of a ByteBuffer to a Hexadecimal String for diagnostic purposes.
byteBufferToHex(ByteBuffer, int) - Static method in class com.pushtechnology.diffusion.api.Utils
Converts part of a ByteBuffer to a Hexadecimal String representation for diagnostic purposes.
byteNumberConverter(String) - Static method in class com.pushtechnology.diffusion.api.Utils
Converts a size into bytes.
bytesToHex(byte[], int, int) - Static method in class com.pushtechnology.diffusion.api.Utils
Converts all or part of a byte array to hexadecimal representation for diagnostic purposes.
bytesToHex(byte[]) - Static method in class com.pushtechnology.diffusion.api.Utils
Converts all or part of a byte array to hexadecimal representation for diagnostic purposes.
byteValue() - Method in enum com.pushtechnology.diffusion.api.message.Encoding
Returns the encoding byte value.

C

CACHE_CONTROL - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Cache-Control header
CachedTopicLoader - Class in com.pushtechnology.diffusion.api.topic
This provides a simple implementation of a cached Topic loader.
CachedTopicLoader() - Constructor for class com.pushtechnology.diffusion.api.topic.CachedTopicLoader
 
cachesMetadata() - Method in interface com.pushtechnology.diffusion.api.data.notify.TopicNotifyTopicData
Deprecated.
Indicates whether the Topic Data is supporting metadata caching.
cancel() - Method in interface com.pushtechnology.diffusion.api.threads.Schedule
Cancel the schedule.
canConnect(Client) - Method in interface com.pushtechnology.diffusion.api.publisher.AuthorisationHandler
Deprecated.
since 5.2

Use an authentication handler in preference. This method is still invoked for backwards compatibility, and can veto attempts to connect false. This method will be removed in a future release.

canConnect(ConnectionValidationPolicyConfig) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Performs tests to check to see if the client is valid for the specified policy
canFetch(Client, TopicSelector) - Method in interface com.pushtechnology.diffusion.api.publisher.AuthorisationHandler
Checks whether a given Client is allowed to fetch using a specified Topic Selector.
canFetch(Client, Topic) - Method in interface com.pushtechnology.diffusion.api.publisher.AuthorisationHandler
Checks whether a given client is allowed to fetch the current state of a specified Topic, even when not subscribed.
canSubscribe(Client, TopicSelector) - Method in interface com.pushtechnology.diffusion.api.publisher.AuthorisationHandler
Checks whether a given Client is allowed to subscribe using a specified Topic Selector.
canSubscribe(Client, Topic) - Method in interface com.pushtechnology.diffusion.api.publisher.AuthorisationHandler
Deprecated.
since 5.9

This method is deprecated and will be removed in a future release.

This method is called frequently from performance sensitive code. When a new topic is added is added, this method will be called for all existing Clients. Implementations must be heavily optimized to avoid severely degrading server performance. Blocking I/O, allocation, use of locks, and computationally expensive operations should be avoided.

Prefer Diffusion's declarative role-based security.

canSubscribe(SubscriptionValidationPolicyConfig, Topic) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Indicates whether he client is allowed to subscribe to a given topic according to a given subscription validation policy.
canWrite(Client, Topic) - Method in interface com.pushtechnology.diffusion.api.publisher.AuthorisationHandler
Checks whether a given Client is allowed to send Messages to a specified Topic.
CHILD_ADDED - Static variable in interface com.pushtechnology.diffusion.api.data.ChildListTopicData
Deprecated.
Header value used in delta messages to indicate that a new child topic has been added.
CHILD_REMOVED - Static variable in interface com.pushtechnology.diffusion.api.data.ChildListTopicData
Deprecated.
Header value used in delta messages to indicate that a child topic has been removed.
childCount() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Returns the number of child nodes defined.
ChildListTopicData - Interface in com.pushtechnology.diffusion.api.data
Deprecated.
since 5.9

This topic type will be removed in a future release

childNodes() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Returns a list of the children of the record.
children() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsData
Returns the list of child objects.
children(String) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsData
Returns a list of child objects whose type starts with a specified prefix.
clear() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPCache
Clear the cache
Client - Interface in com.pushtechnology.diffusion.api.publisher
A Client represents a client connection to the Diffusion Server.
ClientAckListener - Interface in com.pushtechnology.diffusion.api.topic
A listener for the outcome of messages sent to Clients requiring acknowledgement.
clientClosed(Client) - Method in interface com.pushtechnology.diffusion.api.publisher.ClientListener
This is called when a client connection is closed.
clientClosed(Client) - Method in class com.pushtechnology.diffusion.api.publisher.DefaultClientListener
 
ClientCloseReason - Enum in com.pushtechnology.diffusion.api.publisher
This describes the reason that a client has been closed.
ClientConfig - Interface in com.pushtechnology.diffusion.api.config
Client Configuration.
clientConnected(Client) - Method in interface com.pushtechnology.diffusion.api.publisher.ClientListener
This is called when a new client is connected.
clientConnected(Client) - Method in class com.pushtechnology.diffusion.api.publisher.DefaultClientListener
 
ClientConnection - Interface in com.pushtechnology.diffusion.api
A client connection.
clientCredentials(Client, Credentials) - Method in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Notifies that a Client has sent new credentials.
clientCredentials(Client, Credentials) - Method in class com.pushtechnology.diffusion.api.publisher.DefaultClientListener
 
clientFetchInvalid(Client, String, List<String>) - Method in interface com.pushtechnology.diffusion.api.publisher.ClientListener
This is called when a client attempts to fetch a topic that does not exist.
clientFetchInvalid(Client, String, List<String>) - Method in class com.pushtechnology.diffusion.api.publisher.DefaultClientListener
 
ClientGroup - Interface in com.pushtechnology.diffusion.api.topic
A group of clients.
ClientListener - Interface in com.pushtechnology.diffusion.api.publisher
This is the interface for listeners to client related events.
ClientMultiplexer - Interface in com.pushtechnology.diffusion.api.publisher
Client Multiplexer.
ClientPingMessage - Interface in com.pushtechnology.diffusion.api.message
A 'Client Ping' message is a message that is sent from the server to a client and then reflected back to the server.
clientPingResponse(ClientConnection, ClientPingMessage) - Method in interface com.pushtechnology.diffusion.api.message.ClientPingResponseListener
This is called when a response to a 'ping' sent to a client is received.
clientPingResponse(ClientConnection, ClientPingMessage) - Method in class com.pushtechnology.diffusion.api.publisher.DefaultClientListener
 
ClientPingResponseListener - Interface in com.pushtechnology.diffusion.api.message
A listener for client ping responses.
clientQueueThresholdReached(Client, boolean, int) - Method in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Notifies an outbound message queue threshold has been reached.
clientQueueThresholdReached(Client, boolean, int) - Method in class com.pushtechnology.diffusion.api.publisher.DefaultClientListener
 
clientResolved(Client) - Method in interface com.pushtechnology.diffusion.api.publisher.ClientListener
This is called when a client's Internet address details have been resolved.
clientResolved(Client) - Method in class com.pushtechnology.diffusion.api.publisher.DefaultClientListener
 
clientSendInvalid(Client, TopicMessage) - Method in interface com.pushtechnology.diffusion.api.publisher.ClientListener
This is called when a client attempts to send a message to a topic that doesn't exist, or to which it is not currently subscribed.
clientSendInvalid(Client, TopicMessage) - Method in class com.pushtechnology.diffusion.api.publisher.DefaultClientListener
 
ClientServiceConfig - Interface in com.pushtechnology.diffusion.api.config
Web Server Client Service configuration.
ClientStatistics - Interface in com.pushtechnology.diffusion.api.statistics
Read-only statistics values for a given Client.
ClientStatisticsConfig - Interface in com.pushtechnology.diffusion.api.config
Client Statistics Configuration.
clientSubscriptionInvalid(Client, String) - Method in interface com.pushtechnology.diffusion.api.publisher.ClientListener
This is called when a client attempts to subscribe to a topic that does not exist.
clientSubscriptionInvalid(Client, String) - Method in class com.pushtechnology.diffusion.api.publisher.DefaultClientListener
 
clientSubscriptionRequest(TopicClient, RoutingTopicData) - Method in interface com.pushtechnology.diffusion.api.data.routing.RoutingTopicDataSubscriptionHandler
This is called when a Client attempts to subscribe to the Routing Topic.
clientSubscriptionRequest(TopicClient, Topic) - Method in interface com.pushtechnology.diffusion.api.topic.TopicSubscriptionHandler
Deprecated.
This is called before a client is actually subscribed to the Topic and it allows for additional validation or delegation of the authorisation to some asynchronous process.
ClientThrottler - Interface in com.pushtechnology.diffusion.api.publisher
A Client Throttler.
ClientThrottlerType - Enum in com.pushtechnology.diffusion.api.publisher
Specifies the type of a ClientThrottler.
close() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
close() - Method in interface com.pushtechnology.diffusion.api.client.paging.PagedTopicHandler
Deprecated.
Close the Topic.
close() - Method in interface com.pushtechnology.diffusion.api.ClientConnection
Close the client connection.
close(Closeable) - Static method in class com.pushtechnology.diffusion.api.IOUtils
Close a (@link Closeable} resource, catching and discarding any IOExceptions that may arise.
close() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Close client connection.
close() - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Closes the group, after which point it may no longer be used.
close() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequest
Close the request.
CLOSED - Static variable in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Client closed notification mask setting
closedState() - Method in enum com.pushtechnology.diffusion.api.ServerConnectionState
Deprecated.
Is this a closed state?
com.pushtechnology.diffusion.api - package com.pushtechnology.diffusion.api
The Diffusion API comprises a number of packages which provide access to different aspects of Diffusion.
com.pushtechnology.diffusion.api.client - package com.pushtechnology.diffusion.api.client
Diffusion External Client API.
com.pushtechnology.diffusion.api.client.notify - package com.pushtechnology.diffusion.api.client.notify
Provides the handler classes for dealing with messages from and to a Topic that has TopicNotifyTopicData
com.pushtechnology.diffusion.api.client.paging - package com.pushtechnology.diffusion.api.client.paging
Diffusion Paged Data API.
com.pushtechnology.diffusion.api.client.service - package com.pushtechnology.diffusion.api.client.service
 
com.pushtechnology.diffusion.api.config - package com.pushtechnology.diffusion.api.config
Diffusion Configuration API.
com.pushtechnology.diffusion.api.conflation - package com.pushtechnology.diffusion.api.conflation
 
com.pushtechnology.diffusion.api.connection - package com.pushtechnology.diffusion.api.connection
Diffusion Connection API.
com.pushtechnology.diffusion.api.data - package com.pushtechnology.diffusion.api.data
Diffusion Topic Data API.
com.pushtechnology.diffusion.api.data.custom - package com.pushtechnology.diffusion.api.data.custom
Diffusion Custom Topic Data API.
com.pushtechnology.diffusion.api.data.metadata - package com.pushtechnology.diffusion.api.data.metadata
Diffusion Metadata API.
com.pushtechnology.diffusion.api.data.notify - package com.pushtechnology.diffusion.api.data.notify
This package contains functional Topic data that provides for notifications to subscribed clients.
com.pushtechnology.diffusion.api.data.paging - package com.pushtechnology.diffusion.api.data.paging
Diffusion Paged Topic Data API.
com.pushtechnology.diffusion.api.data.pb - package com.pushtechnology.diffusion.api.data.pb
Diffusion Protocol Buffers Topic Data API.
com.pushtechnology.diffusion.api.data.record - package com.pushtechnology.diffusion.api.data.record
Diffusion Record Topic Data API.
com.pushtechnology.diffusion.api.data.routing - package com.pushtechnology.diffusion.api.data.routing
Diffusion Routing Topic Data API.
com.pushtechnology.diffusion.api.data.service - package com.pushtechnology.diffusion.api.data.service
Diffusion Service Topic Data API.
com.pushtechnology.diffusion.api.data.single - package com.pushtechnology.diffusion.api.data.single
Diffusion Single Value Topic Data API.
com.pushtechnology.diffusion.api.management - package com.pushtechnology.diffusion.api.management
Diffusion Management API.
com.pushtechnology.diffusion.api.message - package com.pushtechnology.diffusion.api.message
 
com.pushtechnology.diffusion.api.publisher - package com.pushtechnology.diffusion.api.publisher
Diffusion Internal Publisher API.
com.pushtechnology.diffusion.api.server - package com.pushtechnology.diffusion.api.server
Entry point.
com.pushtechnology.diffusion.api.statistics - package com.pushtechnology.diffusion.api.statistics
 
com.pushtechnology.diffusion.api.threads - package com.pushtechnology.diffusion.api.threads
Diffusion Threads and Concurrency API.
com.pushtechnology.diffusion.api.topic - package com.pushtechnology.diffusion.api.topic
Diffusion Topics API.
com.pushtechnology.diffusion.api.webserver - package com.pushtechnology.diffusion.api.webserver
Diffusion Web Server API.
com.pushtechnology.diffusion.api.whois - package com.pushtechnology.diffusion.api.whois
Diffusion WhoIs API.
CommandTopicData - Interface in com.pushtechnology.diffusion.api.data
Deprecated.
since 5.9

All command topics will be removed in a future release

Config - Interface in com.pushtechnology.diffusion.api.config
A configuration object.
ConfigException - Exception in com.pushtechnology.diffusion.api.config
Exception in Config setting.
ConfigException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.api.config.ConfigException
Create a new ConfigException.
ConfigException(String) - Constructor for exception com.pushtechnology.diffusion.api.config.ConfigException
Create a new ConfigException.
ConfigManager - Class in com.pushtechnology.diffusion.api.config
Configuration Manager
conflates() - Method in interface com.pushtechnology.diffusion.api.config.QueueConfig
Gets the value of the conflates property.
ConflationConfig - Interface in com.pushtechnology.diffusion.api.config
Conflation Configuration.
ConflationPolicyConfig - Interface in com.pushtechnology.diffusion.api.config
This is the configuration for a Conflation Policy.
ConflationPolicyConfig.Mode - Enum in com.pushtechnology.diffusion.api.config
Conflation Mode.
connect() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
connect(String...) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
connect(TopicSet) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
connect() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Connects to the server without subscribing to any topics.
connect(TopicSet) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Connects to the server.
connect(String...) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Connects to the server.
CONNECTED - Static variable in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Client connected notification mask setting
CONNECTION - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Connection header
ConnectionCategory - Enum in com.pushtechnology.diffusion.api
Identifies a Connection Category.
ConnectionDetails - Interface in com.pushtechnology.diffusion.api.connection
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

connectionDetailsAcquired(ServerConnection, ServerDetails) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetailsListener
Deprecated.
This will be called each time a ServerDetails object is selected for connection.
ConnectionDetailsListener - Interface in com.pushtechnology.diffusion.api.connection
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

ConnectionFactory - Class in com.pushtechnology.diffusion.api.connection
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

connectionSequenceExhausted(ServerConnection) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetailsListener
Deprecated.
This will be called when the complete list of ServerDetails have been exhausted.
ConnectionType - Interface in com.pushtechnology.diffusion.api
Provides details of a type of connection, typically a Client connection.
ConnectionValidationPolicyConfig - Interface in com.pushtechnology.diffusion.api.config
Connection Validation Policy Configuration.
ConnectorConfig - Interface in com.pushtechnology.diffusion.api.config
Connector Configuration.
ConnectorConfig.ClientApiType - Enum in com.pushtechnology.diffusion.api.config
Deprecated.
since 5.9

Classic clients are deprecated so this will be removed in a future release

ConnectorConfig.ProxyProtocol - Enum in com.pushtechnology.diffusion.api.config
The protocols allowed to connect to the connector.
ConnectorConfig.Type - Enum in com.pushtechnology.diffusion.api.config
Indicates the types of connection supported by a connector.
containsClient(TopicClient) - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Returns true if the client is contained within the group.
CONTENT_ENCODING - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Content-Encoding header
CONTENT_LENGTH - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Content-Length header
CONTENT_RANGE - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Content-Range header
CONTENT_TYPE - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Content-Type header
ControlAuthenticationHandlerConfig - Interface in com.pushtechnology.diffusion.api.config
A control authentication handler.
convertInputStreamToString(InputStream) - Static method in class com.pushtechnology.diffusion.api.Utils
Returns the input stream as a string, using the default defined charset
convertInputStreamToString(InputStream, String) - Static method in class com.pushtechnology.diffusion.api.Utils
Returns the input stream as a string, using the specified charset
createClientGroup(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
createClientGroup(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Create a new client group.
createConnectionDetails() - Static method in class com.pushtechnology.diffusion.api.connection.ConnectionFactory
Deprecated.
Creates Connection Details with no Server Details specified.
createConnectionDetails(Collection<ServerDetails>) - Static method in class com.pushtechnology.diffusion.api.connection.ConnectionFactory
Deprecated.
Creates Connection Details
createConnectionDetails(String...) - Static method in class com.pushtechnology.diffusion.api.connection.ConnectionFactory
Deprecated.
Creates Connection Details for a list of URLs.
createConnectionDetails(ServerDetails...) - Static method in class com.pushtechnology.diffusion.api.connection.ConnectionFactory
Deprecated.
Creates Connection Details with a list of ServerDetails.
createDeltaMessage(String) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
createDeltaMessage(String, int) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
createDeltaMessage(String...) - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
Convenience method to create a delta message for the parent topic which has the default capacity from the owning Topic and the delta encoding pre-applied.
createDeltaMessage(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
createDeltaMessage(String, int) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
createDeltaMessage(String) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Creates an empty delta message.
createDeltaMessage(String, int) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Creates an empty delta message.
createDeltaMessage(String, Object) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Creates an empty delta message with an attachment.
createDeltaMessage(String, int, Object) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Creates an empty delta message.
createDeltaMessage(String) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Creates an empty delta message.
createDeltaMessage(String, int) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Creates an empty delta message.
createDeltaMessage(int) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Creates an empty delta message for the Topic.
createDeltaMessage() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Creates an empty delta message for the Topic.
createDeltaMessage(int, Object) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Creates an empty delta message for the Topic with an attachment.
createDeltaMessage(Object) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Creates an empty delta message for the Topic with an attachment.
createDeltaMessage(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Creates an empty delta message.
createDeltaMessage(String, int) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Creates an empty delta message.
createDocument() - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Create an empty DOM Document.
createDocument(String) - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Create a DOM document from a String of XML.
createDocument(InputStream) - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Create a DOM document from an input stream of XML.
createDocument(File) - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Create a DOM document from a file of XML.
createDocumentFromResource(String) - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Creates a DOM document from a a resource of the specified name loaded from the classpath.
createElement(Document, String, String) - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Creates an element with a value.
createFileReader(File) - Static method in class com.pushtechnology.diffusion.api.Utils
Creates a reader for a given file.
createFileReader(File, String) - Static method in class com.pushtechnology.diffusion.api.Utils
Creates a reader for a given file.
createFileReader(FileInputStream) - Static method in class com.pushtechnology.diffusion.api.Utils
Creates a reader for a given file input stream.
createFileReader(FileInputStream, String) - Static method in class com.pushtechnology.diffusion.api.Utils
Creates a reader for a given file input stream.
createFileWriter(File) - Static method in class com.pushtechnology.diffusion.api.Utils
Creates a buffered writer for a given file.
createFileWriter(File, String) - Static method in class com.pushtechnology.diffusion.api.Utils
Creates a writer for a given file.
createFileWriter(FileOutputStream) - Static method in class com.pushtechnology.diffusion.api.Utils
Creates a writer for a given file output stream.
createFileWriter(FileOutputStream, String) - Static method in class com.pushtechnology.diffusion.api.Utils
Creates a writer for a given file output stream.
createLoadMessage(String) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
createLoadMessage(String, int) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
createLoadMessage(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
createLoadMessage(String, int) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
createLoadMessage(String) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Creates an empty Topic Load message.
createLoadMessage(String, int) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Creates an empty Topic Load message.
createLoadMessage(String) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Creates an empty load message.
createLoadMessage(String, int) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Creates an empty load message.
createLoadMessage(int) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Creates an empty Topic Load message for the Topic.
createLoadMessage() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Creates an empty Topic Load message for the Topic
createLoadMessage(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Creates an empty Topic Load message.
createLoadMessage(String, int) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Creates an empty Topic Load message.
createLog(String) - Static method in class com.pushtechnology.diffusion.api.Logs
Create a log from a named log configuration.
createLog(LogDescription) - Static method in class com.pushtechnology.diffusion.api.Logs
Create a log from a log description.
createPagedTopicHandler(TopicMessage, PagedTopicListener) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
createPagedTopicHandler(TopicMessage, PagedTopicListener) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Creates a handler object for a 'paged' topic.
createPublisher(String) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Convenience method to create a default Publisher and register it with Diffusion Equivalent of creating a PublisherConfig instance with ServerConfig.addPublisher(String, String) and passing to Publishers.loadPublisher(PublisherConfig).
createPublisher(String, Class<? extends Publisher>) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Convenience method to create a Publisher from a given Class and register it with Diffusion Equivalent of creating a PublisherConfig instance with ServerConfig.addPublisher(String, String) and passing to Publishers.loadPublisher(PublisherConfig).
createPublisher(String, String) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Convenience method to create a Publisher from a given classname and register it with Diffusion Equivalent of creating a PublisherConfig instance with ServerConfig.addPublisher(String, String) and passing to Publishers.loadPublisher(PublisherConfig).
createResourceReader(String) - Static method in class com.pushtechnology.diffusion.api.Utils
Creates a reader for a named resource.
createResourceReader(String, String) - Static method in class com.pushtechnology.diffusion.api.Utils
Creates a reader for a named resource.
createResponseMessage(String...) - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceRequest
Deprecated.
Convenience method to create a message that can be returned in a ServiceResponse.
createServerDetails(String) - Static method in class com.pushtechnology.diffusion.api.connection.ConnectionFactory
Deprecated.
Creates a ServerDetails object from a URL.
createServiceTopicHandler(TopicMessage, ServiceTopicListener) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
createServiceTopicHandler(TopicMessage, ServiceTopicListener) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
since 5.7 service topics have been deprecated.
createThreadPool(String, int, int, int, int) - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
Creates a new thread pool.
createTopicNotifyTopicHandler(TopicMessage, TopicNotifyTopicHandler.NotificationLevel, TopicNotifyTopicListener) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
createTopicNotifyTopicHandler(TopicMessage, TopicNotifyTopicListener) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
createTopicNotifyTopicHandler(TopicMessage, TopicNotifyTopicHandler.NotificationLevel, TopicNotifyTopicListener) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
createTopicNotifyTopicHandler(TopicMessage, TopicNotifyTopicListener) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Creates a handler object for a 'Topic Notify' topic.
createWhoIsData() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
Creates an empty WhoIs data object.
createWhoIsData(Map<String, String>) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
Create a WhoIs data object populated with supplied data.
createWithMetadata(MRecord, String, String...) - Static method in class com.pushtechnology.diffusion.api.message.Record
This special factory method allows a Record with metadata to be created.
Credentials - Class in com.pushtechnology.diffusion.api
Authorisation Credentials.
Credentials() - Constructor for class com.pushtechnology.diffusion.api.Credentials
Create a Credentials object with no user name and password set.
Credentials(String, String) - Constructor for class com.pushtechnology.diffusion.api.Credentials
Create a Credentials object with specified user name and password.
credentialsSupplied(Client, Credentials) - Method in interface com.pushtechnology.diffusion.api.publisher.AuthorisationHandler
Deprecated.
since 5.2

Use an authentication handler in preference. This method is still invoked for backwards compatibility, and can veto attempts to change the authenticated principal by returning false. This method will be removed in a future release.

CustomFieldHandler - Interface in com.pushtechnology.diffusion.api.data.metadata
A Custom Field Handler defines the behaviour of a Custom String Metadata Type.
CustomTopicData - Interface in com.pushtechnology.diffusion.api.data.custom
Deprecated.
since 5.9

This topic type will be removed in a future release. The handling of different data formats is better done using binary topics.

CustomTopicDataHandler - Interface in com.pushtechnology.diffusion.api.data.custom
Deprecated.
since 5.9

See CustomTopicData.

D

DataMessage - Interface in com.pushtechnology.diffusion.api.message
A message that has a data body.
decodeFromXML(String) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
Parse metadata from XML.
DEFAULT - Static variable in interface com.pushtechnology.diffusion.api.conflation.MessageMatcher
This is an instance of the default message matcher which has the null effect of always matching (i.e.
DEFAULT_DATE_FORMAT - Static variable in interface com.pushtechnology.diffusion.api.config.FormattingConfig
The default date format.
DEFAULT_DATE_TIME_FORMAT - Static variable in interface com.pushtechnology.diffusion.api.config.FormattingConfig
The default date and time format.
DEFAULT_DELETION_VALUE - Static variable in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
This is the default deletion value that will be used if none is explicitly specified.
DEFAULT_EVENT_QUEUE_SIZE - Static variable in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Default multiplexer queue size.
DEFAULT_LOCK_TIMEOUT - Static variable in interface com.pushtechnology.diffusion.api.topic.Topic
Default Lock Timeout - 5000 milliseconds.
DEFAULT_NAME - Static variable in interface com.pushtechnology.diffusion.api.config.SelectorThreadPoolsConfig
The name of the default elector thread pool.
DEFAULT_RETRY_INTERVAL - Static variable in interface com.pushtechnology.diffusion.api.publisher.PublisherServerConnection
Deprecated.
The default retry interval.
DEFAULT_TIME_FORMAT - Static variable in interface com.pushtechnology.diffusion.api.config.FormattingConfig
The default time format.
DEFAULT_TIMESTAMP_FORMAT - Static variable in interface com.pushtechnology.diffusion.api.config.FormattingConfig
The default timestamp format.
DefaultClientListener - Class in com.pushtechnology.diffusion.api.publisher
This is a default implementation of ClientListener which may be extended to implement only those event notifications that you wish to process.
DefaultClientListener() - Constructor for class com.pushtechnology.diffusion.api.publisher.DefaultClientListener
Create a Default ClientListener.
DELETE - Static variable in interface com.pushtechnology.diffusion.api.topic.TopicIntrospection
The mask setting which will allow a Topic to be deleted via the Introspector tool.
DiffusionServer - Class in com.pushtechnology.diffusion.api.server
Represents an instance of the Diffusion Server.
DiffusionServer() - Constructor for class com.pushtechnology.diffusion.api.server.DiffusionServer
Constructor.
DiffusionServer(Properties) - Constructor for class com.pushtechnology.diffusion.api.server.DiffusionServer
Constructor.
DiffusionServer(String, boolean) - Constructor for class com.pushtechnology.diffusion.api.server.DiffusionServer
Constructor.
DiffusionServer(Properties, boolean) - Constructor for class com.pushtechnology.diffusion.api.server.DiffusionServer
Constructor.
doHandshake(ServerDetails) - Method in class com.pushtechnology.diffusion.api.connection.HTTPProxyConnector
 
doHandshake(ServerDetails) - Method in interface com.pushtechnology.diffusion.api.connection.ProxyConnector
Deprecated.
Implementations must provide this method to make a connection via a Proxy server and return the SocketChannel.
duplicate() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Creates an exact duplicate of the message.

E

EmbeddedDiffusion - Interface in com.pushtechnology.diffusion.api.server
Represents an instance of the Diffusion Server.
EmbeddedDiffusion.LifecycleListener - Interface in com.pushtechnology.diffusion.api.server
Listener interface that is invoked when server state changes occur.
EmbeddedDiffusion.State - Enum in com.pushtechnology.diffusion.api.server
Diffusion lifecycle state.
EMPTY_FIELD - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Byte value reserved for representing and empty field in a character based message.
EMPTY_FIELD_CHAR - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Character representation of Message.EMPTY_FIELD.
EMPTY_FIELD_STRING - Static variable in interface com.pushtechnology.diffusion.api.message.Message
String representation of Message.EMPTY_FIELD.
encodeAsXML(MNode) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
Encode metadata as XML.
encodeAsXML(MNode, boolean) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
Encode metadata as XML.
Encoding - Enum in com.pushtechnology.diffusion.api.message
Represents a message byte encoding.
endUpdate() - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
This is called when PublishingTopicData.endUpdate() is called.
endUpdate() - Method in class com.pushtechnology.diffusion.api.data.custom.SimpleCustomTopicDataHandler
Deprecated.
 
endUpdate() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Ends an update and unlocks the topic.
equals(Object) - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
 
equals(Object) - Method in class com.pushtechnology.diffusion.api.message.Record
equals(Object) - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
 
equals(Object) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Compares this tree node with some object for equality.
ETAG_BYTES - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Etag header
execute(RunnableTask) - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Give a RunnableTask to the pool to be executed.
ExternalClientConnection - Class in com.pushtechnology.diffusion.api.client
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

ExternalClientConnection(ServerConnectionListener, ConnectionDetails) - Constructor for class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
Construct a Client connection object.
ExternalClientConnection() - Constructor for class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
Constructs a Client Connection without connection details or a listener.
ExternalClientConnection(ServerConnectionListener, ServerDetails) - Constructor for class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
Constructs a Client Connection.
ExternalClientConnection(ServerConnectionListener, String...) - Constructor for class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
Convenience constructor which allows ConnectionDetails to be automatically created from one or more URLs.

F

FanOutConfig - Interface in com.pushtechnology.diffusion.api.config
Fan-out configuration.
FanOutConnectionConfig - Interface in com.pushtechnology.diffusion.api.config
Provides configuration for a fan-out client connection.
FanOutLinkConfig - Interface in com.pushtechnology.diffusion.api.config
Configuration for a replicated fan-out link.
fetch(TopicSet, String...) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
fetch(String, String...) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
fetch(TopicSet, List<String>) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Causes a forced fetch of one or more Topics for the Client.
fetch(TopicSet, String...) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Fetch the current state of a set of topics.
fetch(String, String...) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Fetch the current state of a set of topics.
FETCH_INVALID - Static variable in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Client fetch invalid notification mask setting
fetchForClient(Client, Topic, List<String>) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Deprecated.
since 5.6. Currently a classic client can issue a fetch request to a stateless topic. This method enables a publisher to return a reply. At future releases this capability will be removed.
FetchPolicyConfig - Interface in com.pushtechnology.diffusion.api.config
Fetch Policy configuration for a connector.
FIELD_DELIMITER - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Byte value reserved for use as a field delimiter in character based Messages.
FIELD_DELIMITER_CHAR - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Character representation of Message.FIELD_DELIMITER.
FIELD_DELIMITER_STRING - Static variable in interface com.pushtechnology.diffusion.api.message.Message
String representation of Message.FIELD_DELIMITER.
FIELD_MU - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Byte value reserved for representing a single empty field record.
FileServiceConfig - Interface in com.pushtechnology.diffusion.api.config
Web Server - File Service Configuration.
formatDate(Date) - Static method in class com.pushtechnology.diffusion.api.Utils
Formats a date.
formatDate(long) - Static method in class com.pushtechnology.diffusion.api.Utils
Formats a milliseconds date.
formatDateTime(Date) - Static method in class com.pushtechnology.diffusion.api.Utils
Formats a date and time.
formatDateTime(long) - Static method in class com.pushtechnology.diffusion.api.Utils
Formats a milliseconds date and time.
formatElapsedTime(long) - Static method in class com.pushtechnology.diffusion.api.Utils
Formats an elapsed time in milliseconds into a display format string.
formatNumber(Number) - Static method in class com.pushtechnology.diffusion.api.Utils
Formats a number using default decimal formatting.
formatTime(Date) - Static method in class com.pushtechnology.diffusion.api.Utils
Formats a time value.
formatTime(long) - Static method in class com.pushtechnology.diffusion.api.Utils
Formats the time from a milliseconds date value.
formatTimeStamp(Date) - Static method in class com.pushtechnology.diffusion.api.Utils
Formats a time stamp.
formatTimeStamp(long) - Static method in class com.pushtechnology.diffusion.api.Utils
Formats a milliseconds value into a timestamp.
FormattingConfig - Interface in com.pushtechnology.diffusion.api.config
Formats (i.e Dates) configuration
fromCode(String) - Static method in enum com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler.NotificationLevel
Deprecated.
Returns NotificationLevel enum from code value.
fromCode(String) - Static method in enum com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler.SelectionMode
Deprecated.
Returns SelectionMode enum from code value.
fromCode(String) - Static method in enum com.pushtechnology.diffusion.api.data.paging.PagedTopicData.Duplicates
Deprecated.
Returns Duplicates enum from code value.
fromCode(String) - Static method in enum com.pushtechnology.diffusion.api.data.pb.PBTopicData.UpdateMode
Deprecated.
Returns UpdateMode enum from code value.
fromCode(String) - Static method in enum com.pushtechnology.diffusion.api.data.service.ServiceHeader
Deprecated.
Returns ServiceHeader enum from code value.
fromKey(String) - Static method in enum com.pushtechnology.diffusion.api.topic.TopicProperty
Returns TopicProperty enum from key representation.
fromName(String) - Static method in enum com.pushtechnology.diffusion.api.config.ConnectorConfig.ClientApiType
Deprecated.
 
fromName(String) - Static method in enum com.pushtechnology.diffusion.api.config.ConnectorConfig.ProxyProtocol
Lookup the value from a string.
fromString(String) - Static method in enum com.pushtechnology.diffusion.api.config.ConflationPolicyConfig.Mode
Returns Mode enum from string representation.
fromString(String) - Static method in enum com.pushtechnology.diffusion.api.config.ConnectorConfig.Type
Returns type enum from string representation.
fromString(String) - Static method in enum com.pushtechnology.diffusion.api.config.MultiplexerConfig.LoadBalancer
Returns load balancer enum from string representation.
fromString(String) - Static method in enum com.pushtechnology.diffusion.api.config.ReporterConfig.Type
Returns type enum from string representation.
fromString(String) - Static method in enum com.pushtechnology.diffusion.api.config.ValidationPolicyConfig.Type
Returns type enum from string representation.
fromString(String) - Static method in enum com.pushtechnology.diffusion.api.LogDescription.LogLevel
Returns log level enum from string representation.
fromString(String) - Static method in enum com.pushtechnology.diffusion.api.publisher.ClientThrottlerType
Returns type enum from string representation.
fromString(String) - Static method in enum com.pushtechnology.diffusion.api.publisher.PublisherServerConnectionFailPolicy
Deprecated.
Returns policy enum from string representation.
FULL - Static variable in interface com.pushtechnology.diffusion.api.topic.TopicIntrospection
The mask setting which will allow full introspection capabilities on a Topic.

G

generateAckDeltaMessage(String...) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
As PublishingTopicData.generateDeltaMessage(String...) but generating a message that requires acknowledgement.
generateDeltaMessage(String...) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Generates a delta message summarising changes to the data since updating was started (PublishingTopicData.startUpdate() was called).
generateResponseBuffer() - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Generate a HTTP Response from the details provided and populate a newly created Byte Buffer
generateResponseBuffer(boolean) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Generate a HTTP Response from the details provided and populate a newly created Byte Buffer, optionally only creating the HTTP headers.
GeoIpConfig - Interface in com.pushtechnology.diffusion.api.config
Geo IP Configuration.
GeoIPData - Interface in com.pushtechnology.diffusion.api.whois
GeoIPData
GeoIPUtils - Class in com.pushtechnology.diffusion.api.whois
Simple Geo IP Utils to expose the internal Geo IP Database.
GeoIPUtils() - Constructor for class com.pushtechnology.diffusion.api.whois.GeoIPUtils
 
GeoLocation - Class in com.pushtechnology.diffusion.api.whois
Wraps the latitude and longitude of a location.
GeoLocation() - Constructor for class com.pushtechnology.diffusion.api.whois.GeoLocation
Create a Geo Location with latitude and longitude zero.
GeoLocation(float, float) - Constructor for class com.pushtechnology.diffusion.api.whois.GeoLocation
Create a Geo Location with latitude and longitude as specified.
get(int) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Get the value of the line at the specified index.
get(Record) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Get the value of the line that matches the specified Record.
get(int) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Get the value of the line at the specified index.
get(String) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Get the value of the line that matches the specified string.
getAcceptors() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Deprecated.
this value is ignored by the system.
getAckId() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Returns the ACK Id for the message.
getAckTimeout() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
getAckTimeout() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Gets the ack timeout.
getAckTimeout() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Returns the 'ACK Timeout' value for the message (if set).
getAckTimeout() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
getAckTimeout() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Returns the default Server ACK timeout value for the connection.
getAckTimeout() - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Returns the default ACK timeout value for the provider.
getActiveCount() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the approximate number of threads that are actively executing tasks.
getAdditionalDetails() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicError
Deprecated.
Returns additional details.
getAddress() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
The address that the lookup relates to.
getAddresses() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Get list of configured addresses.
getAliasFile() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Gets the alias file.
getAliasFile() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the alias file
getAliasProcessor() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the alias processor
getAllTopics() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns all Topics subordinate to this node.
getAssignedRoles() - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Deprecated.
since 5.9. Remote JMX users should be configured in the system authentication store, or with a custom authentication handler.
getAttachment() - Method in interface com.pushtechnology.diffusion.api.message.AttachableTopicMessage
Returns the message attachment.
getAuthenticationHandlers() - Method in interface com.pushtechnology.diffusion.api.config.SecurityConfig
 
getAuthorisationHandlerClass() - Method in interface com.pushtechnology.diffusion.api.config.SecurityConfig
Returns the name of the authorisation handler class.
getAutoDeployment() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Gets the Auto Deployment Configuration details.
getAverageMessageSize() - Method in interface com.pushtechnology.diffusion.api.statistics.MessageStatistics
Returns average message size.
getBackgroundPoolSize() - Method in interface com.pushtechnology.diffusion.api.config.ThreadsConfig
Returns the size of the background thread pool.
getBackgroundThreadPool() - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
Returns the background thread pool.
getBacklog() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the backlog value.
getBatchSize() - Method in interface com.pushtechnology.diffusion.api.config.FetchPolicyConfig
Returns the batch size value.
getBody() - Method in interface com.pushtechnology.diffusion.api.message.InternalTopicMessage
 
getBooleanProperty(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Gets the value of a boolean property.
getBooleanProperty(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is a convenience method to get an boolean property value for this publisher from the Publishers.xml file.
getBooleanProperty(TopicProperty) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Returns the value of a Boolean property.
getByteProperty(TopicProperty) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Returns the value of a Byte property
getBytesOnWire() - Method in interface com.pushtechnology.diffusion.api.statistics.MessageStatistics
Returns the number of actual bytes transmitted.
getBytesProperty(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Converts a size into bytes.
getBytesProperty(String, int) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Converts a size into bytes.
getBytesProperty(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is a convenience method to get a bytes property value for this publisher from the Publishers.xml file.
getByTypeCode(String) - Static method in enum com.pushtechnology.diffusion.api.data.TopicDataType
Map type-code string to TopicDataType object.
getCache() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Gets the cache configuraton.
getCache() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the HTTP cache
getCacheMaximumSize() - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Gets the maximum size of the WhoIs cache.
getCacheRetentionTime() - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Gets the retention time for WhoIs cache entries.
getCacheSizeLimit() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostCacheConfig
Gets the cache size limit.
getCacheSizeLimit() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPCache
Get cache size limit.
getCacheTidyInterval() - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Gets the WhoIs cache tidy interval.
getCategories() - Method in interface com.pushtechnology.diffusion.api.ConnectionType
Returns a list of the categories for the connection type.
getCharset() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
since 5.9

In future releases only UTF-8 will be supported

getCharset() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns the character set used for character to byte conversions and vice versa.
getChild(int) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Gets the child at a given index.
getChildElementText(Element, String) - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Gets text from a child element.
getClassName() - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Gets the service class.
getClassName() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Gets the publisher class name.
getClassName() - Method in interface com.pushtechnology.diffusion.api.config.ServerAuthenticationHandlerConfig
The fully qualified name of a class which implements the AuthenticationHandler interface.
getClassName() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolListenerConfig
Deprecated.
Returns the queue notification class name.
getClient() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceRequest
Deprecated.
Returns the client that initiated the request.
getClient(String) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Returns Client given a Client ID.
getClient() - Method in interface com.pushtechnology.diffusion.api.topic.Subscription
Returns the Client.
getClientGroup(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
getClientGroup(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Gets a named client group.
getClientGroupMembership(TopicClient) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
getClientGroupMembership(TopicClient) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Gets a list of group names that a specified client currently belongs to.
getClientID() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
getClientID() - Method in interface com.pushtechnology.diffusion.api.ClientConnection
Returns the client ID.
getClientId() - Method in class com.pushtechnology.diffusion.api.data.service.ServiceResponse
Deprecated.
Returns client Id.
getClientID() - Method in interface com.pushtechnology.diffusion.api.message.MessageSource
Returns a unique client identifier for the Message source.
getClientID() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Returns the client identifier for the connection.
getClients(Topic) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Returns the list of clients currently subscribed to a given topic.
getClients() - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Returns a list of all currently known Clients.
getClients(ConnectionCategory) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Returns a list of all currently known Clients that are of a specified connection category.
getClients() - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Returns a snapshot of all of the clients currently in the group.
getClients() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns a list of all of the client sessions that are directly subscribed to the topic.
getClientService() - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Get Client Service configuration.
getClientsForTopic(Topic) - Method in interface com.pushtechnology.diffusion.api.data.routing.RoutingTopicData
Get the list of Clients that are mapped to a particular Topic.
getClientStatistics() - Method in interface com.pushtechnology.diffusion.api.config.StatisticsConfig
Get client statistics configuration.
getClientType() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
getCloseReason() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
If the client is not connected then this will return the reason that it was closed.
getCode() - Method in enum com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler.NotificationLevel
Deprecated.
Returns the code representation as used in messages.
getCode() - Method in enum com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler.SelectionMode
Deprecated.
Returns the code used in messages.
getCode() - Method in enum com.pushtechnology.diffusion.api.client.paging.PageOption
Deprecated.
Returns single character code for paging options.
getCode() - Method in enum com.pushtechnology.diffusion.api.client.service.ServiceErrorType
Deprecated.
Returns String code.
getCode() - Method in enum com.pushtechnology.diffusion.api.data.paging.PagedTopicData.Duplicates
Deprecated.
Returns the code used in message transmission for this enum.
getCode() - Method in enum com.pushtechnology.diffusion.api.data.pb.PBTopicData.UpdateMode
Deprecated.
Returns the code used in message transmission for this enum.
getCode() - Method in enum com.pushtechnology.diffusion.api.data.service.ServiceHeader
Deprecated.
Returns a code value for the service header.
getCode() - Method in enum com.pushtechnology.diffusion.api.topic.TopicStatus
Returns message code value.
getCometBytesBeforeNewPoll() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Gets comet bytes before new poll value.
getCometInitialMessagePadding() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Gets comet initial message padding.
getComparator() - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
If the data is ordered then this will return the comparator is use for ordering.
getComparator() - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
If the data is ordered then this returns the comparator in use for ordering.
getCompressionThreshold() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Gets the compression threshold.
getCompressionThreshold() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Gets the compression threshold.
getCompressionThreshold() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the compression threshold
getConfig() - Static method in class com.pushtechnology.diffusion.api.config.ConfigManager
Returns the root configuration object for the current VM.
getConfig() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Returns the publisher's configuration object.
getConfig() - Method in class com.pushtechnology.diffusion.api.server.DiffusionServer
 
getConfig() - Method in interface com.pushtechnology.diffusion.api.server.EmbeddedDiffusion
Returns the root server configuration.
getConflation() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Get the conflation configuration.
getConflationCount(boolean) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the number of conflations that have occurred for the connection.
getConnection() - Method in interface com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler
Deprecated.
Returns the client connection.
getConnection() - Method in interface com.pushtechnology.diffusion.api.client.paging.PagedTopicHandler
Deprecated.
Get the connection (the client object that created the handler).
getConnection() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicHandler
Deprecated.
Returns the client connection.
getConnectionDetails() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
Returns the Connection Details.
getConnectionPort() - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Gets the JMX service port.
getConnections() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConfig
Get the configured list of primary server connections.
getConnectionTimeout() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the connection timeout for inbound connections.
getConnectionTimeout() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns the connection timeout.
getConnectionTimeout() - Method in interface com.pushtechnology.diffusion.api.config.TimeoutsConfig
Gets the connection timeout.
getConnectionTimeout() - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Returns the default connection timeout.
getConnectionTimeout() - Method in class com.pushtechnology.diffusion.api.connection.HTTPProxyConnector
 
getConnectionTimeout() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the connection timeout.
getConnectionType() - Method in interface com.pushtechnology.diffusion.api.ClientConnection
Returns the connection type.
getConnectionValidationPolicies() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Get the connection validation policies defined for the connector.
getConnectionValidationPolicies() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Get the list of connection validation policies that are configured for the connector of this client.
getConnectionValidationPolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Get a named connection validation policy that belongs to the connector.
getConnector(String) - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Get the configuration for a named connector.
getConnectorName() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Get the connector name
getConnectors() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Returns the list of connectors defined for this server.
getConsoleLogLevel() - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Gets the console log level.
getContent() - Method in interface com.pushtechnology.diffusion.api.publisher.XMLProperties
Deprecated.
Returns the contents of the properties file.
getContent() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequest
Returns a byte array containing the request content.
getCoreSize() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Returns the core pool size.
getCoreSize() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the core number of threads.
getCORSOrigin() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Gets the CORS origin value.
getCountry() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyLocaleConfig
Gets the country.
getCreationTime() - Method in interface com.pushtechnology.diffusion.api.message.PingMessage
Returns the message creation time.
getCreationTimeMillis() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the time that the Topic was created (in milliseconds).
getCredentials() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the credentials for the connection.
getCredentials() - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Returns the default credentials.
getCredentials() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the Credentials to use when connecting to the server.
getCredentials() - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Deprecated.
This method exists only to support the AuthorisationHandler.canConnect() and AuthorisationHandler.credentialsSupplied methods, both of which are deprecated in favor of authentication handlers. It will be removed in a future release. Please be aware that we only maintain full backwards compatibility for Classic Clients - the Credentials object returned will give a "null" password string for any Unified Client calls to Credentials.getPassword().
getCurrentNumberOfSubscribers() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the number of clients currently subscribed to the topic.
getCurrentPage() - Method in interface com.pushtechnology.diffusion.api.client.paging.PageStatus
Deprecated.
Returns the current page number.
getCurrentQueueSize() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the current outbound queue size.
getCustomFieldHandler() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MField
If the data type is MDataType.CUSTOM_STRING then this will return the custom string handler.
getCustomFieldHandlerClassName() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MField
If the data type is MDataType.CUSTOM_STRING then this will return the custom string handler class name.
getData() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the Topic Data associated with the Topic (if any).
getDataType() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MField
Returns the data type of the field.
getDataType() - Method in interface com.pushtechnology.diffusion.api.data.single.SingleValueTopicData
Returns the data type of the encapsulated value.
getDataType() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the type of TopicData attached to the Topic.
getDateFormat() - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Returns the date format.
getDateFormat() - Method in interface com.pushtechnology.diffusion.api.LogDescription
Returns the date format used the %d part of the log file name.
getDateTimeFormat() - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Returns the date and time format.
getDefaultCharsetDecoder() - Static method in class com.pushtechnology.diffusion.api.Utils
Get a Charset decoder based off the default charset
getDefaultDeltaMessageCapacity() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Gets the default delta message capacity.
getDefaultDeltaMessageCapacity() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the default capacity for delta Messages in bytes created using this Topic.
getDefaultLoadMessageCapacity() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Gets the default load message capacity.
getDefaultLoadMessageCapacity() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the default capacity for load Messages created using this Topic.
getDefaultLogDirectory() - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Gets the default log directory.
getDefaultMultiplexerDefinition() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
since 5.6 default multiplexer not in use as multiplexer is configured with xml config
getDefaultPolicy() - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Gets the the default conflation policy.
getDefaultPool() - Method in interface com.pushtechnology.diffusion.api.config.SelectorThreadPoolsConfig
Returns the name of the default selector thread pool.
getDefaultQueue() - Method in interface com.pushtechnology.diffusion.api.config.QueuesConfig
Gets the name of the default queue definition.
getDefaultValue() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MField
Returns the default value that the field should be initialised to.
getDefinition() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns a new definition object representing the Topic.
getDelay() - Method in interface com.pushtechnology.diffusion.api.config.FetchPolicyConfig
Gets the batch delay interval.
getDeletionValue() - Method in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
Returns the deletion value.
getDeltaEncoding() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5 can be obtained from TopicData.getTopic(). getDefinition()
getDescription() - Method in enum com.pushtechnology.diffusion.api.data.TopicDataType
The description.
getDirectories() - Method in interface com.pushtechnology.diffusion.api.config.UserLibrariesConfig
Returns list of user directories.
getDirectory() - Method in interface com.pushtechnology.diffusion.api.config.AutoDeploymentConfig
Gets the directory.
getDisplayName() - Method in enum com.pushtechnology.diffusion.api.ConnectionCategory
Returns a text display name for the category.
getDisplayName() - Method in interface com.pushtechnology.diffusion.api.ConnectionType
Returns a display name for the connection type.
getDistance(GeoLocation) - Method in interface com.pushtechnology.diffusion.api.whois.GeoIPData
Returns the distance in miles between two locations.
getDocumentRoot() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Gets the document root.
getDocumentRoot() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the document root directory name
getDoubleProperty(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Get a double property.
getDuplicatesPolicy() - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedTopicData
Deprecated.
Returns the duplicates policy.
getEmptyFieldValue() - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Returns the current empty field value.
getEncoding() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns the message encoding.
getErrorMessage() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicError
Deprecated.
Returns the error message.
getErrorPage() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Gets the error page.
getErrorPage() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the error page
getErrorType() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicError
Deprecated.
Returns the error type.
getExceptionMessage() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicError
Deprecated.
Returns an exception message.
getExtension() - Method in interface com.pushtechnology.diffusion.api.config.MimeConfig
The extension or suffix.
getFailPolicy() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the failure policy.
getFailPolicy() - Method in interface com.pushtechnology.diffusion.api.publisher.PublisherServerConnection
Deprecated.
Returns the connection failure policy.
getFanOut() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Get the FanOut configuration.
getFetchPolicy() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Returns the fetch policy configuration for the connector.
getField(String) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Gets a child field by name.
getField(int) - Method in class com.pushtechnology.diffusion.api.message.Record
Returns a specific field value within the record.
getField(String) - Method in class com.pushtechnology.diffusion.api.message.Record
Gets a field value by name.
getField(String, int) - Method in class com.pushtechnology.diffusion.api.message.Record
Get the value of a specified occurrence of a repeating field.
getFields() - Method in class com.pushtechnology.diffusion.api.message.Record
Returns the values of all fields occurrences within the record.
getFieldValues(String) - Method in class com.pushtechnology.diffusion.api.message.Record
Gets a list of field values.
getFile() - Method in interface com.pushtechnology.diffusion.api.config.KeyStoreConfig
Gets the file name.
getFile(String) - Static method in class com.pushtechnology.diffusion.api.Utils
Gets a File object corresponding to a file that is loadable from the system classpath.
getFileCount() - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
 
getFileCount() - Method in interface com.pushtechnology.diffusion.api.LogDescription
Specifies the number of log files to use.
getFileLifeTime() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostCacheConfig
Gets the file lifeTime.
getFileLifeTime() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPCache
Get file lifetime.
getFileLimit() - Method in interface com.pushtechnology.diffusion.api.LogDescription
Specifies an approximate maximum amount to write (in bytes) to any one log file.
getFileName() - Method in interface com.pushtechnology.diffusion.api.config.GeoIpConfig
Gets the file name.
getFilePattern() - Method in interface com.pushtechnology.diffusion.api.LogDescription
Gets the file pattern.
getFileService() - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Get file service configuration.
getFileServiceName() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the file service name
getFileSizeLimit() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostCacheConfig
Gets the file size limit.
getFileSizeLimit() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPCache
Get file size limit
getFormatting() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Gets the formatting (e.g dates) configuration.
getFrequency() - Method in interface com.pushtechnology.diffusion.api.threads.Schedule
Returns the scheduled frequency pattern.
getFrequency() - Method in interface com.pushtechnology.diffusion.api.threads.ScheduledTask
This must return a schedule frequency pattern for the task.
getFullName() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MNode
Returns the full name of the node defining its hierarchy.
getGeoIp() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Gets the Geo IP config details.
getGeoIPData() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
getGeoIPData
getGeoIPData(String) - Static method in class com.pushtechnology.diffusion.api.whois.GeoIPUtils
Returns a GeoIPData object, which contains as well as locale, the latitude and longitude.
getGeoIPData(InetAddress) - Static method in class com.pushtechnology.diffusion.api.whois.GeoIPUtils
Returns a GeoIPData object, which contains as well as locale, the latitude and longitude.
getGeoLocation() - Method in interface com.pushtechnology.diffusion.api.whois.GeoIPData
Returns the latitude and longitude of the location.
getHandler() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicError
Deprecated.
Returns the handler that notified the error.
getHandler() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicResponse
Deprecated.
Returns the handler that the request was issued to.
getHandler() - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicData
Deprecated.
Returns the handler of the TopicData.
getHandlerName() - Method in interface com.pushtechnology.diffusion.api.config.ControlAuthenticationHandlerConfig
 
getHeader(int) - Method in interface com.pushtechnology.diffusion.api.message.Message
Returns a header value.
getHeader(String) - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequest
Get specified header.
getHeaderOptions() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
Returns the current header options.
getHeaders() - Method in interface com.pushtechnology.diffusion.api.message.Message
Returns a list of user defined headers.
getHeaders() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequest
Get headers.
getHeaders() - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Returns a HashMap of the existing headers
getHomePage() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Gets the home page.
getHomePage() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the home page
getHooks() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Gets the Server Hooks Configuration.
getHost() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the host.
getHost() - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Gets the host.
getHost() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the value of the host property.
getHost() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Gets the host.
getHost() - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Gets the WhoIs host.
getHost() - Method in class com.pushtechnology.diffusion.api.connection.HTTPProxyConnector
 
getHost() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the server host.
getHost() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the host name
getHostName() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
The host name.
getHostNames() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Get list of configured host names
getHTTPService(String) - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Get named HTTP Service configuration.
getHTTPServices() - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Get list of HTTP Service configurations.
getIgnoreErrorsFrom() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the list of IP addresses to ignore errors from.
getInboundClientMessageStatistics() - Method in interface com.pushtechnology.diffusion.api.statistics.PublisherStatistics
Returns statistics relating to messages received from clients.
getInboundMessageStatistics() - Method in interface com.pushtechnology.diffusion.api.statistics.ClientStatistics
Returns statistics detailing the Client's outbound messages.
getInboundMessageStatistics() - Method in interface com.pushtechnology.diffusion.api.statistics.TopicStatistics
Deprecated.
since 5.6. Topic inbound statistics were disabled in release 5.2. This method will be removed in a future release.
getInboundPool() - Method in interface com.pushtechnology.diffusion.api.config.ThreadsConfig
Gets the inbound thread pool definition name.
getInboundThreadPool() - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
Deprecated.
Since 5.8. The thread pool returned by this method is no longer used by Diffusion. This method is retained for API compatibility and will be removed in a future release.
getInitialDefaultValue() - Method in interface com.pushtechnology.diffusion.api.data.metadata.CustomFieldHandler
Get initial default value for data type.
getInitialiser() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Returns data initialiser.
getInitialTopicSet() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Returns the initial topic set that the publisher was loaded with.
getInputBufferSize() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns the input buffer size.
getInputBufferSize() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the input buffer size.
getInputBufferSize() - Method in interface com.pushtechnology.diffusion.api.config.SocketConditioningConfig
Gets the input buffer size.
getInputBufferSize() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the input buffer size for socket connection buffers and message receiving buffers.
getInputStream() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns an InputStream which may be used for reading bytes from the message.
getIntegerProperty(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Get an integer property.
getIntegerProperty(String, int) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Get an integer property if it exists otherwise return a default value.
getIntegerProperty(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is a convenience method to get an integer property value for this publisher from the Publishers.xml file.
getIntegerProperty(TopicProperty) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Returns the value of an Integer property
getIntrospectionMask() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the value of the Topic introspection mask.
getIPAddress() - Method in interface com.pushtechnology.diffusion.api.whois.GeoIPData
Returns the IP Address that this GeoIP Data is based on.
getKeepAlive() - Method in interface com.pushtechnology.diffusion.api.config.ReconnectConfig
Gets the keep alive value.
getKeepAlive() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Gets the keep alive time.
getKeepAlive() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the thread pool keep alive time (see ThreadPool.setKeepAlive(long)).
getKey() - Method in enum com.pushtechnology.diffusion.api.topic.TopicProperty
Returns the property key value.
getKeyStore() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the KeyStore configuration.
getKeyStoreFileLocation() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the KeyStore file.
getKeyStorePassword() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the KeyStore password.
getLanguage() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyLocaleConfig
Gets the language.
getLargestQueueSize() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the largest size the queue has reached.
getLargestSize() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the largest number of threads that have ever simultaneously been in the pool.
getLastInteraction() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
getLastInteraction() - Method in interface com.pushtechnology.diffusion.api.ClientConnection
Returns time of last interaction with the server.
getLastInteraction() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Returns time of last interaction with the server.
getLastMessageReceivedTimeMillis() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the time that the last message was received from the client.
getLastMessageSentTimeMillis() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the time that last message was sent to the client.
getLastPage() - Method in interface com.pushtechnology.diffusion.api.client.paging.PageStatus
Deprecated.
Returns the current highest page number.
getLastUpdateTimeMillis() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Returns the time that the data was last updated (in milliseconds).
getLatencyWarning() - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Gets the latency warning threshold.
getLatitude() - Method in class com.pushtechnology.diffusion.api.whois.GeoLocation
Returns the latitude.
getLevel() - Method in interface com.pushtechnology.diffusion.api.LogDescription
Gets the starting level.
getLevel() - Static method in class com.pushtechnology.diffusion.api.Logs
Deprecated.
Prefer the SLF4J API for logging.
getLevel() - Method in interface com.pushtechnology.diffusion.api.LogWriter
Deprecated.
Prefer the SLF4J API for logging.
getLevel() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns the level of the node within the Topic tree.
getLimit() - Method in interface com.pushtechnology.diffusion.api.publisher.ClientThrottler
Returns the Throttler limit.
getLines() - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Returns the current values of all lines.
getLines(Record) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Returns the current values of all lines that match a specified line.
getLines(int, int) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Returns the current values of all lines in a specified range.
getLines() - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Returns the current values of all lines.
getLines(String) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Returns the current values of all lines that match a specified line.
getLines(int, int) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Returns the current values of all lines in a specified range.
getLinks() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns a list of the replication links.
getListener() - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Get the listener.
getListProperty(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Gets the value of a list property.
getListProperty(TopicProperty) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Returns the value of a String property split by list delimiters.
getLoadBalancer() - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Deprecated.
This configuration will be removed in a future release.
getLoadBalancer() - Method in interface com.pushtechnology.diffusion.api.config.WriteSelectorConfig
Deprecated.
Get the load balancer used for the selectors.
getLoadEncoding() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5 can be obtained from TopicData.getTopic(). getDefinition()
getLoadHeaders() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Returns any load headers set (see PublishingTopicData.setLoadHeaders(String...)).
getLoadMessage() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
This returns the current data state as a load message.
getLoadMessage() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
This returns the current data state as a Topic Load message.
getLoadMessage(TopicClient) - Method in interface com.pushtechnology.diffusion.api.data.TopicData
This returns the current data state as a Topic Load message.
getLocale() - Method in interface com.pushtechnology.diffusion.api.whois.GeoIPData
Returns the result of a geographic lookup of the IP address indicating where the address was allocated.
getLocale(String) - Static method in class com.pushtechnology.diffusion.api.whois.GeoIPUtils
Returns the Java locale object based on an IP Address, this will have country code and county name set.
getLocale() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
Returns the result of a geographic lookup of the IP address indicating where the address was allocated.
getLocales() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Returns a list of the configured locales.
getLocalPortNumber() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Get the Local Port number
getLocalSocketAddress() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Get the optional local socket address, used prior to connection.
getLockTimeout() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.6

All API topic locking methods are deprecated and will be removed in a future release, see Topic.lock() for details.

getLog() - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Gets the log value.
getLog(String) - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Get a named log definition.
getLogDirectory() - Method in interface com.pushtechnology.diffusion.api.LogDescription
Returns the name of the directory to which this log file will be written.
getLogger() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Returns the logger which may be used to write log messages for the publisher.
getLogger() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPServiceDetails
Returns the service logger
getLogging() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Get the logging configuration.
getLoggingQueueSize() - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Returns the maximum size of the asynchronous logging event queue.
getLogLevel() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Gets the log level for this publisher.
getLogName() - Method in interface com.pushtechnology.diffusion.api.config.ClientStatisticsConfig
Gets the log name.
getLogs() - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Get list of all configured Log definitions.
getLongitude() - Method in class com.pushtechnology.diffusion.api.whois.GeoLocation
Returns the longitude.
getLongProperty(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Get a long property.
getLongProperty(String, long) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Get an long property if it exists otherwise return a default value.
getLongProperty(TopicProperty) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Returns the value of a Long property
getLowerQueueNotificationThreshold() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the lower queue notification threshold operating for the connection.
getLowerThreshold() - Method in interface com.pushtechnology.diffusion.api.config.QueueConfig
Gets the lower threshold.
getManagement() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Get Management configuration.
getManagementName() - Method in interface com.pushtechnology.diffusion.api.management.Manageable
Deprecated.
The management name is the name that the component will appear with in JMX.
getManagementType() - Method in interface com.pushtechnology.diffusion.api.management.Manageable
Deprecated.
The management type determines the JMX folder the bean will appear under.
getMandatoryProperty(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Get a mandatory property.
getMappedField(String) - Method in class com.pushtechnology.diffusion.api.message.Record
Gets a field value as an object.
getMappedFields() - Method in class com.pushtechnology.diffusion.api.message.Record
This returns the fields of the record in a format mapped to the Record Metadata.
getMappedTopics() - Method in interface com.pushtechnology.diffusion.api.data.routing.RoutingTopicData
Get the list of Topics that this Routing data maps to.
getMaster() - Method in interface com.pushtechnology.diffusion.api.data.SlaveTopicData
Deprecated.
since 5.7.

This method will only return the master data if it is an instance of PublishingTopicData. However, it is now possible for a slave topic to point to a topic that has UniversalTopicData therefore in order to discover the master topic SlaveTopicData.getMasterTopic() should be used.

getMasterTopic() - Method in interface com.pushtechnology.diffusion.api.data.SlaveTopicData
Returns the master topic.
getMatcher() - Method in interface com.pushtechnology.diffusion.api.config.ConflationPolicyConfig
Return the matcher in use.
getMaximum() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Returns the maximum number of occurrences.
getMaximumDepth() - Method in interface com.pushtechnology.diffusion.api.config.QueueConfig
Gets the maximum queue depth.
getMaximumEventQueueSize() - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Get the maximum size of the event queue for the multiplexer.
getMaximumInboundRequestSize() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Gets the maximum inbound request size.
getMaximumInboundRequestSize() - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Gets the maximum inbound request size.
getMaximumMessageSize() - Static method in class com.pushtechnology.diffusion.api.APIProperties
Deprecated.
getMaximumMessageSize() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Returns the configured maximum message size.
getMaximumMessageSize() - Static method in class com.pushtechnology.diffusion.api.Utils
Deprecated.
getMaximumQueueDepth() - Method in interface com.pushtechnology.diffusion.api.config.ReconnectConfig
Gets the maximum queue depth.
getMaximumQueueSize() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns the maximum queue size.
getMaximumQueueSize() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the maximum queue size.
getMaximumSize() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Returns the maximum pool size.
getMaximumSize() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the maximum allowed number of threads.
getMerger() - Method in interface com.pushtechnology.diffusion.api.config.ConflationPolicyConfig
Returns the merger in use (if there is one).
getMessage() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MNode
Deprecated.
this method is not logical as it is no longer mandatory for a node to be part of a message. The upwards hierarchy of any node can be followed using MNode.getParent().
getMessage() - Method in interface com.pushtechnology.diffusion.api.message.MessageReader
Returns the message that this reader is for.
getMessageLengthSize() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
since 5.2 the message length size is always 4 bytes
getMessageName() - Method in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
The name of the message within the proto class that defines this data.
getMessageSequenceTimeout() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Gets the message sequence timeout.
getMessageSourceType() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
getMessageSourceType() - Method in interface com.pushtechnology.diffusion.api.message.MessageSource
Returns the message source type.
getMetadata() - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Returns the metadata that defines each line of the data.
getMetadata() - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Metadata Message describing the TopicData.
getMetadata() - Method in interface com.pushtechnology.diffusion.api.data.single.SingleValueTopicData
Metadata Field describing the TopicData.
getMetadata() - Method in class com.pushtechnology.diffusion.api.message.Record
Returns the Record metadata.
getMetadata() - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Returns metadata.
getMetadataNode() - Method in interface com.pushtechnology.diffusion.api.data.TopicDataWithMetadata
Returns the metadata associated with the TopicData.
getMethodName() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequest
Get the method Name.
getMillisProperty(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Converts a time into milliseconds.
getMillisProperty(String, long) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Converts a time into milliseconds.
getMillisProperty(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is a convenience method to get a time property value for this publisher from the Publishers.xml file.
getMime(String) - Method in interface com.pushtechnology.diffusion.api.config.MimesConfig
Get a configured mime.
getMimes() - Method in interface com.pushtechnology.diffusion.api.config.MimesConfig
Get list of configured mimes.
getMimes() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Get mime types configuration.
getMinimum() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Returns the minimum number of occurrences.
getMode() - Method in interface com.pushtechnology.diffusion.api.config.ConflationPolicyConfig
Return the conflation policy mode.
getMultiplexer(String) - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
since 5.6 multiplexer configuration is obtained using ServerConfig.getMultiplexerConfiguration().
getMultiplexerConfiguration() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Get the multiplexer configuration.
getMultiplexers() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
since 5.6 only one multiplexer is configured
getMultiplicity() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MNode
Returns the node's multiplicity within its parent.
getName() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
getName() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Gets the service name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.ConflationPolicyConfig
Gets the conflation policy name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the connector name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.FileServiceConfig
Gets the file service name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Gets the service name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.ManagementUserConfig
Deprecated.
Gets the user name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Gets the multiplexer definition name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.PropertyConfig
Gets the property name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Returns the Publisher name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.QueueConfig
Gets the queue definition name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.ReporterConfig
Returns the StatisticsReporter name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.SelectorThreadPoolConfig
Returns the name of the selector thread pool.
getName() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Gets the definition name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Gets the policy name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Gets the virtual host name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostRealmConfig
Gets the realm name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostRealmUserConfig
Gets the realm user name.
getName() - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Gets the Web Server name.
getName() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MNode
Returns the node name.
getName() - Method in interface com.pushtechnology.diffusion.api.LogDescription
Gets the log description name.
getName() - Method in interface com.pushtechnology.diffusion.api.publisher.ClientMultiplexer
 
getName() - Method in interface com.pushtechnology.diffusion.api.publisher.XMLProperties
Deprecated.
Returns the properties name.
getName() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Returns a name which uniquely identifies the server within the context that the connection is being made.
getName() - Method in interface com.pushtechnology.diffusion.api.threads.Schedule
Returns the scheduled task name.
getName() - Method in interface com.pushtechnology.diffusion.api.threads.ScheduledTask
Name of the task used for logging purposes
getName() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the name of the thread pool.
getName() - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Returns the name of the client group.
getName() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the Topic name.
getName() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPServiceDetails
Returns the HTTP service name
getName() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the virtual host name
getNextRequestId() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicHandler
Deprecated.
Returns a new unique request identifier that may be used in the ServiceTopicHandler.request(String, String, TopicMessage) call.
getNextTopicName() - Static method in class com.pushtechnology.diffusion.api.topic.TopicNameGenerator
Returns the next unique topic name.
getNodeName() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns the node name.
getNotificationHandler() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the current ThreadPoolNotificationHandler if there is one.
getNotificationLevel() - Method in interface com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler
Deprecated.
Returns the current add notification level.
getNumberOfAcceptors() - Static method in class com.pushtechnology.diffusion.api.APIProperties
getNumberOfClients() - Method in interface com.pushtechnology.diffusion.api.publisher.ClientMultiplexer
 
getNumberOfClients() - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Returns the number of currently connected Clients.
getNumberOfClients(ConnectionCategory) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Returns the number of currently Connected Clients of a specified category.
getNumberOfEntries() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPCache
Get the current number of entries in the cache.
getNumberOfLines() - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedTopicData
Deprecated.
Returns the current number of lines within the data.
getNumberOfMessages() - Method in interface com.pushtechnology.diffusion.api.statistics.MessageStatistics
Returns total number of messages.
getNumberOfMessagesReceived() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Deprecated.
getNumberOfMessagesSent() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Deprecated.
getNumberOfReadSelectors() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
since 5.9

this property will be removed in a future release

getNumberOfRequests() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Get the number of requests actioned since service started.
getNumberOfTopics() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
getNumberOfTopics() - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Returns the current number of Topics.
getOutboundMessageQueueDefinition() - Method in interface com.pushtechnology.diffusion.api.publisher.PublisherServerConnection
Deprecated.
Return the outbound queue definition name.
getOutboundMessageStatistics() - Method in interface com.pushtechnology.diffusion.api.statistics.ClientStatistics
Returns statistics detailing the Client's inbound messages.
getOutboundMessageStatistics() - Method in interface com.pushtechnology.diffusion.api.statistics.PublisherStatistics
Return statistics relating to messages sent out to clients.
getOutboundMessageStatistics() - Method in interface com.pushtechnology.diffusion.api.statistics.TopicStatistics
Returns the statistics relating to outbound messages from the Topic.
getOutboundPool() - Method in interface com.pushtechnology.diffusion.api.config.ThreadsConfig
Deprecated.
outbound thread pools are no longer used
getOutputBufferSize() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns the output buffer size.
getOutputBufferSize() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the output buffer size.
getOutputBufferSize() - Method in interface com.pushtechnology.diffusion.api.config.SocketConditioningConfig
Gets the output buffer size.
getOutputBufferSize() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the output buffer size for socket connection buffers and message sending buffers.
getOutputFrequency() - Method in interface com.pushtechnology.diffusion.api.config.ClientStatisticsConfig
Gets the output frequency.
getOutputStream() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns an OutputStream which may be used for writing bytes to the message.
getPagedData() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.9

This topic type will be removed in a future release

getParameter(String) - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequest
Get specified parameter.
getParent() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MNode
Returns the parent record (or message).
getParent() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns the parent node.
getPassword() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns the password.
getPassword() - Method in interface com.pushtechnology.diffusion.api.config.KeyStoreConfig
Gets the password.
getPassword() - Method in interface com.pushtechnology.diffusion.api.config.ManagementUserConfig
Deprecated.
Gets the password.
getPassword() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostRealmUserConfig
Gets the password.
getPassword() - Method in class com.pushtechnology.diffusion.api.Credentials
Returns the Password.
getPath() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostRealmConfig
Gets the realm path.
getPolicies() - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Get the list of configured conflation policies.
getPolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Get a named conflation policy.
getPolicy() - Method in interface com.pushtechnology.diffusion.api.config.TopicConflationPolicyConfig
Returns Conflation Policy.
getPolicyFile() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the policy file.
getPolicyForTopic(String) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Get the Conflation Policy that will be used for a specified Topic.
getPool(String) - Method in interface com.pushtechnology.diffusion.api.config.SelectorThreadPoolsConfig
Returns pool definition with the given name.
getPool(String) - Method in interface com.pushtechnology.diffusion.api.config.ThreadsConfig
Returns a named thread pool configuration.
getPools() - Method in interface com.pushtechnology.diffusion.api.config.ThreadsConfig
Get the list of thread pool definitions.
getPort() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the port.
getPort() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the value of the port property.
getPort() - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Gets the port.
getPort() - Method in class com.pushtechnology.diffusion.api.connection.HTTPProxyConnector
 
getPort() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the server port.
getPrincipal() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns the security principal.
getPriority() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Deprecated.
Since 5.8. The thread priority can no longer be configured.
getPriority() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
This returns the priority at which threads are to be executed.
getProductVersion() - Static method in class com.pushtechnology.diffusion.api.APIProperties
Deprecated.
getProductVersion() - Static method in class com.pushtechnology.diffusion.api.Utils
Returns the Diffusion Product Version.
getProperties() - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Gets list of Service properties.
getProperties() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Gets list of Publisher properties.
getProperties() - Method in interface com.pushtechnology.diffusion.api.config.ReporterConfig
Gets list of reporter propertie.
getProperties() - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Returns a copy of the map of the currently set definition properties.
getProperties() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPServiceDetails
Returns all of the service properties.
getProperty(String) - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Get a named property.
getProperty(String) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Get a named property.
getProperty(String) - Method in interface com.pushtechnology.diffusion.api.config.ReporterConfig
Get a named property.
getProperty(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Get a property.
getProperty(String, String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Get a property if it exists otherwise return a default value.
getProperty(String, String, String...) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Get a property if it exists and validate it against a set of allowed values.
getProperty(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is a convenience method to get a configured property value for this publisher.
getProperty(TopicProperty) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Returns the value of a Topic property.
getProperty(String) - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPServiceDetails
Returns the value of a specified property
getPropertyValue(String) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Gets the value of a named property as a String.
getProtoClassName() - Method in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
The full name of the proto class used to create this Topic data.
getProtocol() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the transport protocol.
getProtocolVersion() - Static method in class com.pushtechnology.diffusion.api.APIProperties
getProtocolVersion() - Method in interface com.pushtechnology.diffusion.api.ClientConnection
Returns the Diffusion protocol version used to communicate with the client.
getProtocolVersion() - Static method in class com.pushtechnology.diffusion.api.Utils
Deprecated.
Since 5.2. The protocol version now depends on the API and the server configuration. It can be obtained from the connection instance.
getProvider() - Method in interface com.pushtechnology.diffusion.api.config.ReplicationConfig
Get the provider for replication.
getProvider() - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Gets the provider class.
getProxyConnector() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the Proxy Connector.
getProxyProtocol() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Indicates the proxy protocol required for connection.
getPublisher(String) - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Returns a named publisher configuration.
getPublisherByName(String) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Returns a Publisher given its name.
getPublisherForTopic(Topic) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Returns the Publisher for a given topic.
getPublisherForTopic(String) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Returns the Publisher for a named Topic.
getPublisherName() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Returns the publisher's name.
getPublishers() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Returns the list of Publishers defined for this server.
getPublishers() - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Returns a list of all of the currently active Publishers.
getPublisherStatistics() - Method in interface com.pushtechnology.diffusion.api.config.StatisticsConfig
Get Publisher statistics configuration.
getPublishingData() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the Publishing Topic Data associated with the Topic (if any).
getQueue(String) - Method in interface com.pushtechnology.diffusion.api.config.QueuesConfig
Get a named queue definition.
getQueueDefinition() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the queue definition.
getQueueDefinition() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the queue definition name.
getQueueLowerThreshold() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolListenerConfig
Deprecated.
Returns the queue lower threshold.
getQueueLowerThreshold() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
If the pool is notifying then this will return the queue size at which the notification handler will be notified that the queue size has returned to the lower queue threshold after it had previously breached the upper threshold.
getQueueMaximumSize() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the maximum size of the task queue used by this pool.
getQueues() - Method in interface com.pushtechnology.diffusion.api.config.QueuesConfig
Get the list of configured queue definitions.
getQueues() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Gets the queues configuration details.
getQueueSize() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Returns the queue size.
getQueueSize() - Method in interface com.pushtechnology.diffusion.api.config.WriteSelectorConfig
Deprecated.
Get the maximum size of the event queue for each selector.
getQueueSize() - Method in interface com.pushtechnology.diffusion.api.message.ServerPingMessage
Deprecated.
Returns the size of the client queue.
getQueueSize() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the current size of the task queue used by this pool.
getQueueUpperThreshold() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolListenerConfig
Deprecated.
Returns the queue upper threshold.
getQueueUpperThreshold() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
If the pool is notifying then this will return the queue size at which the notification handler will be notified that the upper threshold of the queue has been reached.
getReader() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
This returns a reader which may be used to perform relative read operations on a message without affecting the pointers of the original message.
getRealm(String) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Get a named realm.
getRealms() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Gets the configured Realms.
getReconnect() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the Reconnect Configuration.
getReconnectTimeout() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns the reconnect timeout value.
getRecord(String) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MRecord
Gets a child record by name.
getRecoveryBufferSize() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns the recovery buffer size.
getRecoveryBufferSize() - Method in interface com.pushtechnology.diffusion.api.config.ReconnectConfig
Returns the maximum number of sent messages that can be recovered on reconnection.
getReference() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the Topic reference.
getReference() - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Returns the user defined reference value.
getRegistryPort() - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Gets the RMI registry port.
getRejectionHandler() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the current ThreadPoolRejectionHandler.
getRejectionHandlerClass() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Returns the rejection handler class name.
getRemoteAddress() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the remote address of the client.
getRemoteAddress() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequest
Get the remote address of the HTTP request.
getRemoteServer(String) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Deprecated.
getRemoteServers() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Deprecated.
getReplication() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Get replication configuration.
getReplication() - Method in interface com.pushtechnology.diffusion.api.config.SessionReplicationConfig
Deprecated.
since 5.6. It is expected that you will already have a reference to ReplicationConfig. This method will be removed in a future version of Diffusion.
getReplication() - Method in interface com.pushtechnology.diffusion.api.config.TopicReplicationConfig
Deprecated.
since 5.6. It is expected that you will already have a reference to ReplicationConfig. This method will be removed in a future version of Diffusion.
getReponseMessage() - Method in class com.pushtechnology.diffusion.api.data.service.ServiceResponse
Deprecated.
Returns the response message.
getReporter(String) - Method in interface com.pushtechnology.diffusion.api.config.StatisticsConfig
Get a specific Reporter config from the set of defined Reporters.
getReporters() - Method in interface com.pushtechnology.diffusion.api.config.StatisticsConfig
Return a list of all defined Reporters.
getRequestId() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicError
Deprecated.
Returns the request identifier of the failed service request.
getRequestId() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicResponse
Deprecated.
Return the request identifier.
getRequestId() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceRequest
Deprecated.
The request id for the request.
getRequestId() - Method in class com.pushtechnology.diffusion.api.data.service.ServiceResponse
Deprecated.
Returns request id.
getRequestMessage() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceRequest
Deprecated.
Returns the request message.
getRequestTimeout() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
Returns the current request timeout value.
getRequestType() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceRequest
Deprecated.
Returns the request type (or 'command').
getResetFrequency() - Method in interface com.pushtechnology.diffusion.api.config.ClientStatisticsConfig
Gets the reset frequency.
getResolvedName() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
Returns the resolved name.
getResolvedNames() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Get list of resolved names.
getResourceAsStream(String) - Static method in class com.pushtechnology.diffusion.api.Utils
Open for reading, a resource of the specified name from the search path used to load classes.
getResponseMessage() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicResponse
Deprecated.
Return details of the response in the form of a message containing headers and/or data returned from the server.
getResponseType() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicResponse
Deprecated.
Returns a response type.
getResponseType() - Method in class com.pushtechnology.diffusion.api.data.service.ServiceResponse
Deprecated.
Returns the response type.
getRetryDelay() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Get the retry delay value.
getRetryInterval() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
getRetryInterval() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the retry interval.
getRetryInterval() - Method in interface com.pushtechnology.diffusion.api.publisher.PublisherServerConnection
Deprecated.
Returns the retry interval.
getRoot() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns the root node.
getRootTopic() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the Topic at the top of this Topic's hierarchy.
getRotationPeriod() - Method in interface com.pushtechnology.diffusion.api.LogDescription
The time after which to rotate the log file.
getRotationTimeUnit() - Method in interface com.pushtechnology.diffusion.api.LogDescription
The time unit to be used, with value of LogDescription.getRotationPeriod(), to rotate the log file.
getRoutingData() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the Routing Topic Data associated with the Topic (if any).
getRoutingHandler() - Method in interface com.pushtechnology.diffusion.api.data.routing.RoutingTopicData
Returns the routing handler.
getScale() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MField
Returns the scale of the field.
getScanFrequency() - Method in interface com.pushtechnology.diffusion.api.config.AutoDeploymentConfig
Gets the scan frequency.
getSchema() - Method in interface com.pushtechnology.diffusion.api.publisher.XMLProperties
Deprecated.
Returns the properties schema.
getSecurity() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Gets the security configuration details.
getSelector() - Method in interface com.pushtechnology.diffusion.api.config.FanOutLinkConfig
Returns the link selector expression.
getSelectorThreadPoolDefinition() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the selector thread pool definition.
getSelectorThreadPools() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Gets the selector thread pools configuration.
getServer() - Method in interface com.pushtechnology.diffusion.api.config.ReplicationConfig
Deprecated.
since 5.6. It is expected that you will already have a reference to ServerConfig. This method will be removed in a future version of Diffusion.
getServerConfig() - Static method in class com.pushtechnology.diffusion.api.config.ConfigManager
This convenience method may be used when you know you are calling from within a server VM.
getServerConnection(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Deprecated.
getServerConnections() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Deprecated.
getServerDetails() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
getServerDetails() - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Returns the list of servers to be considered when connecting.
getServerDetails() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Returns the server details.
getServerLog() - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Gets the server log.
getServerName() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the server name.
getServerName() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Returns the server name.
getServerName() - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Returns the current Diffusion server name.
getServerProtocolVersion() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
getServerProtocolVersion() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Returns the Diffusion protocol version used for this connection.
getServerStatistics() - Method in interface com.pushtechnology.diffusion.api.config.StatisticsConfig
Get server statistics configuration.
getServiceData() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicHandler
Deprecated.
Returns a message containing any fixed data returned by the service on subscription.
getServiceData() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
Returns service data (if there is any).
getServiceHandler() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
Returns the handler of service requests.
getServiceType() - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicHandler
Deprecated.
Returns the service type.
getServiceType() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
This returns the service type.
getSessionReplication() - Method in interface com.pushtechnology.diffusion.api.config.ReplicationConfig
Get the configuration for the session replication.
getSetProperty(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Gets the value of a set property.
getShutdownHook() - Method in interface com.pushtechnology.diffusion.api.config.HooksConfig
Gets the shutdown hook.
getSize() - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Gets the size.
getSize() - Method in interface com.pushtechnology.diffusion.api.config.SelectorThreadPoolConfig
Returns the number of threads managed by this pool.
getSize() - Method in interface com.pushtechnology.diffusion.api.config.WriteSelectorConfig
Deprecated.
Get the number of write selectors.
getSize() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the current number of threads in the pool.
getSize() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPCache
Get the current cache size in bytes.
getSocketConditioning() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the Socket Conditioning Configuration.
getSSLContext() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the SSL Context (if set).
getStartTimeMillis() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the time that the client started in milliseconds.
getStartupHook() - Method in interface com.pushtechnology.diffusion.api.config.HooksConfig
Gets the startup hook class name.
getState() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
getState() - Method in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
Gets the current state of the data as a DynamicMessage.
getState() - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Gets the current state of the data as a List of Records.
getState() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Returns the current state of the connection.
getStateRecord(String, int) - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Gets the current state of a particular Record occurrence within the data.
getStatistics() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Get statistics configuration.
getStatistics() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Return the statistics for this client.
getStatistics() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Return the statistics for this publisher.
getStatistics() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Return the statistics for this topic.
getStatus() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the Topic status.
getStringProperty(TopicProperty) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Returns the value of a property as a String.
getSubscription(Topic) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns details of a Client's subscription to a given Topic.
getSubscriptionHandler() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.5

Consider using routing topics instead.

getSubscriptionValidationPolicies() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Get the subscription validation policies defined for the publisher.
getSubscriptionValidationPolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Get a named subscription validation policy that belongs to the publisher.
getSystemPingFrequency() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the system ping frequency.
getTargetTopicName() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
Returns target topic name (if set).
getTaskCount() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns the approximate total number of tasks that have ever been scheduled for execution.
getThreadPool(String) - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
Returns a named thread pool.
getThreadPoolDefinition() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the thread pool definition.
getThreadPoolListener() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Deprecated.
Since 5.8. Configuration of listeners is no longer supported and any configured listener will be ignored.
getThreadPools() - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
Returns the full list of currently defined thread pools.
getThreadPriority() - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Deprecated.
Since 5.8. The multiplexer thread priority can no longer be configured.
getThreadPriority() - Method in interface com.pushtechnology.diffusion.api.config.WriteSelectorConfig
Deprecated.
Get the thread priority of the write selectors.
getThreads() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Gets the Threads configuration.
getThreads() - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Gets the number of resolver threads.
getThrottler() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the current Client Throttler.
getTimeFormat() - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Returns the time format.
getTimeout() - Method in interface com.pushtechnology.diffusion.api.config.WriteSelectorConfig
Deprecated.
since 5.2, no longer used
getTimeouts() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Gets the timeouts configuration.
getTimeSinceCreation() - Method in interface com.pushtechnology.diffusion.api.message.PingMessage
Returns the amount of time between the message creation time and the current time.
getTimestamp() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequest
Return the request time.
getTimestampFormat() - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Returns the timestamp format.
getTopic() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Returns the Topic that the data belongs to.
getTopic(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
getTopic(TopicMessage) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
getTopic() - Method in interface com.pushtechnology.diffusion.api.topic.Subscription
Returns the Topic.
getTopic(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Returns a named Topic of the provider.
getTopic(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Returns the Topic belonging to the provider that matches a given Message.
getTopic(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTree
Gets a Topic.
getTopic(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Gets a child or descendant Topic of the current node.
getTopicData() - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceRequest
Deprecated.
Returns the topic data through which the request was invoked.
getTopicDataType() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MMessage
Identifies the data implementation type of the metadata.
getTopicForClient(String) - Method in interface com.pushtechnology.diffusion.api.data.routing.RoutingTopicData
Returns the real Topic mapped to for a particular client.
getTopicId() - Method in interface com.pushtechnology.diffusion.api.message.InternalTopicMessage
 
getTopicLoader(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
getTopicLoader(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Returns the Topic loader for a given Topic name.
getTopicName() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Returns the message topic name.
getTopicName() - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Returns the Topic name if this is a Topic Name Selector (i.e.
getTopicPath() - Method in interface com.pushtechnology.diffusion.api.message.InternalTopicMessage
 
getTopicPaths() - Method in interface com.pushtechnology.diffusion.api.config.TopicReplicationConfig
The topic paths that will be used to match topics to replicate.
getTopicPolicies() - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Get a list of all Topic to Conflation Policy conflation mappings.
getTopicPolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Get the Topic Conflation Policy for a given topic pattern.
getTopicProvider() - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Returns the Topic Provider that owns the group.
getTopicProvider() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Returns the Topic Provider that owns this topic.
getTopicReplication() - Method in interface com.pushtechnology.diffusion.api.config.ReplicationConfig
Get the configuration for the topic replication.
getTopics() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Gets the list of Topics to automatically register.
getTopics() - Method in interface com.pushtechnology.diffusion.api.config.SubscriptionValidationPolicyConfig
Get the list of topics mapped to this policy.
getTopics() - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Returns the default list of Topics to subscribe to on connection.
getTopics() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the default list of Topics to subscribe to on connection.
getTopics() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
getTopics() - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Returns a list of Topics that the Client is currently subscribed to.
getTopics() - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Returns a list of the provider's Topics.
getTopics() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns any child Topics of this Topic node.
getTopics(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns a set of Topics that are children/descendants of this node that match with a supplied Topic 'specifier'.
getTopics(TopicSet) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns a set of Topics that are children/descendants of this node.
getTopics(Collection<TopicSelector>) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns a set of Topics that match one or more of a given set of selectors.
getTopics(TopicSelector) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns a set of Topics that match a given selector relative to this node.
getTopicSelector() - Method in interface com.pushtechnology.diffusion.api.config.TopicConflationPolicyConfig
Get the topic name or topic selector pattern.
getTopicStateMessage(Topic) - Method in class com.pushtechnology.diffusion.api.topic.CachedTopicLoader
Get the current state of the Topic
getTopicStatistics() - Method in interface com.pushtechnology.diffusion.api.config.StatisticsConfig
Get topic statistics configuration.
getTopicTree() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
getTopicTree() - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
This returns the topic tree which is the root of the topic hierarchy.
getTopicTree() - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Returns the provider's Topic Tree.
getTopicType() - Method in interface com.pushtechnology.diffusion.api.data.UniversalTopicData
Returns the topic type.
getTotalNumberOfLines() - Method in interface com.pushtechnology.diffusion.api.client.paging.PageStatus
Deprecated.
Returns the total number of lines in the data.
getTotalNumberOfSubscribers() - Method in interface com.pushtechnology.diffusion.api.statistics.TopicStatistics
Returns the total number of subscribers for the Topic.
getType() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the connector type.
getType() - Method in interface com.pushtechnology.diffusion.api.config.MimeConfig
Returns the associated mime type.
getType() - Method in interface com.pushtechnology.diffusion.api.config.PropertyConfig
Gets the type.
getType() - Method in interface com.pushtechnology.diffusion.api.config.ReporterConfig
Gets the reporter's type.
getType() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Gets the policy type.
getType() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Returns the type of Topic Data.
getType() - Method in interface com.pushtechnology.diffusion.api.publisher.ClientThrottler
Returns the Throttler type.
getType() - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Returns the topic type.
getType() - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Returns the selector type
getType() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsData
Returns the object type.
getTypeCode() - Method in enum com.pushtechnology.diffusion.api.data.TopicDataType
Returns a one or two character code representing the type.
getUpdateMode() - Method in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
Returns the update mode.
getUpperQueueNotificationThreshold() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the upper queue notification threshold operating for the connection.
getUpperThreshold() - Method in interface com.pushtechnology.diffusion.api.config.QueueConfig
Gets the upper threshold.
getUptime() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the time that the client has been connected as a displayable string.
getUptimeMillis() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the time that the client has been connected in milliseconds.
getUrl() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns the URL of the primary server to connect to.
getURL() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequest
Returns the request URL.
getURLConnection(URL, Properties) - Static method in class com.pushtechnology.diffusion.api.HTTPUtils
Gets a URL Connection.
getUrlPattern() - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Gets the URL pattern.
getUser(String) - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Deprecated.
Remote JMX users should be configured in the system authentication store, or with a custom authentication handler.
getUser(String) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostRealmConfig
Gets a named realm user.
getUserLibraries() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Gets the user library configuration.
getUsername() - Method in class com.pushtechnology.diffusion.api.Credentials
Returns the User Name.
getUsers() - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Deprecated.
Remote JMX users should be configured in the system authentication store, or with a custom authentication handler.
getUsers() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostRealmConfig
Gets the realm users.
getValidationPolicyFile() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the validation policy file.
getValue() - Method in interface com.pushtechnology.diffusion.api.config.PropertyConfig
Gets the property value.
getValue() - Method in interface com.pushtechnology.diffusion.api.data.single.SingleValueTopicData
Returns the current value of the data.
getValue(String) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsData
Returns a value for the specified key.
getValues(String) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsData
Returns all values whose key has a given prefix.
getVirtualHost(String) - Method in interface com.pushtechnology.diffusion.api.config.FileServiceConfig
Get a named virtual host configuration.
getVirtualHosts() - Method in interface com.pushtechnology.diffusion.api.config.FileServiceConfig
Get Virtual Hosts configured.
getWebServer() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the Web Server name.
getWebServer(String) - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Get a named Web Server configuration.
getWebServerName() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPServiceDetails
Returns the Web Server Name.
getWebServerName() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Returns the web server name
getWebServers() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Gets the list of configured web servers.
getWebsocketOrigin() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Gets the web socket origin.
getWhois() - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Gets the WhoIs configuration details.
getWhoIsData() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
Returns WhoIs data associated with the Internet address.
getWhoIsDetails() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Returns the WhoIs details of the client as determined by the WhoIs service.
getWriteSelectors() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
write selector configuration is not used since 5.3
getWriteTimeout() - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Returns the write timeout.
getWriteTimeout() - Method in interface com.pushtechnology.diffusion.api.config.FileServiceConfig
Gets the write timeout value.
getWriteTimeout() - Method in interface com.pushtechnology.diffusion.api.config.TimeoutsConfig
Gets the write timeout value.
getWriteTimeout() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Returns the write timeout value.

H

handleHTTPRequest(HTTPVirtualHost, HTTPRequest) - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequestListener
Handle a received HTTP request.
handleHTTPRequest(HTTPRequest) - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPServiceHandler
Handle a received HTTP request.
handleTopicMessage(MessageSource, TopicMessage) - Method in interface com.pushtechnology.diffusion.api.topic.TopicListener
Handles a Message received from a MessageSource.
hasChanges() - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
This is called to determine whether there have been any changes to the state of the data during the current update block.
hasChanges() - Method in class com.pushtechnology.diffusion.api.data.custom.SimpleCustomTopicDataHandler
Deprecated.
 
hasChanges() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
This can be called during an update block to determine whether the data has been updated.
hasCommandData() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.9

All command topics will be removed in a future release

hasData() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Indicates whether the Topic has data.
hashCode() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
 
hashCode() - Method in class com.pushtechnology.diffusion.api.message.Record
hashCode() - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
 
hashCode() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns the hashCode of the full hierarchic name of the tree node.
hasHostNames() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
 
hasLocales() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Indicates whether any locales have been defined.
hasMaximum() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Indicates whether there is a maximum number of occurrences (i.e.
hasMetadata() - Method in enum com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler.NotificationLevel
Deprecated.
Indicates whether the notification level includes metadata
hasPagedData() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.9

This topic type will be removed in a future release

hasProperties() - Method in enum com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler.NotificationLevel
Deprecated.
Indicates whether the notification level includes properties.
hasProperties() - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Test to see if there are any properties.
hasProperty(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Indicates whether a property with the given name has been configured for this publisher
hasPublishingData() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Indicates whether the Topic has data of type PublishingTopicData.
hasRemaining() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Indicates whether the message has any remaining data to read.
hasRemaining() - Method in interface com.pushtechnology.diffusion.api.message.MessageReader
Indicates whether the message has any remaining data to read.
hasResolvedNames() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Returns true if any resolved names have been defined.
hasRoutingData() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Indicates whether the Topic has data of type RoutingTopicData.
hasServerConnection(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Deprecated.
hasSlaves() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Does this topic data currently have any slaves.
hasSubscribers() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
hasSubscribers() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Indicates whether the Topic currently has subscribers.
hasTopic(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Indicates whether the node has a subordinate Topic matching the given full hierarchic Topic name.
hasTopics() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Indicates whether this node has subordinate Topics.
HooksConfig - Interface in com.pushtechnology.diffusion.api.config
Server user hooks configuration.
HTTPCache - Interface in com.pushtechnology.diffusion.api.webserver
Cache used by an HTTPVirtualHost.
HTTPProxyConnector - Class in com.pushtechnology.diffusion.api.connection
Provides for connection to a Diffusion Server via an HTTP Proxy Server.
HTTPProxyConnector() - Constructor for class com.pushtechnology.diffusion.api.connection.HTTPProxyConnector
Create a Proxy Connector with no properties set.
HTTPProxyConnector(String, int) - Constructor for class com.pushtechnology.diffusion.api.connection.HTTPProxyConnector
Create a Proxy Connector with specified host and port.
HTTPRequest - Interface in com.pushtechnology.diffusion.api.webserver
Details of an HTTP Request from a web server.
HTTPRequestListener - Interface in com.pushtechnology.diffusion.api.webserver
This is the interface for listeners to HTTP related events.
HTTPResponse - Class in com.pushtechnology.diffusion.api.webserver
HTTPResponse
HTTPResponse() - Constructor for class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Creates an HTTP Response object
HTTPServiceConfig - Interface in com.pushtechnology.diffusion.api.config
Web Server HTTP Service Config.
HTTPServiceDetails - Interface in com.pushtechnology.diffusion.api.webserver
The details associated with an HTTP Service.
HTTPServiceHandler - Interface in com.pushtechnology.diffusion.api.webserver
This is the interface for user written HTTP services as defined in WebServer.xml.
HTTPUtils - Class in com.pushtechnology.diffusion.api
HTTP Utilities.
HTTPVirtualHost - Interface in com.pushtechnology.diffusion.api.webserver
An HTTP Virtual Host within a file service.

I

initialise(TopicMessage) - Method in class com.pushtechnology.diffusion.api.data.custom.AbstractCustomTopicDataHandler
Deprecated.
 
initialise(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
initialise(AbstractMessage) - Method in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
Initialises the data with values from an input Protocol Buffers Message.
initialise(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Initialises the data from a supplied message.
initialise(Record...) - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Initialises one or more Record occurrences within the data.
initialise(Collection<Record>) - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Initialises one or more Record occurrences within the data.
initialise(Record, int) - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Initialises an occurrence of a Record within the data from a Record with matching metadata.
initialise(Object) - Method in interface com.pushtechnology.diffusion.api.data.single.SingleValueTopicData
Initialises the data to a specified value.
initialise(String, TopicTreeNode, PublishingTopicData) - Method in interface com.pushtechnology.diffusion.api.data.TopicDataInitialiser
This is called just before the data is attached to a topic in order to perform initialisation of the data.
initialise(V) - Method in interface com.pushtechnology.diffusion.api.data.UniversalTopicData
Initialise the topic data.
initialLoad() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is called when the publisher is started to perform initial publisher load actions as required.
internalDuplicate() - Method in interface com.pushtechnology.diffusion.api.message.InternalTopicMessage
Clone this message.
internalDuplicate(String, int) - Method in interface com.pushtechnology.diffusion.api.message.InternalTopicMessage
Copy this message to one of the same type but for a different topic.
InternalTopicMessage - Interface in com.pushtechnology.diffusion.api.message
Internal topic message contract.
intersect(ClientGroup) - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Returns a temporary client group which is the intersection between the two groups.
IOUtils - Class in com.pushtechnology.diffusion.api
Utility class for basic input output operations.
isAckPending() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
This indicates whether an inbound message that required acknowledgement is yet to be acknowledged.
isAckRequired() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Indicates whether the 'ACK Required' flag is set for the message.
isAsyncLogging() - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Is async logging option set?
isAutoAck() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Gets the value of the autoAck property.
isAutoAcknowledging() - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Indicates whether connections should automatically acknowledge inbound Messages that require acknowledgement.
isAutoAcknowledging() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Indicates whether the Connection is set to automatically acknowledge inbound Messages that require acknowledgement.
isAutoFailover() - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Indicates whether the 'Auto Failover' option is set.
isAutomatic() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Is automatic option set?
isAutoStart() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Is auto start set?
isAutoSubscribing() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Deprecated.
since 5.5, auto-subscription is always enabled
isCascading() - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Indicates whether the 'Cascading' option is set.
isCategory(ConnectionCategory) - Method in interface com.pushtechnology.diffusion.api.ConnectionType
Indicates whether the Connection Type is of a specified.
isClient() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Indicates whether a client config.
isClosed() - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Indicates whether the group is closed.
isClosed() - Method in interface com.pushtechnology.diffusion.api.topic.Subscription
Indicates whether the subscription is still current.
isClosingCallbackRequests() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Deprecated.
since Diffusion 5.7. This method will be removed in a future release.
isCommand() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5 use instanceof CommandTopicData
isCompressionEnabled() - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Indicates whether compression is enabled
isConflating() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Indicates whether the outbound message queue is currently conflating messages.
isConnected() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
isConnected() - Method in interface com.pushtechnology.diffusion.api.ClientConnection
Returns true when the client is connected.
isConnected() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Is the connection connected?
isConnection() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
isConnectionValid(InetSocketAddress, Locale) - Method in interface com.pushtechnology.diffusion.api.config.ConnectionValidationPolicyConfig
Check to see if a remote address and locale are valid for this policy.
isCookieDisabled() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Is the session cookie disabled?
isDebug() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Is debug set?
isDebug() - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Is debug set?
isDebug() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostCacheConfig
Is debug set?
isDebug() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Is debug set?
isDebug() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPCache
Is debug set?
isDebug() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPServiceDetails
Is debug set?
isDebug() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Indicates whether debug is set
isDelta() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Returns true if a delta message.
isDeltaAckRequired() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Indicates whether delta messages generated will require acknowledgment (see PublishingTopicData.setLoadAckRequired(boolean).
isDirty() - Method in interface com.pushtechnology.diffusion.api.client.paging.PageStatus
Deprecated.
Returns whether the page is 'dirty', meaning that has been returned for it is currently out of date and the page needs to be refreshed.
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.ClientStatisticsConfig
Are statistics enabled?
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.GeoIpConfig
Is Geo Ip enabled?
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Whether or not the external JMX Connector is enabled or not.
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Is the Publisher enabled?
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.PublisherStatisticsConfig
Is statistics enabled?
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.ReplicationConfig
Is replication enabled.
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.ReporterConfig
If the StatisticsReporter is enabled.
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.ServerStatisticsConfig
Is statistics enabled?
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.SessionReplicationConfig
Is session replication enabled for the server.
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.StatisticsConfig
Is statistics gathering enabled?
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.TopicReplicationConfig
Is topic replication enabled for the server.
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.TopicStatisticsConfig
Is statistics enabled?
isEnabled() - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Indicates whether the WhoIs service is enabled.
isEnabled() - Method in class com.pushtechnology.diffusion.api.whois.GeoIPUtils
Indicates whether the GeoIP service is enabled.
isFetchReply() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Is this message a response to a 'fetch' request?
isField() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MNode
Indicates whether the node is a field.
isFileAppend() - Method in interface com.pushtechnology.diffusion.api.LogDescription
Specifies whether log records should be appended to existing log files.
isFixed() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Indicates whether this is a fixed multiplicity (i.e.
isFor(String) - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Indicates whether the message is for a named topic or topic pattern.
isForTopic(String) - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Indicates whether the message is for a named topic.
isInstanceMonitoringEnabled() - Method in interface com.pushtechnology.diffusion.api.config.ClientStatisticsConfig
Is statistics for Client instances enabled?
isInstanceMonitoringEnabled() - Method in interface com.pushtechnology.diffusion.api.config.PublisherStatisticsConfig
Is statistics for Publisher instances enabled?
isInstanceMonitoringEnabled() - Method in interface com.pushtechnology.diffusion.api.config.TopicStatisticsConfig
Is statistics for Topic instances enabled?
isKeepAlive() - Method in interface com.pushtechnology.diffusion.api.config.SocketConditioningConfig
Is TCP keep alive set?
isLoadAckRequired() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Indicates whether load messages generated will require acknowledgement (see PublishingTopicData.setLoadAckRequired(boolean).
isLoadbalancing() - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Indicates whether 'Load Balancing' is set.
isLocal() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
Returns true if this is a local address.
isLockable() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.6

All API topic locking methods are deprecated and will be removed in a future release, see Topic.lock() for details. Since 5.9, a;; topics are lockable therefore this will always return true.

isLocked() - Method in interface com.pushtechnology.diffusion.api.config.Config
Indicates whether the configuration object is locked.
isLockedByCurrentThread() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5. All API topic locking methods are deprecated and will be removed in a future release, see TopicData.lock() for details.
isLockedByCurrentThread() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.6

All API topic locking methods are deprecated and will be removed in a future release, see Topic.lock() for details.

isLoggingMessageData() - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Deprecated.
since 5.5

use RootConfig.isLoggingMessageData() instead

isLoggingMessageData() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Is log message data option set?
isLoggingThreadNames() - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Is thread name logging option set?
isLoopback() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
Returns true if this is a loopback address.
isMandatory() - Method in interface com.pushtechnology.diffusion.api.config.KeyStoreConfig
Is keyStore mandatory?
isMessage() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MNode
Indicates whether the node is a top level message.
isMessageQueueLimitReached() - Method in enum com.pushtechnology.diffusion.api.publisher.ClientCloseReason
isMetadataMandatory() - Method in interface com.pushtechnology.diffusion.api.data.TopicDataWithMetadata
Indicates whether Metadata is mandatory for the TopicData type.
isMinify() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Is minify option set?
isMinify() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Indicates whether the minify property is set
isNoDelay() - Method in interface com.pushtechnology.diffusion.api.config.SocketConditioningConfig
Is TCP no delay option set?
isNotifying() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Returns true if the thread pool is notifying events.
isNotifyingRemoval() - Method in interface com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler
Deprecated.
Indicates whether notifying topic removals.
isNotifyingUpdate() - Method in interface com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler
Deprecated.
Indicates whether notifying topic property updates
isOrdered() - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedTopicData
Deprecated.
Indicates whether the lines within the data are maintained in a sorted order according to a specified Comparator.
isPaged() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5 use instanceof PagedTopicData
isPagedLoad() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Deprecated.
since 5.9

This topic type will be removed in a future release

isPagedRecord() - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedTopicData
Deprecated.
Indicates whether this is type PagedRecordTopicData.
isPagedString() - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedTopicData
Deprecated.
Indicates whether this is type PagedStringTopicData.
isPublishing() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5 use instanceof PublishingTopicData
isReadOnly() - Method in interface com.pushtechnology.diffusion.api.config.ManagementUserConfig
Deprecated.
Is user read only?
isReconnected() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
isReconnected() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
This indicates whether the current connection represents a reconnection of a previous connection.
isRecord() - Method in interface com.pushtechnology.diffusion.api.client.paging.Lines
Deprecated.
Indicates whether the lines are Record format.
isRecord() - Method in interface com.pushtechnology.diffusion.api.data.metadata.MNode
Indicates whether the node is a record.
isRecoverable() - Method in enum com.pushtechnology.diffusion.api.publisher.ClientCloseReason
Is the state recoverable - i.e.
isRemoteAddressValid(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectionValidationPolicyConfig
Check to see if the specified IP address is valid for the this policy.
isRepeating() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Indicates whether this is a 'repeating' multiplicity meaning it defines more than one possible occurrence.
isRequired() - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Gets the boolean value specifying if the connector is required.
isResolved() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Indicates whether WhoIsDetails have been resolved.
isReuseAddress() - Method in interface com.pushtechnology.diffusion.api.config.SocketConditioningConfig
Is reuse address option set?
isRoot() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns true if this is the root node in the tree.
isRotatedDaily() - Method in interface com.pushtechnology.diffusion.api.LogDescription
Indicates whether to rotate daily.
isRouting() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5 use instanceof RoutingTopicData
isSecure() - Method in interface com.pushtechnology.diffusion.api.ClientConnection
Indicates whether connected over a secure connection (e.g.
isSecureConnection() - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Indicates whether the connection will use SSL.
isServer() - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Indicates whether a server config.
isService() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5 use instanceof ServiceTopicData
isServiceLoad() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Deprecated.
since 5.9

This topic type will be removed in a future release

isSimpleTopicNameSelector() - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Is the selector a simple topic name selector that selects only a named topic and not it's children.
isSingle() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Indicates whether this is 'single' multiplicity meaning that only 1 (or 0 if optional) occurrence can exist.
isSingleOptional() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Indicates whether this is a 'single optional' multiplicity (i.e.
isSingleRequired() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Indicates whether this is a 'single required' multiplicity (i.e.
isSlave() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Deprecated.
since 5.5 as it provides not information over the topic data type
isSSL() - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Gets the value of the ssl property.
isStarted() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Indicates whether the publisher is in a 'started' state.
isStarted() - Method in class com.pushtechnology.diffusion.api.server.DiffusionServer
 
isStarted() - Method in interface com.pushtechnology.diffusion.api.server.EmbeddedDiffusion
 
isStatic() - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Is static set?
isStatic() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Indicates whether static
isStatisticsEnabled() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Indicates whether Statistics reporting for this Client is enabled or not.
isStatisticsEnabled() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Indicates whether Statistics reporting for this Publisher is enabled or not.
isStatisticsEnabled() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Indicates whether Statistics reporting for this Topic is enabled or not.
isStoppable() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Can we stop this publisher?
isStopped() - Method in class com.pushtechnology.diffusion.api.server.DiffusionServer
 
isStopped() - Method in interface com.pushtechnology.diffusion.api.server.EmbeddedDiffusion
 
isStopServerIfNotLoaded() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Indicates whether to stop server if publisher does not load.
isString() - Method in interface com.pushtechnology.diffusion.api.client.paging.Lines
Deprecated.
Indicates whether the lines are String format.
isSubscribed(Topic) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Indicates whether the client is currently subscribed to a given Topic.
isSubscription() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
isThrottled() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Indicates whether the Client currently has a throttler configured.
isTopic() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Returns true if this node is a Topic.
isTopicAliasing() - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Indicates whether topic aliasing.
isTopicAliasing() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
isTopicAliasing() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
isTopicAliasing() - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Indicates whether Topic aliasing is turned on for the Topic provider.
isTopicLoad() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Returns true if a Topic Load message.
isTopicMessage() - Method in interface com.pushtechnology.diffusion.api.message.Message
Returns true if this is a topic message.
isTopicName(String) - Static method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Checks if a supplied string is a valid topic name (as opposed to a topic selector).
isTopicNameSelector() - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Does this selector refer to a specific Topic.
isTopicNotifyLoad() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Deprecated.
since 5.9

This topic type will be removed in a future release

isValidatingChildren() - Method in interface com.pushtechnology.diffusion.api.config.SubscriptionValidationPolicyConfig
Is validate children option set?
isValidSelector(String) - Static method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Check if the supplied string is a valid topic selector.
isValidTopicNameCharacter(char) - Static method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Checks if a supplied character is allowed in a full Topic name.
isValidTopicNodeName(String) - Static method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Validates a topic node name to ensure that it does not contain invalid characters.
isValidTopicNodeNameCharacter(char) - Static method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Checks if a supplied character is allowed in a Topic node name.
isVariable() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Indicates whether this is variable multiplicity (i.e.
isWebsocketSecureResponse() - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Deprecated.
Setting is ignored. It applied to behavior defined by draft versions of the WebSocket specification that is no longer supported.
isXmlFormat() - Method in interface com.pushtechnology.diffusion.api.LogDescription
Indicates whether the log file should be output in XML format.

J

join(List<? extends CharSequence>, String) - Static method in class com.pushtechnology.diffusion.api.Utils
Joins all of a list into a string, and returns the string.
join(String[], String) - Static method in class com.pushtechnology.diffusion.api.Utils
Joins an array of Strings to make a single string

K

keys() - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsData
Returns the set of keys.
KeyStoreConfig - Interface in com.pushtechnology.diffusion.api.config
KeyStore configuration for a connector.

L

LAST_MODIFIED - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Last-Modified header
length() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns the length of the data within the message in bytes.
Lines - Interface in com.pushtechnology.diffusion.api.client.paging
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

lines() - Method in interface com.pushtechnology.diffusion.api.client.paging.Lines
Deprecated.
Returns the lines in String format.
LIST_DELIMITER - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Byte value reserved for use as a list delimiter used for separating the elements of a list in character based Messages.
LIST_DELIMITER_CHAR - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Character representation of Message.LIST_DELIMITER.
LIST_DELIMITER_STRING - Static variable in interface com.pushtechnology.diffusion.api.message.Message
String representation of Message.LIST_DELIMITER.
load(TopicClient, Topic) - Method in class com.pushtechnology.diffusion.api.topic.CachedTopicLoader
Cached Topic load implementation.
load(TopicClient, Topic) - Method in class com.pushtechnology.diffusion.api.topic.SimpleTopicLoader
Simple Implementation of TopicLoader.load(TopicClient, Topic)
load(TopicClient, Topic) - Method in interface com.pushtechnology.diffusion.api.topic.TopicLoader
This is used to perform the Topic Load processing for a Client when requested.
LOADED - Static variable in interface com.pushtechnology.diffusion.api.publisher.XMLPropertiesListener
Deprecated.
Mask setting for Properties loaded notification.
loadProperties(String) - Static method in class com.pushtechnology.diffusion.api.Utils
Load properties from a resource of the specified name from the search path used to load classes.
loadPublisher(PublisherConfig) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Loads a Publisher from a given PublisherConfig.
LOCATION - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Location header
lock() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5. All API topic locking methods are deprecated and will be removed in a future release. There is no reason for applications to lock topics with topic data. Multiple updates to topic data can be grouped using PublishingTopicData.startUpdate() / PublishingTopicData.endUpdate().
lock() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.6

All API topic locking methods are deprecated and will be removed in a future release.

In previous releases it was necessary to lock a stateless topic before broadcasting a message to prevent a race condition where the message could be delivered to a new subscriber before topic load messages sent by a publisher. From release 5.6, this locking is no longer necessary. The server will ensure messages published to a new subscriber from a Publisher.subscription() notification will be delivered to the subscriber before subsequent broadcasts.

log(Level, String, Throwable) - Method in interface com.pushtechnology.diffusion.api.LogWriter
Deprecated.
Prefer the SLF4J API for logging.
LogConfig - Interface in com.pushtechnology.diffusion.api.config
Log Configuration.
LogDescription - Interface in com.pushtechnology.diffusion.api
The interface for the definition of a Log.
LogDescription.LogLevel - Enum in com.pushtechnology.diffusion.api
Log Level.
LoggingConfig - Interface in com.pushtechnology.diffusion.api.config
Logging Configuration.
Logs - Class in com.pushtechnology.diffusion.api
Logging Utilities.
LogWriter - Interface in com.pushtechnology.diffusion.api
This is the interface to a Diffusion logger which allows log messages to be written to Diffusion logs.

M

main(String...) - Static method in class com.pushtechnology.diffusion.api.server.DiffusionServer
This can be invoked to run free standing.
Manageable - Interface in com.pushtechnology.diffusion.api.management
Deprecated.
since 5.6
Management - Class in com.pushtechnology.diffusion.api.management
Deprecated.
since 5.6 in favour of methods available through the JVM runtime.
ManagementConfig - Interface in com.pushtechnology.diffusion.api.config
Management Configuration.
ManagementUserConfig - Interface in com.pushtechnology.diffusion.api.config
Deprecated.
Remote JMX users should be configured in the system authentication store, or with a custom authentication handler.
matches(TopicMessage, TopicMessage) - Method in interface com.pushtechnology.diffusion.api.conflation.MessageMatcher
Compares two messages to determine whether they can be conflated.
matches(String) - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
This does a match to check if a specified topic name (or name subset) matches with the selector.
MDataType - Enum in com.pushtechnology.diffusion.api.data.metadata
Data Types supported by Diffusion Generic Metadata.
merge(TopicMessage, TopicMessage) - Method in interface com.pushtechnology.diffusion.api.conflation.MessageMerger
Merges the content of two messages to produce a new message.
Message - Interface in com.pushtechnology.diffusion.api.message
This is the super interface for all Diffusion messages.
MESSAGE_SEPARATOR - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Byte value reserved for delimiting multiple character based Messages in buffers.
MESSAGE_SEPARATOR_CHAR - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Character representation of Message.MESSAGE_SEPARATOR.
MessageException - Exception in com.pushtechnology.diffusion.api.message
An exception returned by the Diffusion Message API.
MessageException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.api.message.MessageException
Create a new MessageException.
MessageException(String) - Constructor for exception com.pushtechnology.diffusion.api.message.MessageException
Create a new MessageException.
MessageFilter - Interface in com.pushtechnology.diffusion.api.message
A Message Filter is an object that can select a message for processing or even change the Message that is to be processed.
messageFromClient(TopicMessage, Client) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is called when a message has been received from a client.
messageFromServer(ServerConnection, TopicMessage) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Notification of a message from another Server.
messageFromServer(ServerConnection, TopicMessage) - Method in interface com.pushtechnology.diffusion.api.ServerConnectionListener
Deprecated.
Notification of a message from the Server.
MessageMatcher - Interface in com.pushtechnology.diffusion.api.conflation
Message Matcher interface
MessageMerger - Interface in com.pushtechnology.diffusion.api.conflation
Message Merger interface
messageNotAcknowledged(TopicMessage, List<TopicClient>) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
messageNotAcknowledged(ServerConnection, TopicMessage) - Method in interface com.pushtechnology.diffusion.api.ServerAckListener
Deprecated.
This is a notification of non acknowledgement of a message that required acknowledgement by the Server.
messageNotAcknowledged(TopicMessage, List<TopicClient>) - Method in interface com.pushtechnology.diffusion.api.topic.ClientAckListener
This is a notification of non acknowledgement of a message that required acknowledgement by one or more Clients.
MessagePriority - Enum in com.pushtechnology.diffusion.api.message
Indicates the delivery priority of a Message.
MessageReader - Interface in com.pushtechnology.diffusion.api.message
A Message Reader provides a 'read only' view of a DataMessage which allows 'relative' reading of the message without affecting the original message pointers.
MessageSource - Interface in com.pushtechnology.diffusion.api.message
A message source is an object through which inbound messages are passed to an application.
MessageSourceType - Enum in com.pushtechnology.diffusion.api.message
Identifies the type of a MessageSource.
MessageStatistics - Interface in com.pushtechnology.diffusion.api.statistics
Read-only aggregate Message statistics.
MetadataFactory - Class in com.pushtechnology.diffusion.api.data.metadata
This factory class allows for the creation of message metadata for metadata modelling.
MField - Interface in com.pushtechnology.diffusion.api.data.metadata
The interface for a metadata field node.
millisNumberConverter(String) - Static method in class com.pushtechnology.diffusion.api.Utils
Append the letter h or H to indicate hours, or m or M to indicate minutes or s or S to indicate seconds
MimeConfig - Interface in com.pushtechnology.diffusion.api.config
Mime Configuration.
MimesConfig - Interface in com.pushtechnology.diffusion.api.config
Mimes - as used in Web server file services.
MMessage - Interface in com.pushtechnology.diffusion.api.data.metadata
Interface for 'message' metadata node.
MNode - Interface in com.pushtechnology.diffusion.api.data.metadata
Base interface for all metadata nodes.
MRecord - Interface in com.pushtechnology.diffusion.api.data.metadata
The interface for a metadata record node.
MULTIPLEXER_LATENCY_WARNING - Static variable in interface com.pushtechnology.diffusion.api.publisher.MultiplexerLatencyListener
Default multiplexer latency warning 2048.
MultiplexerConfig - Interface in com.pushtechnology.diffusion.api.config
Configuration of a set of Multiplexers.
MultiplexerConfig.LoadBalancer - Enum in com.pushtechnology.diffusion.api.config
Indicates the load balancing algorithm for the Multiplexer.
MultiplexerLatencyListener - Interface in com.pushtechnology.diffusion.api.publisher
Listener for multiplexer latency notifications.
multiplexerLatencyWarning(ClientMultiplexer, long) - Method in interface com.pushtechnology.diffusion.api.publisher.MultiplexerLatencyListener
Warns of a multiplexer exceeding it's configured latency execution time.
Multiplicity - Class in com.pushtechnology.diffusion.api.data.metadata
Defines the multiplicity of a metadata field or record node within its parent message or record.
Multiplicity(int) - Constructor for class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Creates a fixed multiplicity (where there are a fixed number of occurrences).
Multiplicity(int, int) - Constructor for class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Creates a range multiplicity.

N

NAME_DELIMITER - Static variable in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
The delimiter used to separate Topic tree name elements.
NEW_CREDENTIALS - Static variable in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Client new credentials mask setting
newChildListData() - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Deprecated.
since 5.9

This topic type will be removed in a future release

newCustomData(CustomTopicDataHandler) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Deprecated.
since 5.9

This topic type will be removed in a future release

newCustomFieldMetadata(CustomFieldHandler) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
Create a single custom metadata field with an automatically generated unique name.
newCustomFieldMetadata(String, CustomFieldHandler) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
Create a single custom metadata field.
newCustomFieldMetadata(String) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
Create a single custom metadata field with an automatically generated unique name.
newCustomFieldMetadata(String, String) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
Create a single custom metadata field.
newDateFormat() - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Create a Date Format object based upon the specified date format.
newDateTimeFormat() - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Create a Date Format object based upon the specified data and time format.
newFieldMetadata(MDataType) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
This is a convenience method for constructing a single metadata field with an automatically generated unique name.
newFieldMetadata(String, MDataType) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
This is a convenience method for constructing a single metadata field.
newMessageMetadata(String) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
Create a new empty message metadata node of type Record for metadata modeling.
newMetadata(String, TopicDataType) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
newPagedRecordData(MRecord) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Deprecated.
since 5.9

This topic type will be removed in a future release

newPagedRecordData(MRecord, Comparator<Record>) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Deprecated.
since 5.9

This topic type will be removed in a future release

newPagedStringData() - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Deprecated.
since 5.9

This topic type will be removed in a future release

newPagedStringData(Comparator<String>) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Deprecated.
since 5.9

This topic type will be removed in a future release

newPBData(String, String) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Deprecated.
since 5.7.

Support for Google Protocol Buffers topics will be removed in a future release as universal topic data of type BINARY can be used to distribute protocol buffer messages.

newRecordData(MMessage) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Create new Record Topic Data.
newRecordMetadata(String) - Static method in class com.pushtechnology.diffusion.api.data.metadata.MetadataFactory
This is a convenience method for creating Record metadata.
newRoutingData(RoutingTopicDataSubscriptionHandler) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Create new Routing Topic Data.
newServiceData(String, ServiceHandler) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Deprecated.
since 5.7

Messaging is a better alternative to service topics for sending point-to-point requests.

newSingleValueCustomData(CustomFieldHandler) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
newSingleValueData(MField) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
newSingleValueData(MDataType) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
newSingleValueDecimalData(int) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Create new Single Value Topic Data of type MDataType.DECIMAL_STRING with a scale other than the default.
newSlaveData(PublishingTopicData) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Deprecated.
since 5.7.

This method does not cater for attaching SlaveTopicData to topics with UniversalTopicData. Use TopicDataFactory.newSlaveData(String) instead. This method will be withdrawn at a future release.

newSlaveData(String) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Create a new SlaveTopicData.
newThread(Runnable, String, int, boolean) - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
This is a convenience method for creating a new thread.
newTimeFormat() - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Create a Date Format object based upon the specified time format.
newTimestampFormat() - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Create a Date Format object based upon the specified timestamp format.
newTopicData(TopicDefinition) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Create new TopicData from a TopicDefinition.
newTopicNotifyData(boolean) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Deprecated.
since 5.9

This topic type will be removed in a future release

newUniversalData(Class<V>) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Create new UniversalTopicData.
newUniversalData(Class<V>, Map<String, String>) - Static method in class com.pushtechnology.diffusion.api.data.TopicDataFactory
Create new UniversalTopicData.
nextByte() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns the next byte of data from the message.
nextByte() - Method in interface com.pushtechnology.diffusion.api.message.MessageReader
Returns the next byte of data from the message.
nextBytes(byte[]) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns data from the message as bytes from the current position.
nextBytes(byte[]) - Method in interface com.pushtechnology.diffusion.api.message.MessageReader
Returns data from the message as bytes from the current position.
nextField() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns a field of string data from the current message position.
nextField() - Method in interface com.pushtechnology.diffusion.api.message.MessageReader
Returns a field of string data from the current message position.
nextObject() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Uses Java object serialization to read the content of the message into an object.
nextRecord() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns a record of string data from the current message position.
nextRecord(MRecord) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Returns a record of string data from the current message position using a metadata definition.
nextRecord() - Method in interface com.pushtechnology.diffusion.api.message.MessageReader
Returns a record of string data from the current message position.
nextRecord(MRecord) - Method in interface com.pushtechnology.diffusion.api.message.MessageReader
Returns a record of string data from the current message position using a Metadata definition.
notifiesAllTopics() - Method in interface com.pushtechnology.diffusion.api.data.notify.TopicNotifyTopicData
Deprecated.
Indicates whether the notifier will notify all Topic creations or only those which are owned by the same Publisher as the notifying Topic.
NULL_MESSAGE_STATISTICS - Static variable in interface com.pushtechnology.diffusion.api.statistics.MessageStatistics
Null implementation.

O

onStateChanged(EmbeddedDiffusion.State) - Method in interface com.pushtechnology.diffusion.api.server.EmbeddedDiffusion.LifecycleListener
Callback method for state changes.
open(int, int) - Method in interface com.pushtechnology.diffusion.api.client.paging.PagedTopicHandler
Deprecated.
Open the Topic.

P

padString(String, int) - Static method in class com.pushtechnology.diffusion.api.Utils
Pads a string with spaces to the right up to a specified length.
page(PageOption) - Method in interface com.pushtechnology.diffusion.api.client.paging.PagedTopicHandler
Deprecated.
Requests a page, relative to the current page.
page(int) - Method in interface com.pushtechnology.diffusion.api.client.paging.PagedTopicHandler
Deprecated.
Requests a page by absolute page number.
page(PagedTopicHandler, PageStatus, Lines) - Method in interface com.pushtechnology.diffusion.api.client.paging.PagedTopicListener
Deprecated.
Notifies receipt of a page from the server.
PagedRecordTopicData - Interface in com.pushtechnology.diffusion.api.data.paging
Deprecated.
since 5.9

This topic type will be removed in a future release

PagedStringTopicData - Interface in com.pushtechnology.diffusion.api.data.paging
Deprecated.
since 5.9

This topic type will be removed in a future release

PagedTopicData - Interface in com.pushtechnology.diffusion.api.data.paging
Deprecated.
since 5.9 this topic type will be removed at a future release
PagedTopicData.Duplicates - Enum in com.pushtechnology.diffusion.api.data.paging
Deprecated.
Specifies the Duplicates handling policy when operating in ordered mode.
PagedTopicHandler - Interface in com.pushtechnology.diffusion.api.client.paging
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

PagedTopicListener - Interface in com.pushtechnology.diffusion.api.client.paging
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

PageOption - Enum in com.pushtechnology.diffusion.api.client.paging
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

PageStatus - Interface in com.pushtechnology.diffusion.api.client.paging
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

parse(String) - Static method in enum com.pushtechnology.diffusion.api.client.paging.PageOption
Deprecated.
Returns the option associated with a given type code.
parse(String) - Static method in enum com.pushtechnology.diffusion.api.client.service.ServiceErrorType
Deprecated.
Parse a ServiceError from String representation.
parse(Object) - Method in interface com.pushtechnology.diffusion.api.data.metadata.CustomFieldHandler
Parses any object that can be parsed into the internal representation of this field's data type.
parse(String) - Static method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Parse an object from a string using the Multiplicity.toString() syntax, e.g.
parse(byte) - Static method in enum com.pushtechnology.diffusion.api.message.Encoding
Returns the encoding that corresponds to an encoding byte value.
parse(String) - Static method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Parses a topic selector string to create a TopicSelector object.
PBTopicData - Interface in com.pushtechnology.diffusion.api.data.pb
Deprecated.
since 5.7.

Support for Google Protocol Buffers topics will be removed in a future release as universal topic data of type BINARY can be used to distribute protocol buffer messages.

PBTopicData.UpdateMode - Enum in com.pushtechnology.diffusion.api.data.pb
Deprecated.
The Update mode indicates how messages supplied to update the Topic Data are interpreted.
ping() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
ping() - Method in interface com.pushtechnology.diffusion.api.ClientConnection
This sends a ClientPingMessage to the client.
ping() - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Sends a ping message to the server.
PING_RESPONSE - Static variable in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Client ping response notification mask setting
PingMessage - Interface in com.pushtechnology.diffusion.api.message
A 'Ping' message is a message that is sent over a connection and then reflected back by the receiver.
populateDelta(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
This is called when PublishingTopicData.generateDeltaMessage(String...) is called to populate a new delta message with updates done in the current block.
populateMessage(TopicMessage) - Method in class com.pushtechnology.diffusion.api.topic.SimpleTopicLoader
This populates a new empty Topic Load message with the topic load data.
populateResponseBuffer(ByteBuffer) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Generate a HTTP Response from the details provided and populate the ByteBuffer The buffer will not be flipped for output
populateTopicLoad(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
This will be called to populate an empty Topic Load message with the current state of the data.
prepare() - Method in class com.pushtechnology.diffusion.api.data.custom.AbstractCustomTopicDataHandler
Deprecated.
 
prepare() - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
This is called when the topic data that specifies the handler is attached to a topic.
print(PrintStream) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsData
Prints the WhoIs data.
processConnectionResponse(URLConnection) - Static method in class com.pushtechnology.diffusion.api.HTTPUtils
Process connection response.
processHTMLTag(String, HTTPRequest) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This method is call when a "DiffusionTag" comment is found in a web page which identifies the Publisher.
processRequest(URL, Properties) - Static method in class com.pushtechnology.diffusion.api.HTTPUtils
Processes an HTTP Request.
PropertyConfig - Interface in com.pushtechnology.diffusion.api.config
Property Configuration.
PropertyException - Exception in com.pushtechnology.diffusion.api
Exception thrown by PropertyHandler.
PropertyException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.api.PropertyException
Create a new PropertyException.
PropertyException(String) - Constructor for exception com.pushtechnology.diffusion.api.PropertyException
Create a new PropertyException.
propertyExists(String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Indicates whether a value for a particular property exists.
PropertyHandler - Interface in com.pushtechnology.diffusion.api
A Property Handler provides an interface to a set of properties.
PROTOCOL_VERSION - Static variable in interface com.pushtechnology.diffusion.api.data.notify.TopicNotifyTopicData
Deprecated.
The version of the Topic Notify protocol.
ProxyConnector - Interface in com.pushtechnology.diffusion.api.connection
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

publishDeltaMessage(String...) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
This is a convenience method to create a delta message for the topic populated with the specified fields and then publish it.
publishDeltaMessage(Record...) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
This is a convenience method to create a delta message for the topic populated with the specified records and then publish it.
Publisher - Class in com.pushtechnology.diffusion.api.publisher
This is the base class for all Publishers.
Publisher() - Constructor for class com.pushtechnology.diffusion.api.publisher.Publisher
 
PublisherConfig - Interface in com.pushtechnology.diffusion.api.config
Publisher Configuration.
publisherRemoved() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Called when the publisher is finally removed from the system.
Publishers - Class in com.pushtechnology.diffusion.api.publisher
Provides information relating to all Publishers within an instance of a Diffusion Server.
PublisherServerConnection - Interface in com.pushtechnology.diffusion.api.publisher
Deprecated.
since 5.9

Such connections are a form of classic client connection which will be removed along with the classic client API in a future release. The only practical use was for manual fan-out implementations that use topic notify topics. It is now recommended that automatic fan-out is used instead.

PublisherServerConnectionFailPolicy - Enum in com.pushtechnology.diffusion.api.publisher
Deprecated.
publisherStarted() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is called to notify that the Publisher has been started.
PublisherStatistics - Interface in com.pushtechnology.diffusion.api.statistics
Read-only statistics values for a publisher.
PublisherStatisticsConfig - Interface in com.pushtechnology.diffusion.api.config
Publisher statistics configuration.
publisherStopped() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Called when when publisher is stopped.
publisherStopping() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Called when when publisher stop request has been received but its topics have not yet been removed.
publishExclusiveMessage(TopicMessage, TopicClient) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
As PublishingTopicData.publishMessage(TopicMessage) but excluding a specified client.
publishExclusiveMessage(TopicMessage, TopicClient, MessagePriority) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
As PublishingTopicData.publishExclusiveMessage(TopicMessage, TopicClient) but allowing a message priority to be specified.
publishExclusiveMessage(TopicMessage, TopicClient) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
publishExclusiveMessage(TopicMessage, TopicClient, MessagePriority) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
publishExclusiveMessage(TopicMessage, TopicClient) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
A variant of Topic.publishMessage(TopicMessage) that publishes a message to all but one client.
publishExclusiveMessage(TopicMessage, TopicClient, MessagePriority) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
A variant of Topic.publishMessage(TopicMessage) that publishes a message to all but one client and allows the message priority to be specified.
publishExclusiveMessage(TopicMessage, TopicClient) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Deprecated.
since 5.6. See TopicProvider.publishMessage(TopicMessage) for details.
publishExclusiveMessage(TopicMessage, TopicClient, MessagePriority) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Deprecated.
since 5.6. See TopicProvider.publishMessage(TopicMessage) for details.
PublishingTopicData - Interface in com.pushtechnology.diffusion.api.data
PublishingTopicData provides a mechanism for maintaining the data associated with a topic and generating both load and delta messages to send to subscribed clients.
publishMessage(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Publish a message (at normal priority) to all subscribed clients.
publishMessage(TopicMessage, MessagePriority) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
As PublishingTopicData.publishMessage(TopicMessage) but allowing a message priority to be specified.
publishMessage(TopicMessage) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
publishMessage(TopicMessage, MessagePriority) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
publishMessage(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Publish a message to all clients that are subscribed to the topic of the message.
publishMessage(TopicMessage, MessagePriority) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
A variant of Topic.publishMessage(TopicMessage) that allows the message priority to be specified.
publishMessage(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Deprecated.
since 5.6.

The methods that publish messages to topics have been deprecated and will be removed in a future release. Use one of the following options instead.

publishMessage(TopicMessage, MessagePriority) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Deprecated.
since 5.6. See TopicProvider.publishMessage(TopicMessage) for details.
put(byte) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of a single byte of data.
put(byte[]) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of a byte array of data.
put(ByteBuffer) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of data from a ByteBuffer.
put(String...) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of String data.
put(DataMessage) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Puts the entire content of another message into this message.
putFields(String...) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of one or more String fields.
putFields(Collection<?>) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of one or more fields.
putFields(byte[]...) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of one or more byte array fields.
putObject(Object) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Writes an object to the message using Java object serialization.
putRecord(String...) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of a set of String fields as a record.
putRecord(Collection<?>) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of a collection of fields as a record.
putRecord(byte[]...) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of a set of byte array fields as a record.
putRecords(Record...) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of one or more records.
putRecords(Collection<Record>) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Relative put of one or more Records from a Collection.

Q

QUEUE_THRESHOLD_REACHED - Static variable in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Client queue threshold reached notification mask setting
QueueConfig - Interface in com.pushtechnology.diffusion.api.config
Queue Definition Configuration.
queueLowerThresholdReached(ThreadPool) - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPoolNotificationHandler
This is called when a configured lower threshold for a thread pool queue has been reached.
QueuesConfig - Interface in com.pushtechnology.diffusion.api.config
Configuration of Client Queue Definitions.
queueUpperThresholdReached(ThreadPool) - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPoolNotificationHandler
This is called when a configured upper threshold for a thread pool queue has been reached.

R

RANGE - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
range header
RANGE_PREFIX - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
bytes header
readFileAsString(File) - Static method in class com.pushtechnology.diffusion.api.Utils
Reads the entire contents of a file into a String.
readFileAsString(File, String) - Static method in class com.pushtechnology.diffusion.api.Utils
Reads the entire contents of a file into a String.
readHttpHeader(InputStream) - Static method in class com.pushtechnology.diffusion.api.HTTPUtils
Read a line with a CRLF from an input stream.
reconnect() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
Re-establish the last connection.
ReconnectConfig - Interface in com.pushtechnology.diffusion.api.config
Reconnect configuration for a connector.
Record - Class in com.pushtechnology.diffusion.api.message
A Message Record.
Record(MRecord, String...) - Constructor for class com.pushtechnology.diffusion.api.message.Record
Create a Record with specified record metadata.
Record(String...) - Constructor for class com.pushtechnology.diffusion.api.message.Record
Create a free format Record with zero or more fields.
RECORD_DELIMITER - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Byte value reserved for use as a record delimiter in character based Messages.
RECORD_DELIMITER_CHAR - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Character representation of Message.RECORD_DELIMITER.
RECORD_DELIMITER_STRING - Static variable in interface com.pushtechnology.diffusion.api.message.Message
String representation of Message.RECORD_DELIMITER.
RECORD_MU - Static variable in interface com.pushtechnology.diffusion.api.message.Message
Byte value reserved for representing a single empty record.
records() - Method in interface com.pushtechnology.diffusion.api.client.paging.Lines
Deprecated.
Returns the lines in Record format.
RecordTopicData - Interface in com.pushtechnology.diffusion.api.data.record
'Record' Topic Data is that which supports Messages formatted into Records and Fields using Diffusion delimiters.
register(Manageable) - Static method in class com.pushtechnology.diffusion.api.management.Management
Deprecated.
Register a Manageable object in the JMX management service.
rejectedExecution(ThreadPool) - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPoolNotificationHandler
Notifies rejection of execution of a runnable by the pool.
rejectedExecution(RunnableTask, ThreadPool) - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPoolRejectionHandler
Called when a task can not be executed by a ThreadPool.
rejectedExecution(RunnableTask, ThreadPool) - Method in class com.pushtechnology.diffusion.api.threads.ThreadService.AbortRejectionPolicy
 
rejectedExecution(RunnableTask, ThreadPool) - Method in class com.pushtechnology.diffusion.api.threads.ThreadService.CallerRunsRejectionPolicy
 
remaining() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Indicates the number of unread data bytes remaining within the message.
remaining() - Method in interface com.pushtechnology.diffusion.api.message.MessageReader
Indicates the number of unread data bytes remaining within the message.
RemoteServerConfig - Interface in com.pushtechnology.diffusion.api.config
Deprecated.
remove(Record) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Removed the line that matches the supplied record from the data.
remove(String) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Removed the line that matches the supplied string from the data.
remove(int, int) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedTopicData
Deprecated.
Removes one or more lines from the data.
remove() - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Removes this node (and all of its children) from the Topic tree.
removeAddresses() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Remove all addresses.
removeAllClients() - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Removes all clients from the group.
removeAllDirectories() - Method in interface com.pushtechnology.diffusion.api.config.UserLibrariesConfig
Remove all directories.
removeAllListeners() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
Removes all listeners.
removeAllPolicies() - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Remove all conflation policies and mappings.
removeAllTopics() - Method in interface com.pushtechnology.diffusion.api.config.SubscriptionValidationPolicyConfig
Remove all topics mapped to this policy.
removeClient(TopicClient) - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Removes a client from the group.
removeClientGroup(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
removeClientGroup(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Removes a client group.
removeClientService() - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Remove Client Service.
removeConnectionValidationPolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Remove a named connection validation policy.
removeEventListener(ServerEventListener) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Remove an event listener.
removeField(int) - Method in class com.pushtechnology.diffusion.api.message.Record
Removes a specified field from the record.
removeFileService() - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Remove File Service.
removeFromClientGroups() - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Remove the client from any client groups that it participates in.
removeHandler(Handler) - Static method in class com.pushtechnology.diffusion.api.Logs
Removes a log handler from the root logger which is the parent of all logs.
removeHandler(Handler) - Method in interface com.pushtechnology.diffusion.api.LogWriter
Remove a log handler.
removeHeader(String) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Removes a header from the response
removeHostNames() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Remove all host names.
removeHTTPService(String) - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Remove a named HTTP Service.
removeLifecycleListener(EmbeddedDiffusion.LifecycleListener) - Method in class com.pushtechnology.diffusion.api.server.DiffusionServer
 
removeLifecycleListener(EmbeddedDiffusion.LifecycleListener) - Method in interface com.pushtechnology.diffusion.api.server.EmbeddedDiffusion
De-Register for lifecycle events.
removeListener(TopicDataListener) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
removeLocales() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Remove all locales from the configuration.
removeLog(String) - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Removes named log definition.
removePolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Remove a named conflation policy and all mappings to it.
removeQueueMessageFilter(MessageFilter) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Removes a Queue Message Filter.
removeRealm(String) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Remove a named realm.
removeResolvedNames() - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Remove all resolved names.
removeServerConnection(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Deprecated.
removeSubscriptionValidationPolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Remove a subscription validation policy.
removeThreadPoolListener() - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Deprecated.
Since 5.8. Configuration of listeners is no longer supported.
removeThrottler() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Remove any current Throttler.
removeTopic(String) - Method in interface com.pushtechnology.diffusion.api.config.SubscriptionValidationPolicyConfig
Remove a topic (or topic pattern) that this policy should be applied to.
removeTopic(String) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
removeTopic(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Removes a named topic from the provider.
removeTopic(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Removes a child or descendant Topic of the current node.
removeTopicDeletionListener(TopicDeletionListener) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTree
Removes a Topic deletion listener.
removeTopicListener(TopicListener) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
removeTopicListener(TopicListener) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Removes a TopicListener.
removeTopicListener(TopicListener) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Removes a TopicListener.
removeTopicLoader(TopicLoader) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
removeTopicLoader(TopicLoader) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Removes a Topic Loader.
removeTopics(TopicSet) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
removeTopics(TopicSet) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Removes a set of Topics from the provider.
removeTopicTreeListener(TopicTreeListener) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTree
Removes a listener for Topic events.
removeUser(String) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostRealmConfig
Remove a realm user.
removeVirtualHost(String) - Method in interface com.pushtechnology.diffusion.api.config.FileServiceConfig
Remove virtual host.
ReplicationConfig - Interface in com.pushtechnology.diffusion.api.config
The configuration for replication.
ReporterConfig - Interface in com.pushtechnology.diffusion.api.config
Statistic Reporter definition.
ReporterConfig.Type - Enum in com.pushtechnology.diffusion.api.config
Indicates the Reporter Type.
request(String, TopicMessage) - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicHandler
Deprecated.
Sends a request to the Service.
request(String, String, TopicMessage) - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicHandler
Deprecated.
Sends a request to the service.
REQUEST - Static variable in interface com.pushtechnology.diffusion.api.webserver.HTTPRequestListener
Request mask setting
RESOLVED - Static variable in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Client resolved notification mask setting
rewind() - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Resets the data pointer to the start of the data in preparation for relative read ('next...') operations.
rewind() - Method in interface com.pushtechnology.diffusion.api.message.MessageReader
Resets the data pointer to the start of the data in preparation for relative read ('next...') operations.
RootConfig - Interface in com.pushtechnology.diffusion.api.config
Interface for root configuration objects.
RoutingTopicData - Interface in com.pushtechnology.diffusion.api.data.routing
This is a form of Topic Data that allows one Topic to route its subscriptions through to one or more other Topics and for messages published on those Topics to be routed back through the routing Topic.
RoutingTopicDataSubscriptionHandler - Interface in com.pushtechnology.diffusion.api.data.routing
A Handler for RoutingTopicData.
RunnableTask - Interface in com.pushtechnology.diffusion.api.threads
This is the interface that must be implemented by objects that wish to be scheduled as background tasks.

S

SAVED - Static variable in interface com.pushtechnology.diffusion.api.publisher.XMLPropertiesListener
Deprecated.
Mask setting for Properties saved notification.
Schedule - Interface in com.pushtechnology.diffusion.api.threads
Represents a schedule for a task.
schedule(ScheduledTask) - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
Schedules a ScheduledTask to run according to a frequency schedule defined by the task itself.
schedule(String, String, RunnableTask) - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
Schedules a task to be run according to a schedule specified by a 'cron' like frequency pattern.
schedule(RunnableTask, long, TimeUnit) - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
Schedule a task for execution after a given period of time.
schedule(RunnableTask, long, long, TimeUnit, boolean) - Static method in class com.pushtechnology.diffusion.api.threads.ThreadService
Schedules a task for periodic execution.
SCHEDULE_DAILY - Static variable in class com.pushtechnology.diffusion.api.threads.ThreadService
Constant which represents a daily schedule "0 0 * * *"
SCHEDULE_EVERY_MINUTE - Static variable in class com.pushtechnology.diffusion.api.threads.ThreadService
Constant which represents a cron entry which will execute every minute * "* * * * *"
ScheduledTask - Interface in com.pushtechnology.diffusion.api.threads
A RunnableTask that defines a schedule by which it should be run.
SecurityConfig - Interface in com.pushtechnology.diffusion.api.config
Server Security Configuration.
select(TopicNotifyTopicHandler.SelectionMode, TopicSet) - Method in interface com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler
Deprecated.
Sends a request to the server to update the selection of topics that topic add notifications will be received for.
select(TopicTreeNode) - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
selectMessage(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.message.MessageFilter
Selects (or rejects) a Message for processing.
SelectorThreadPoolConfig - Interface in com.pushtechnology.diffusion.api.config
A single selector thread pool configuration.
SelectorThreadPoolsConfig - Interface in com.pushtechnology.diffusion.api.config
Selector thread pools configuration.
selectsAllBelow() - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Selects all below?
selectsAllInclusive() - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Selects all below inclusive?
selectsChildren() - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
This indicates whether the selector selects the children of any selected Topic also.
selectsTopic(Topic) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
This may be used to determine whether the Client has previously registered an interest (or subscribed to) a given Topic.
send(TopicMessage) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
send(TopicMessage, MessagePriority) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Send a message to the client, specifying delivery priority.
send(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Send a message to the server.
send(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Send a message to all clients in the group.
send(TopicMessage, MessagePriority) - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Send a message to all clients in the group, specifying a delivery priority.
send(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Send a message to the client.
SEND_INVALID - Static variable in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Client send invalid notification mask setting
sendCredentials(Credentials) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
sendCredentials(Credentials) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Send credentials to the server.
sendExclusive(TopicMessage, TopicClient) - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Send an exclusive message, i.e.
sendExclusive(TopicMessage, TopicClient, MessagePriority) - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Send an exclusive message, i.e.
sendFetchReply(TopicMessage, MessagePriority, List<String>) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Deprecated.
since 5.6. Currently a classic client can issue a fetch request to a stateless topic, or even a topic that does not exist. This method enables a publisher to return a reply. At future releases this capability will be removed.
sendFetchReply(TopicMessage, List<String>) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Deprecated.
since 5.6. Currently a classic client can issue a fetch request to a stateless topic, or even a topic that does not exist. This method enables a publisher to return a reply. At future releases this capability will be removed.
serialize(Document, boolean) - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Serializes a document to a String.
serialize(Document) - Static method in class com.pushtechnology.diffusion.api.XMLUtils
Serialize a document to a flat (unformatted) string of XML.
SERVER - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Server Header
ServerAckListener - Interface in com.pushtechnology.diffusion.api
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

ServerAuthenticationHandlerConfig - Interface in com.pushtechnology.diffusion.api.config
An authentication handler hosted on the server.
ServerConfig - Interface in com.pushtechnology.diffusion.api.config
Server Configuration.
serverConnected(ServerConnection) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Notification of Connection to a remote server.
serverConnected(ServerConnection) - Method in interface com.pushtechnology.diffusion.api.ServerConnectionListener
Deprecated.
Notification of Connection.
ServerConnection - Interface in com.pushtechnology.diffusion.api
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

ServerConnectionListener - Interface in com.pushtechnology.diffusion.api
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

ServerConnectionState - Enum in com.pushtechnology.diffusion.api
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

ServerDetails - Interface in com.pushtechnology.diffusion.api.connection
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

serverDisconnected(ServerConnection) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Notification of disconnection.
serverDisconnected(ServerConnection) - Method in interface com.pushtechnology.diffusion.api.ServerConnectionListener
Deprecated.
Notification of disconnection.
ServerEventListener - Interface in com.pushtechnology.diffusion.api.publisher
This is the tagging interface that all Server Event Listeners implement.
ServerPingMessage - Interface in com.pushtechnology.diffusion.api.message
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

serverPingResponse(String, ServerPingMessage) - Method in interface com.pushtechnology.diffusion.api.message.ServerPingResponseListener
Deprecated.
This is the method on which 'ping' responses are returned.
ServerPingResponseListener - Interface in com.pushtechnology.diffusion.api.message
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

serverRejectedCredentials(ServerConnection, Credentials) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is called when Credentials have been sent to the Server (using ServerConnection.sendCredentials(Credentials)) but the Server has rejected the credentials.
serverRejectedCredentials(ServerConnection, Credentials) - Method in interface com.pushtechnology.diffusion.api.ServerConnectionListener
Deprecated.
This is called when Credentials have been sent to the Server (using ServerConnection.sendCredentials(Credentials)) but the Server has rejected the credentials.
ServerShutdownHook - Interface in com.pushtechnology.diffusion.api.publisher
This is the interface for the ServerShutdownHook.
serverStarting() - Method in interface com.pushtechnology.diffusion.api.publisher.ServerStartupHook
This method is called before loading the publishers.
ServerStartupHook - Interface in com.pushtechnology.diffusion.api.publisher
This is the interface for the ServerStartupHook.
ServerStatisticsConfig - Interface in com.pushtechnology.diffusion.api.config
Server statistics configuration.
serverStopping() - Method in interface com.pushtechnology.diffusion.api.publisher.ServerShutdownHook
This method is called when the Server is stopping.
serverTopicStatusChanged(ServerConnection, String, TopicStatus) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Notification that the status of a Topic that was subscribed to has changed.
serverTopicStatusChanged(ServerConnection, String, TopicStatus) - Method in interface com.pushtechnology.diffusion.api.ServerConnectionListener
Deprecated.
Notification that the status of a Topic that was subscribed to has changed.
serviceError(ServiceTopicError) - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicListener
Deprecated.
Notifies an error on a service request.
serviceError(String, String, String, Throwable) - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
This may be used to asynchronously report a failure of a service execution.
serviceError(ServiceRequest, String, Throwable) - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
As ServiceTopicData.serviceError(String, String, String, Throwable) but the client and request identifiers are obtained from a request.
ServiceErrorType - Enum in com.pushtechnology.diffusion.api.client.service
Deprecated.
since 5.7 service topics have been deprecated.
ServiceException - Exception in com.pushtechnology.diffusion.api.data.service
Deprecated.
since 5.7

Messaging is a better alternative to service topics for sending point-to-point requests.

ServiceException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.api.data.service.ServiceException
Deprecated.
Create a new ServiceException.
ServiceException(String) - Constructor for exception com.pushtechnology.diffusion.api.data.service.ServiceException
Deprecated.
Create a new ServiceException.
ServiceHandler - Interface in com.pushtechnology.diffusion.api.data.service
Deprecated.
since 5.7

Messaging is a better alternative to service topics for sending point-to-point requests.

ServiceHeader - Enum in com.pushtechnology.diffusion.api.data.service
Deprecated.
since 5.7

Messaging is a better alternative to service topics for sending point-to-point requests.

serviceRequest(ServiceRequest) - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceHandler
Deprecated.
Execute a service request received from a client via ServiceTopicData.
ServiceRequest - Interface in com.pushtechnology.diffusion.api.data.service
Deprecated.
since 5.7

Messaging is a better alternative to service topics for sending point-to-point requests.

serviceResponse(ServiceTopicResponse) - Method in interface com.pushtechnology.diffusion.api.client.service.ServiceTopicListener
Deprecated.
Notifies a response from a service request.
ServiceResponse - Class in com.pushtechnology.diffusion.api.data.service
Deprecated.
since 5.7

Messaging is a better alternative to service topics for sending point-to-point requests.

ServiceResponse(String, String, String, TopicMessage) - Constructor for class com.pushtechnology.diffusion.api.data.service.ServiceResponse
Deprecated.
Creates a response for a request identified by client identifier and request number and for a specified response type.
ServiceResponse(ServiceRequest, String, TopicMessage) - Constructor for class com.pushtechnology.diffusion.api.data.service.ServiceResponse
Deprecated.
Creates a response for specified request and for a specified response type.
serviceResponse(ServiceResponse) - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
This may be used to asynchronously return a response to a request issued to a ServiceHandler.
ServiceTopicData - Interface in com.pushtechnology.diffusion.api.data.service
Deprecated.
since 5.7

Messaging is a better alternative to Service Topics for sending point-to-point requests.

ServiceTopicError - Interface in com.pushtechnology.diffusion.api.client.service
Deprecated.
since 5.7 service topics have been deprecated.
ServiceTopicHandler - Interface in com.pushtechnology.diffusion.api.client.service
Deprecated.
since 5.7 service topics have been deprecated.
ServiceTopicListener - Interface in com.pushtechnology.diffusion.api.client.service
Deprecated.
since 5.7 service topics have been deprecated.
ServiceTopicResponse - Interface in com.pushtechnology.diffusion.api.client.service
Deprecated.
since 5.7 service topics have been deprecated.
SessionReplicationConfig - Interface in com.pushtechnology.diffusion.api.config
The configuration for the session replication service.
SET_COOKIE_HEADER - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Set-Cookie header
setAcceptors(int) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Deprecated.
the value set will be ignored by the system.
setAckListener(ServerAckListener) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
setAckListener(ServerAckListener) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Sets a listener to receive notification of non acknowledgement of messages sent to the server.
setAckRequired() - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Sets the 'ACK Required' flag on the message.
setAckTimeout(long) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
setAckTimeout(long) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Sets ack timeout.
setAckTimeout(long) - Method in interface com.pushtechnology.diffusion.api.message.TopicMessage
Sets the 'ACK Timeout' value for this Message.
setAckTimeout(long) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
setAckTimeout(long) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Sets the (default) Server ACK timeout value for messages sent to the Server that require acknowledgement.
setAckTimeout(long) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Sets the (default) ACK timeout value for messages that require Acknowledgment.
setAliasFile(String) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Sets the alias file.
setAllowsEmpty(boolean) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MField
Sets the 'allowsEmpty' option for the field.
setApiType(ConnectorConfig.ClientApiType) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Deprecated.
since 5.9

Since classic client APIs have been deprecated then this will be removed in a future release

setAssignedRoles(List<String>) - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Deprecated.
since 5.9. Remote JMX users should be configured in the system authentication store, or with a custom authentication handler.
setAsyncLogging(boolean) - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Sets the asynchronous logging option.
setAttachment(Object) - Method in interface com.pushtechnology.diffusion.api.message.AttachableTopicMessage
Sets the message attachment.
setAuthenticationHandlers(List<? extends AuthenticationHandlerConfig>) - Method in interface com.pushtechnology.diffusion.api.config.SecurityConfig
The authentication handlers.
setAuthorisationHandler(AuthorisationHandler) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Set the Authorisation Handler for all Publishers.
setAuthorisationHandlerClass(String) - Method in interface com.pushtechnology.diffusion.api.config.SecurityConfig
Sets the name of the authorisation handler class.
setAutoAck(boolean) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Sets the value of the autoAck property.
setAutoAcknowledging(boolean) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Sets the default auto acknowledge flag for connections.
setAutoAcknowledging(boolean) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
This allows auto acknowledgement of Messages to be set for a Connection.
setAutoFailover(boolean) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Sets the 'Auto Failover' option.
setAutomatic(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Sets automatic option.
setAutoStart(boolean) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Sets the publisher start property.
setAutoSubscribe(boolean) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeNode
Deprecated.
since 5.5, auto-subscription is always enabled
setBackgroundPoolSize(int) - Method in interface com.pushtechnology.diffusion.api.config.ThreadsConfig
Sets the number of threads to use for the background thread pool.
setBacklog(int) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the backlog.
setBatchSize(int) - Method in interface com.pushtechnology.diffusion.api.config.FetchPolicyConfig
Sets the batch size value.
setBody(ByteBuffer) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Set the body of the HTTP request, the buffer needs to be positioned correctly
setCacheMaximumSize(int) - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Sets the maximum size of the WhoIs cache.
setCacheRetentionTime(long) - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Sets retention time for WhoIs cache entries.
setCacheSizeLimit(int) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostCacheConfig
Sets the cache size limit.
setCacheTidyInterval(long) - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Sets the WhoIs cache tidy interval.
setCascading(boolean) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Sets the 'Cascading' option.
setCharset(String) - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
since 5.9

In future releases only UTF-8 will be supported

setCharset(String) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Sets the character set to be used by the message for byte/character conversions.
setChunkedEncoding() - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets transfer encoding header to chunked
setClientService(String) - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Add a client service.
setCloseCallbackRequests(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Deprecated.
since Diffusion 5.7. This method will be removed in a future release.
setCometBytesBeforeNewPoll(int) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Sets comet bytes before new poll.
setCometInitialMessagePadding(int) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Sets comet initial message padding.
setCompressionEnabled(boolean) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Toggles the response to be compressed or not
setCompressionThreshold(int) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Sets the compression threshold.
setCompressionThreshold(int) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Sets the compression threshold.
setConflates(boolean) - Method in interface com.pushtechnology.diffusion.api.config.QueueConfig
Sets the conflates property.
setConflation(boolean) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Sets message conflation on or off for the outbound message queue.
setConnectionClose() - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets the connection header to close
setConnectionDetails(ConnectionDetails) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
Allows Connection Details to be set if not specified on construction.
setConnectionKeepAlive() - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets the Keep-Alive header
setConnectionPort(int) - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Sets the JMX service port.
setConnectionTimeout(long) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the connection timeout for inbound connections.
setConnectionTimeout(int) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Sets the connection timeout.
setConnectionTimeout(long) - Method in interface com.pushtechnology.diffusion.api.config.TimeoutsConfig
Sets the connection timeout.
setConnectionTimeout(long) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Sets the default connection timeout.
setConnectionTimeout(int) - Method in class com.pushtechnology.diffusion.api.connection.HTTPProxyConnector
Sets connectionTimeout.
setConnectionTimeout(long) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Sets the connection timeout.
setConsoleLogLevel(LogDescription.LogLevel) - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Sets the console log level.
setContentLength(int) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets the content length header
setContentRange(HTTPByteRange) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets the content range header
setCookie(String) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets the session cookie header
setCookieDisabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Sets the session cookie as enabled/disabled.
setCoreSize(int) - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Sets the core pool size.
setCoreSize(int) - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Sets the core number of threads.
setCORSOrigin(String) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Sets the CORS origin.
setCorsResponseOrigin(String) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets the cors response origin header
setCredentials(Credentials) - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Sets the credentials to use for the server connection
setCredentials(Credentials) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Sets default credentials.
setCredentials(Credentials) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Sets Credentials to be used when connecting to the server.
setCredentials(Credentials) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Deprecated.
This method exists only to support the AuthorisationHandler.canConnect() and AuthorisationHandler.credentialsSupplied methods, both of which are deprecated in favor of authentication handlers. It will be removed in a future release.
setDateFormat(String) - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Sets the date format.
setDateFormat(String) - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
Specifies a date format to use for formatting dates used in the %d part of the file pattern (see {link LogConfig.setFilePattern(String)).
setDateTimeFormat(String) - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Sets the date and time format.
setDebug(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Sets debug.
setDebug(boolean) - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Sets debug option.
setDebug(boolean) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostCacheConfig
Sets debug option.
setDebug(boolean) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Sets debug option.
setDefaultDeltaMessageCapacity(int) - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Sets the default size for a delta message if not explicitly specified when creating a message.
setDefaultDeltaMessageCapacity(int) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Sets the default capacity for delta Messages in bytes created using the Topic.createDeltaMessage() method.
setDefaultLoadMessageCapacity(int) - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Sets the default size for a load message if not explicitly specified when creating the message.
setDefaultLoadMessageCapacity(int) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Sets the default capacity for load Messages in bytes created using the Topic.createLoadMessage() method.
setDefaultLogDirectory(String) - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Sets the default log directory.
setDefaultMultiplexerDefinition(String) - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
since 5.6 multiplexer is already configured with xml config
setDefaultPolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Sets the default conflation policy.
setDefaultQueue(String) - Method in interface com.pushtechnology.diffusion.api.config.QueuesConfig
Sets the name of the default queue definition.
setDefaultSelectorThreadPool(String) - Method in interface com.pushtechnology.diffusion.api.config.SelectorThreadPoolsConfig
Sets the thread pool definition to use as default selector thread pool.
setDefaultValue(Object) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MField
Sets a default value that required occurrences of the field are to be initialised to.
setDelay(long) - Method in interface com.pushtechnology.diffusion.api.config.FetchPolicyConfig
Sets the batch delay value.
setDeletionValue(String) - Method in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
Allows a deletion value to be specified for use with 'string' type optional fields.
setDeltaAckRequired(boolean) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
This may be used to indicate that when a delta message is generated it should have ackRequired set.
setDeltaEncoding(Encoding) - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5 if non default encoding required then create topic using a TopicDefinition
setDirectory(String) - Method in interface com.pushtechnology.diffusion.api.config.AutoDeploymentConfig
Sets the directory.
setDirty() - Method in class com.pushtechnology.diffusion.api.topic.CachedTopicLoader
Set the loader as dirty This method will make sure that the populateMessage is called
setDuplicatesPolicy(PagedTopicData.Duplicates) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedTopicData
Deprecated.
Set the duplicates policy for ordered data.
setEmptyFieldValue(String) - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Sets the value to be used to represent empty fields in messages generated by the TopicData.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ClientStatisticsConfig
Set enabled.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.GeoIpConfig
Sets enabled flag.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Sets whether or not a remote JMX Connector is enabled or not.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Sets the publisher enabled property.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.PublisherStatisticsConfig
Set enabled.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ReplicationConfig
Set replication enabled.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ReporterConfig
Set enabled.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ServerStatisticsConfig
Set enabled.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.SessionReplicationConfig
Set replication enabled.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.StatisticsConfig
Set enabled.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.TopicReplicationConfig
Set replication enabled.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.TopicStatisticsConfig
Set enabled.
setEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Set WhoIs enabled.
setEncoding(Encoding) - Method in interface com.pushtechnology.diffusion.api.message.DataMessage
Sets the byte encoding for the message.
setErrorPage(String) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Sets the error page.
setETag(String) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets the Etag header
setFailPolicy(PublisherServerConnectionFailPolicy) - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Sets the failure policy.
setFailPolicy(PublisherServerConnectionFailPolicy) - Method in interface com.pushtechnology.diffusion.api.publisher.PublisherServerConnection
Deprecated.
Set the failure policy for a connection.
setField(int, String) - Method in class com.pushtechnology.diffusion.api.message.Record
Replaces a field at a specified index within the record.
setField(String, Object...) - Method in class com.pushtechnology.diffusion.api.message.Record
Set field value(s) by name.
setField(String, int, Object) - Method in class com.pushtechnology.diffusion.api.message.Record
Sets a field value by name and index.
setFieldValues(String, Collection<?>) - Method in class com.pushtechnology.diffusion.api.message.Record
As Record.setField(String, Object...) but allowing a collection of values to be supplied.
setFile(String) - Method in interface com.pushtechnology.diffusion.api.config.KeyStoreConfig
Sets the file path of the KeyStore.
setFileAppend(boolean) - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
Sets the file append option.
setFileCount(int) - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
Sets the file count.
setFileLifeTime(long) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostCacheConfig
Sets the file lifetime.
setFileLimit(int) - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
Sets the file limit.
setFileName(String) - Method in interface com.pushtechnology.diffusion.api.config.GeoIpConfig
Sets the name of the Maxmind GeoCityIP city file.
setFilePattern(String) - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
Sets the file pattern.
setFileService(String) - Method in interface com.pushtechnology.diffusion.api.config.WebServerConfig
Add a file service.
setFileSizeLimit(int) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostCacheConfig
Sets the file size limit.
setHeader(String, String) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Adds a header to the response
setHeaderOptions(ServiceHeader...) - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
Sets a list of additional headers to be included in any request message that is generated within a ServiceRequest.
setHeaders(String...) - Method in interface com.pushtechnology.diffusion.api.message.Message
Sets user defined headers.
setHeaders(List<String>) - Method in interface com.pushtechnology.diffusion.api.message.Message
Sets user defined headers.
setHeadResponse() - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
If this method is called, then the resulting response will be a HEAD response only
setHost(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the host address to bind to.
setHost(String) - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Set the host.
setHost(String) - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Sets the whois host.
setHost(String) - Method in class com.pushtechnology.diffusion.api.connection.HTTPProxyConnector
Sets host.
setInboundPool(String) - Method in interface com.pushtechnology.diffusion.api.config.ThreadsConfig
Sets the thread pool definition to use for the inbound thread pool.
setInitialiser(TopicDataInitialiser) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Allows an object to be assigned that will be responsible for initialising the data just prior to its attachment to a topic.
setInputBufferSize(int) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Sets the input buffer size for the connection.
setInputBufferSize(int) - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Sets the size of the input buffer for the connection.
setInputBufferSize(int) - Method in interface com.pushtechnology.diffusion.api.config.SocketConditioningConfig
Sets the input buffer size.
setInputBufferSize(int) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Sets the input buffer size for socket connection buffers.
setInstanceMonitoringEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ClientStatisticsConfig
Set monitoring of instances enabled.
setInstanceMonitoringEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.PublisherStatisticsConfig
Set monitoring of instances enabled.
setInstanceMonitoringEnabled(boolean) - Method in interface com.pushtechnology.diffusion.api.config.TopicStatisticsConfig
Set monitoring of instances enabled.
setIntrospectionMask(byte) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
This may be used to set the Introspection capabilities of the Topic.
setKeepAlive(long) - Method in interface com.pushtechnology.diffusion.api.config.ReconnectConfig
Sets the keep alive value.
setKeepAlive(boolean) - Method in interface com.pushtechnology.diffusion.api.config.SocketConditioningConfig
Sets the TCP keep alive option.
setKeepAlive(long) - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Sets the keep alive time.
setKeepAlive(long) - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Sets the time limit for which threads may remain idle before being terminated.
setKeyStoreFileLocation(String) - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Sets the KeyStore file location.
setKeyStorePassword(String) - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Sets the KeyStore password.
setLastModifiedDate(long) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets the Last Modified header to the date supplied
setLatencyWarning(long) - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Sets the latency warning threshold.
setLevel(LogDescription.LogLevel) - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
Sets the starting log level.
setLevel(Level) - Static method in class com.pushtechnology.diffusion.api.Logs
Deprecated.
Prefer the SLF4J API for logging.
setLevel(Level) - Method in interface com.pushtechnology.diffusion.api.LogWriter
Deprecated.
Prefer the SLF4J API for logging.
setListener(ServerConnectionListener) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
This may be used to set the listener if it has not been set on construction.
setListener(ConnectionDetailsListener) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Sets a listener for Connection Details events.
setListener(ServerConnectionListener) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Set listener - for use when setting after construction but before connection.
setListProperty(TopicProperty, List<String>) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Sets a list type property.
setListProperty(TopicProperty, String...) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Sets a list type property.
setLoadAckRequired(boolean) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
This may be used to indicate that when a load message is generated it should have ackRequired set (see PublishingTopicData.getLoadMessage()).
setLoadBalancer(MultiplexerConfig.LoadBalancer) - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Deprecated.
This configuration will be removed in a future release. If you have found the LEAST_CLIENTS algorithm useful, please contact Push Technology Support and reference case 11098.
setLoadBalancer(MultiplexerConfig.LoadBalancer) - Method in interface com.pushtechnology.diffusion.api.config.WriteSelectorConfig
Deprecated.
Set the load balancer used for the selectors.
setLoadBalancing(boolean) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Sets the 'Load Balancing' option.
setLoadEncoding(Encoding) - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5 if non default encoding required then create topic using a TopicDefinition
setLoadHeaders(String...) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
This may be used to set user headers to be applied to a load message when it is generated (see PublishingTopicData.getLoadMessage()).
setLocalSocketAddress(SocketAddress) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Set the optional local socket address, used prior to connection
setLockTimeout(long) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.6. All API topic locking methods are deprecated and will be removed in a future release, see Topic.lock() for details.
setLog(String) - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Sets the log file.
setLogDirectory(String) - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
Sets the log directory.
setLogger(LogWriter) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Set logger
setLoggingQueueSize(int) - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Sets the size of the event queue to use for the asynchronous logging service.
setLogLevel(LogDescription.LogLevel) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Sets the log level for the publisher.
setLogMessageData(boolean) - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Deprecated.
since 5.5

This no longer has any effect - use RootConfig.setLogMessageData(boolean)

setLogMessageData(boolean) - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Sets the log message data option.
setLogName(String) - Method in interface com.pushtechnology.diffusion.api.config.ClientStatisticsConfig
Sets the log name.
setLogThreadNames(boolean) - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Sets the option to log the thread name with each message logged.
setLowerThreshold(int) - Method in interface com.pushtechnology.diffusion.api.config.QueueConfig
Sets the lower threshold.
setMandatory(boolean) - Method in interface com.pushtechnology.diffusion.api.config.KeyStoreConfig
Sets if keyStore is mandatory.
setMaximumDepth(int) - Method in interface com.pushtechnology.diffusion.api.config.QueueConfig
Sets the maximum queue depth.
setMaximumEventQueueSize(int) - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Sets the maximum event queue size.
setMaximumInboundRequestSize(int) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Sets the maximum inbound request size.
setMaximumInboundRequestSize(int) - Method in interface com.pushtechnology.diffusion.api.config.HTTPServiceConfig
Sets maximum inbound request size.
setMaximumMessageSize(int) - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Sets the maximum message size.
setMaximumQueueDepth(int) - Method in interface com.pushtechnology.diffusion.api.config.ReconnectConfig
Sets the maximum queue depth value.
setMaximumQueueSize(int) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Sets the maximum queue size for messages queued to be sent to the primary server.
setMaximumQueueSize(int) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Sets the maximum queue size for the client.
setMaximumSize(int) - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Sets the maximum pool size.
setMaximumSize(int) - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Sets the maximum allowed number of threads.
setMessageLengthSize(int) - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
since 5.2 the message length size is always 4 bytes
setMessageSequenceTimeout(long) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Sets the message sequence timeout.
setMetadata(MNode) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Sets metadata for the Topic.
setMetadataNode(MNode) - Method in interface com.pushtechnology.diffusion.api.data.TopicDataWithMetadata
Sets Optional Metadata on the TopicData.
setMimeType(String) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Change the default mime type
setMinify(boolean) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Sets minify option.
setMultiplexerConfiguration(MultiplexerConfig) - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Sets the multiplexer configuration.
setName(String) - Method in interface com.pushtechnology.diffusion.api.config.ReporterConfig
Sets the StatisticsReporter name.
setNoCache() - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets cache control to no-store, no-cache
setNoDelay(boolean) - Method in interface com.pushtechnology.diffusion.api.config.SocketConditioningConfig
Sets the no delay option.
setNotificationDetails(TopicNotifyTopicHandler.NotificationLevel, boolean, boolean) - Method in interface com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler
Deprecated.
This can be used to set the notification details required.
setNotificationHandler(ThreadPoolNotificationHandler, int, int) - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Sets a notification handler for the pool.
setNotificationLevel(TopicNotifyTopicHandler.NotificationLevel) - Method in interface com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler
setNotifyAllTopics(boolean) - Method in interface com.pushtechnology.diffusion.api.data.notify.TopicNotifyTopicData
Deprecated.
Sets the 'notify all topics' option.
setNumberOfAcceptors(int) - Static method in class com.pushtechnology.diffusion.api.APIProperties
setNumberOfReadSelectors(int) - Method in interface com.pushtechnology.diffusion.api.config.RootConfig
Deprecated.
since 5.9

this property will be removed in a future release

setOutboundMessageQueueDefinition(String) - Method in interface com.pushtechnology.diffusion.api.publisher.PublisherServerConnection
Deprecated.
Sets the name of the outbound queue definition to use when creating an an outbound message queue on connection.
setOutboundPool(String) - Method in interface com.pushtechnology.diffusion.api.config.ThreadsConfig
Deprecated.
outbound thread pools are no longer used
setOutputBufferSize(int) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Sets the output buffer size.
setOutputBufferSize(int) - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Sets the output buffer size for the connection.
setOutputBufferSize(int) - Method in interface com.pushtechnology.diffusion.api.config.SocketConditioningConfig
Sets the output buffer size.
setOutputBufferSize(int) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Sets the output buffer size for socket connection buffers.
setOutputFrequency(long) - Method in interface com.pushtechnology.diffusion.api.config.ClientStatisticsConfig
Sets the output frequency.
setPassword(String) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Sets a password to be used when authenticating with the primary server.
setPassword(String) - Method in interface com.pushtechnology.diffusion.api.config.KeyStoreConfig
Sets the keyStore password.
setPassword(String) - Method in interface com.pushtechnology.diffusion.api.config.ManagementUserConfig
Deprecated.
Sets the password.
setPassword(String) - Method in class com.pushtechnology.diffusion.api.Credentials
Sets the Password.
setPingResponseListener(ServerPingResponseListener) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
setPingResponseListener(ServerPingResponseListener) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Sets a listener to receive 'ping' responses.
setPolicyFile(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the policy file.
setPort(int) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the port that the connector binds to.
setPort(int) - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Sets the WhoIs port.
setPort(int) - Method in class com.pushtechnology.diffusion.api.connection.HTTPProxyConnector
Sets port.
setPrincipal(String) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Sets the security principal to use when authenticating with the primary server.
setPriority(int) - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Deprecated.
Since 5.8. The thread priority can no longer be configured and this method has no effect.
setProperties(Map<TopicProperty, Object>) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Set properties from a specified map of properties
setProperty(String, String) - Method in interface com.pushtechnology.diffusion.api.config.ReporterConfig
Set a named property value.
setProperty(String, String, String) - Method in interface com.pushtechnology.diffusion.api.config.ReporterConfig
Set a name property value, with a valid property type.
setProperty(String, String) - Method in interface com.pushtechnology.diffusion.api.PropertyHandler
Sets a property value.
setProperty(TopicProperty, Object) - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
Set a Topic property.
setProvider(String) - Method in interface com.pushtechnology.diffusion.api.config.ReplicationConfig
Set the provider for replication.
setProvider(String) - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Sets the provider class.
setProxyConnector(ProxyConnector) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Sets a Proxy Connector to allow for connection via a Proxy Server.
setProxyProtocol(ConnectorConfig.ProxyProtocol) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the proxy protocol required for connection.
setQueueDefinition(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the queue definition.
setQueueDefinition(String) - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Sets the queue definition to use for the connection.
setQueueNotificationThresholds(int, int) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Sets queue notification thresholds.
setQueueSize(int) - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Sets the queue size.
setQueueSize(int) - Method in interface com.pushtechnology.diffusion.api.config.WriteSelectorConfig
Deprecated.
Set the maximum size of the event queue for each selector.
setReadOnly(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ManagementUserConfig
Deprecated.
Set user as read only.
setReconnectTimeout(int) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Sets the overall reconnection timeout value.
setRecoveryBufferSize(int) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Set the recovery buffer size.
setRecoveryBufferSize(int) - Method in interface com.pushtechnology.diffusion.api.config.ReconnectConfig
Set the maximum number of sent messages that can be recovered on reconnection.
setReference(String) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Sets a user reference for the Topic.
setReference(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Allows a user defined reference to be assigned to the client.
setRegistryPort(int) - Method in interface com.pushtechnology.diffusion.api.config.ManagementConfig
Sets the RMI registry port.
setRejectionHandler(ThreadPoolRejectionHandler) - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Sets the handler to be used for tasks that can not be executed by the pool.
setRejectionHandlerClass(String) - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Sets the rejection handler class name.
setRequestTimeout(long) - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
Sets the amount of time before an asynchronous request which has not had a reply will be timed out.
setRequired(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets a boolean value to specify if the connector is required on startup.
setResetFrequency(long) - Method in interface com.pushtechnology.diffusion.api.config.ClientStatisticsConfig
Sets the reset frequency
setResolvedName(String) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
May be used to set a resolved name in a WhoIsProvider implementation.
setResponseCode(int) - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Set the response code for the HTTP response, default is 200
setRetryDelay(int) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Specifies the number of milliseconds to wait after failing to connect or losing the connection to the primary server before trying to connect again.
setRetryInterval(int) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Deprecated.
since 5.9 this value is no longer used - use FanOutConnectionConfig.setRetryDelay(int) instead.
setRetryInterval(long) - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Sets the retry interval.
setRetryInterval(long) - Method in interface com.pushtechnology.diffusion.api.publisher.PublisherServerConnection
Deprecated.
Sets the retry interval.
setReuseAddress(boolean) - Method in interface com.pushtechnology.diffusion.api.config.SocketConditioningConfig
Sets the reuse address option.
setRotateDaily(boolean) - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
setRotationPeriod(int, TimeUnit) - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
Set the rotation period of the log file.
setScale(int) - Method in interface com.pushtechnology.diffusion.api.data.metadata.MField
Sets the scale of the field.
setScanFrequency(long) - Method in interface com.pushtechnology.diffusion.api.config.AutoDeploymentConfig
Sets the scan frequency.
setSelectorThreadPoolDefinition(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the thread pool definition.
setServer() - Method in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Sets the server header to Diffusion
setServerDetails(Collection<ServerDetails>) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Sets the list of ServerDetails objects representing the servers to be connected to.
setServerLog(String) - Method in interface com.pushtechnology.diffusion.api.config.LoggingConfig
Sets the server log.
setServerName(String) - Method in interface com.pushtechnology.diffusion.api.config.ServerConfig
Sets the server name.
setServiceData(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
Sets data that will be returned to any client that subscribed to a service topic in it's load message.
setServiceDetails(HTTPServiceDetails) - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPServiceHandler
This is called upon instantiating the handler to pass it the configured details of the service.
setShutdownHook(String) - Method in interface com.pushtechnology.diffusion.api.config.HooksConfig
Sets the value of the shutdownHook property.
setSize(int) - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Sets the number of multiplexer threads.
setSize(int) - Method in interface com.pushtechnology.diffusion.api.config.WriteSelectorConfig
Deprecated.
Set the number of write selectors.
setSSL(boolean) - Method in interface com.pushtechnology.diffusion.api.config.RemoteServerConfig
Deprecated.
Sets the value of the ssl property.
setSSLContext(SSLContext) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Sets SSL Context to use for SSL Socket creation.
setStartupHook(String) - Method in interface com.pushtechnology.diffusion.api.config.HooksConfig
Sets the start up hook.
setStatic(boolean) - Method in interface com.pushtechnology.diffusion.api.config.VirtualHostConfig
Sets static option.
setStopServerIfNotLoaded(boolean) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Sets whether to stop the server if publisher does not load.
setSystemPingFrequency(long) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the system ping frequency.
setTargetTopicName(String) - Method in interface com.pushtechnology.diffusion.api.data.service.ServiceTopicData
Deprecated.
Sets the target topic name.
setThreadPoolDefinition(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the thread pool definition.
setThreadPoolListener(String, int, int) - Method in interface com.pushtechnology.diffusion.api.config.ThreadPoolConfig
Deprecated.
Since 5.8. Configuration of listeners is no longer supported and any listener configured with this method will be ignored.
setThreadPriority(int) - Method in interface com.pushtechnology.diffusion.api.config.MultiplexerConfig
Deprecated.
Since 5.8. The multiplexer thread priority can no longer be configured and this method has no effect.
setThreadPriority(int) - Method in interface com.pushtechnology.diffusion.api.config.WriteSelectorConfig
Deprecated.
Set the thread priority of the write selectors.
setThreads(int) - Method in interface com.pushtechnology.diffusion.api.config.WhoIsConfig
Sets the number of resolver threads used by the WhoIs service.
setTidyOnUnsubscribe(boolean) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Allows the 'Tidy on Unsubscribe' option to be set for the Topic.
setTimeFormat(String) - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Sets the time format.
setTimeout(long) - Method in interface com.pushtechnology.diffusion.api.config.WriteSelectorConfig
Deprecated.
since 5.2, no longer used
setTimestampFormat(String) - Method in interface com.pushtechnology.diffusion.api.config.FormattingConfig
Sets the timestamp format.
setTopicAliasing(boolean) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Sets the value of the topicAliasing property.
setTopicData(CustomTopicData) - Method in class com.pushtechnology.diffusion.api.data.custom.AbstractCustomTopicDataHandler
Deprecated.
 
setTopicData(CustomTopicData) - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
This is called when the data is first created to notify the handler of the data it is associated with.
setTopicPolicy(String, String) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Set a new Topic to Conflation Policy mapping.
setTopics(String) - Method in interface com.pushtechnology.diffusion.api.config.PublisherConfig
Sets Topics to automatically create.
setTopics(TopicSet) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Sets the default Topic(s) to be subscribed to on connection.
setTopics(String...) - Method in interface com.pushtechnology.diffusion.api.connection.ConnectionDetails
Deprecated.
Sets the default Topic(s) to be subscribed to on connection.
setTopics(TopicSet) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Sets the Topic(s) to be subscribed to on connection.
setTopics(String...) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Sets the default Topic(s) to be subscribed to on connection.
setTopicSelectors(Set<String>) - Method in interface com.pushtechnology.diffusion.api.config.TopicReplicationConfig
Set the topic selectors.
setType(ConnectorConfig.Type) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the connector type.
setType(String) - Method in interface com.pushtechnology.diffusion.api.config.MimeConfig
Sets the associated mime type.
setType(ReporterConfig.Type) - Method in interface com.pushtechnology.diffusion.api.config.ReporterConfig
Sts the reporter's type.
setType(ValidationPolicyConfig.Type) - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Sets the policy type.
setUpdateErrors(boolean) - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicData
Deprecated.
May be used by the handler to notify errors in updating.
setUpdateMode(PBTopicData.UpdateMode) - Method in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
Set the update mode.
setUpperThreshold(int) - Method in interface com.pushtechnology.diffusion.api.config.QueueConfig
Sets the upper threshold.
setUsername(String) - Method in class com.pushtechnology.diffusion.api.Credentials
Sets the User Name.
setValidateChildren(boolean) - Method in interface com.pushtechnology.diffusion.api.config.SubscriptionValidationPolicyConfig
Sets the validate children option.
setValidationPolicyFile(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets a validation policy file.
setValue(String, String) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsData
Sets a key/value pair in the data.
setWebServer(String) - Method in interface com.pushtechnology.diffusion.api.config.ConnectorConfig
Sets the Web Server.
setWebsocketOrigin(String) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Sets the web socket origin.
setWebsocketSecureResponse(boolean) - Method in interface com.pushtechnology.diffusion.api.config.ClientServiceConfig
Deprecated.
Setting is ignored. It applied to behavior defined by draft versions of the WebSocket specification that is no longer supported.
setWhoIsData(WhoIsData) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsDetails
Used to set WhoIs data for the Internet address from within a WhoIsProvider implementation.
setWriteTimeout(int) - Method in interface com.pushtechnology.diffusion.api.config.FanOutConnectionConfig
Sets the write timeout value.
setWriteTimeout(long) - Method in interface com.pushtechnology.diffusion.api.config.FileServiceConfig
Sets the write timeout.
setWriteTimeout(long) - Method in interface com.pushtechnology.diffusion.api.config.TimeoutsConfig
Sets the value of the write timeout for blocking write operations.
setWriteTimeout(long) - Method in interface com.pushtechnology.diffusion.api.connection.ServerDetails
Deprecated.
Set the write timeout value for blocking writes on the connection.
setXmlFormat(boolean) - Method in interface com.pushtechnology.diffusion.api.config.LogConfig
Sets the XML format option.
shutdown() - Method in interface com.pushtechnology.diffusion.api.threads.ThreadPool
Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
SimpleCustomTopicDataHandler - Class in com.pushtechnology.diffusion.api.data.custom
Deprecated.
since 5.9

See CustomTopicData.

SimpleCustomTopicDataHandler() - Constructor for class com.pushtechnology.diffusion.api.data.custom.SimpleCustomTopicDataHandler
Deprecated.
 
SimpleTopicLoader - Class in com.pushtechnology.diffusion.api.topic
This is a simple implementation of a Topic Loader.
SimpleTopicLoader() - Constructor for class com.pushtechnology.diffusion.api.topic.SimpleTopicLoader
Create Simple TopicLoader
SINGLE_OPTIONAL - Static variable in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Static instance of a multiplicity of 0..1 (single optional).
SINGLE_REQUIRED - Static variable in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
Static instance of a multiplicity of 1 (single required).
SingleValueTopicData - Interface in com.pushtechnology.diffusion.api.data.single
'Single Value' Topic Data supports a Topic that has a single data item as its value.
size() - Method in interface com.pushtechnology.diffusion.api.message.Message
The total current message size in bytes.
size() - Method in class com.pushtechnology.diffusion.api.message.Record
Returns the number of field values within the record.
sizeInBytes() - Method in class com.pushtechnology.diffusion.api.message.Record
This returns the number of bytes that this record would occupy in a Message that uses the default character set for byte encoding.
sizeInBytes(String) - Method in class com.pushtechnology.diffusion.api.message.Record
This returns the number of bytes that this record would occupy in a Message that uses a specified character set for byte encoding.
sizeInChars() - Method in class com.pushtechnology.diffusion.api.message.Record
Returns the total number of characters within this record (including delimiters).
SlaveTopicData - Interface in com.pushtechnology.diffusion.api.data
Slave Topic Data.
SocketConditioningConfig - Interface in com.pushtechnology.diffusion.api.config
Socket Conditioning configuration for a connector.
start() - Method in class com.pushtechnology.diffusion.api.server.DiffusionServer
Starts the server.
start() - Method in interface com.pushtechnology.diffusion.api.server.EmbeddedDiffusion
Starts the server.
startPublisher() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Starts the publisher.
startService() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Start the service.
startStatistics() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Starts the collection of this Client's statistics.
startStatistics() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Starts the collection of this Publisher's statistics.
startStatistics() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Starts the collection of this Topic's statistics.
startUpdate() - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
This is called when PublishingTopicData.startUpdate() is called.
startUpdate() - Method in class com.pushtechnology.diffusion.api.data.custom.SimpleCustomTopicDataHandler
Deprecated.
 
startUpdate() - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Locks the parent topic in preparation for updates.
StatisticsConfig - Interface in com.pushtechnology.diffusion.api.config
Statistics Configuration.
statusChanged(PagedTopicHandler, PageStatus) - Method in interface com.pushtechnology.diffusion.api.client.paging.PagedTopicListener
Deprecated.
Notifies a status change.
stop() - Method in class com.pushtechnology.diffusion.api.server.DiffusionServer
Stops the server.
stop() - Method in interface com.pushtechnology.diffusion.api.server.EmbeddedDiffusion
Stops the server.
stopPublisher() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Stops the publisher.
stopService() - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPVirtualHost
Stop the service.
stopStatistics() - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Stops the collection of this Client's statistics.
stopStatistics() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Stops the collection of this Publisher's statistics.
stopStatistics() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Stops the collection of this Topic's statistics.
subscribe(String...) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
subscribe(TopicSet) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
subscribe(TopicClient, Topic) - Method in interface com.pushtechnology.diffusion.api.data.routing.RoutingTopicData
This may be used to subscribe a client to a Topic other than the parent Topic, bypassing any authorisation checks.
subscribe(TopicSet) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Subscribes to a set of topics.
subscribe(String...) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Subscribes to a set of topics.
subscribe(TopicClient) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Subscribe a client to this topic.
subscribe(Topic) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Subscribe the client to a specified topic.
subscribe(Topic, boolean) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Deprecated.
since 5.5. auto subscription is always enabled so setting force=false has no effect. Prefer TopicClient.subscribe(Topic) instead.
subscribe(TopicSet) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Subscribe the client to a set of topics.
subscribe(TopicSet, boolean) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Deprecated.
since 5.5. auto subscription is always enabled so setting force=false has no effect. Prefer TopicClient.subscribe(TopicSet) instead.
subscribeClients(Topic) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
 
subscribeClients(Topic, boolean) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
Deprecated.
subscribeClients() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Subscribe all currently connected clients to the topic.
subscribeClients(boolean) - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.5

auto subscription is always enabled so setting force=false has no effect. Prefer Topic.subscribeClients() instead.

subscribeClients(Topic) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Subscribe all connected clients to a specified topic.
subscribeClients(Topic, boolean) - Method in interface com.pushtechnology.diffusion.api.topic.TopicProvider
Deprecated.
since 5.5. auto subscription is always enabled so setting force=false has no effect. Prefer TopicProvider.subscribeClients(Topic) instead.
subscription(Client, Topic, boolean) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This method is called when a client subscribes to a topic.
Subscription - Interface in com.pushtechnology.diffusion.api.topic
This encapsulates details relating to a Client's subscription to a topic.
SUBSCRIPTION_INVALID - Static variable in interface com.pushtechnology.diffusion.api.publisher.ClientListener
Client subscription invalid notification mask setting
SubscriptionValidationPolicyConfig - Interface in com.pushtechnology.diffusion.api.config
Subscription Validation Policy configuration.
SystemAuthenticationHandlerConfig - Interface in com.pushtechnology.diffusion.api.config
The system authentication handler.
systemStarted() - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is called when the System as a whole has started.

T

ThreadPool - Interface in com.pushtechnology.diffusion.api.threads
A Thread Pool is a self managing pool of threads which may be used for executing concurrent tasks.
ThreadPoolConfig - Interface in com.pushtechnology.diffusion.api.config
Thread Pool Configuration.
ThreadPoolListenerConfig - Interface in com.pushtechnology.diffusion.api.config
Deprecated.
Since 5.8. Configuration of listeners is no longer supported.
ThreadPoolNotificationHandler - Interface in com.pushtechnology.diffusion.api.threads
The interface for an object to receive thread pool notifications.
ThreadPoolRejectionHandler - Interface in com.pushtechnology.diffusion.api.threads
A handler for tasks that cannot be executed by a ThreadPool.
ThreadsConfig - Interface in com.pushtechnology.diffusion.api.config
Configuration of Thread Related Information.
ThreadService - Class in com.pushtechnology.diffusion.api.threads
Provides Thread Handling Capabilities.
ThreadService.AbortRejectionPolicy - Class in com.pushtechnology.diffusion.api.threads
A ThreadPoolRejectionHandler that simply throws an Exception.
ThreadService.AbortRejectionPolicy() - Constructor for class com.pushtechnology.diffusion.api.threads.ThreadService.AbortRejectionPolicy
 
ThreadService.CallerRunsRejectionPolicy - Class in com.pushtechnology.diffusion.api.threads
A ThreadPoolRejectionHandler which attempts to run the task in the current thread.
ThreadService.CallerRunsRejectionPolicy() - Constructor for class com.pushtechnology.diffusion.api.threads.ThreadService.CallerRunsRejectionPolicy
 
throttle(ClientThrottlerType, int) - Method in interface com.pushtechnology.diffusion.api.publisher.Client
Throttle the Client's queue.
tidyOnUnsubscribe() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Indicates whether the 'Tidy on unsubscribe' option is set for the Topic.
TimeoutException - Exception in com.pushtechnology.diffusion.api
This is thrown to indicate that a blocking operation has timed out.
TimeoutException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.api.TimeoutException
Create a new TimeoutException.
TimeoutException(String) - Constructor for exception com.pushtechnology.diffusion.api.TimeoutException
Create a new TimeoutException.
TimeoutsConfig - Interface in com.pushtechnology.diffusion.api.config
Configuration of timeouts.
toListValue(List<String>) - Static method in enum com.pushtechnology.diffusion.api.topic.TopicProperty
Converts a list of Strings to a suitable format for a list type property
toListValue(String...) - Static method in enum com.pushtechnology.diffusion.api.topic.TopicProperty
Converts a list of Strings to a suitable format for a list type property
toMessage(boolean) - Method in interface com.pushtechnology.diffusion.api.message.Message
Returns a string representation of the Message.
Topic - Interface in com.pushtechnology.diffusion.api.topic
Represents a Topic.
topicAdded(String, TopicDefinition) - Method in interface com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicListener
Deprecated.
Notifies the addition of a Topic at the server.
topicAdded(Topic) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeListener
Called whenever a new Topic is added.
TopicClient - Interface in com.pushtechnology.diffusion.api.topic
A Topic Client is any client that can subscribe to Topics and receive messages for specific Topics.
TopicConflationPolicyConfig - Interface in com.pushtechnology.diffusion.api.config
Configuration of a mapping from a Topic (or Topic pattern) to a Conflation Policy.
TopicData - Interface in com.pushtechnology.diffusion.api.data
Topic Data.
topicDataChanged(TopicData) - Method in interface com.pushtechnology.diffusion.api.data.TopicDataListener
This method is called when the Topic Data changes.
TopicDataFactory - Class in com.pushtechnology.diffusion.api.data
Factory for various types of topic data.
TopicDataFactory() - Constructor for class com.pushtechnology.diffusion.api.data.TopicDataFactory
 
TopicDataInitialiser - Interface in com.pushtechnology.diffusion.api.data
Specifies the interface of an object that may be invoked to initialise PublishingTopicData.
TopicDataListener - Interface in com.pushtechnology.diffusion.api.data
This is the interface for any object that wants to listen for changes to Publishing Topic Data.
TopicDataType - Enum in com.pushtechnology.diffusion.api.data
Defines the type of an instance of TopicData.
TopicDataWithMetadata - Interface in com.pushtechnology.diffusion.api.data
This is the interface for those types of TopicData that either have mandatory Metadata or allow optional Metadata.
TopicDefinition - Class in com.pushtechnology.diffusion.api.topic
This encapsulates all or some of the details of a Topic.
TopicDefinition(TopicDataType) - Constructor for class com.pushtechnology.diffusion.api.topic.TopicDefinition
Creates a Topic Definition of the specified type.
TopicDefinition(TopicDataType, Map<TopicProperty, Object>) - Constructor for class com.pushtechnology.diffusion.api.topic.TopicDefinition
Creates a Topic Definition of a specified type with properties.
TopicDefinition(TopicDataType, MNode) - Constructor for class com.pushtechnology.diffusion.api.topic.TopicDefinition
Creates a Topic Definition of a specified type with Metadata.
TopicDefinition(TopicDataType, Map<TopicProperty, Object>, MNode) - Constructor for class com.pushtechnology.diffusion.api.topic.TopicDefinition
Creates a Topic Definition.
topicDeleted(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicDeletionListener
Notifies the deletion of a topic.
TopicDeletionListener - Interface in com.pushtechnology.diffusion.api.topic
This is the interface for objects that wish to be notified of all topic deletions.
TopicIntrospection - Interface in com.pushtechnology.diffusion.api.topic
Settings for Topic Introspection.
TopicInvalidException - Exception in com.pushtechnology.diffusion.api.topic
Indicates an invalid topic name or TopicSelector string.
TopicInvalidException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.api.topic.TopicInvalidException
Create new TopicInvalidException
TopicInvalidException(String) - Constructor for exception com.pushtechnology.diffusion.api.topic.TopicInvalidException
Create new TopicInvalidException
TopicListener - Interface in com.pushtechnology.diffusion.api.topic
The interface for an object that can have Topic Messages received from a MessageSource routed to it.
TopicLoader - Interface in com.pushtechnology.diffusion.api.topic
A Topic Loader is an object which performs the topic load processing for one or more topics on behalf of a TopicProvider.
TopicMessage - Interface in com.pushtechnology.diffusion.api.message
The interface for data messages that are created for a specific topic.
TopicNameGenerator - Class in com.pushtechnology.diffusion.api.topic
This class may be used used to generate short unique topic names.
TopicNotifyTopicData - Interface in com.pushtechnology.diffusion.api.data.notify
Deprecated.
since 5.9

This topic type will be removed in a future release

TopicNotifyTopicHandler - Interface in com.pushtechnology.diffusion.api.client.notify
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

TopicNotifyTopicHandler.NotificationLevel - Enum in com.pushtechnology.diffusion.api.client.notify
Deprecated.
Specifies the level of add notification that the client wishes to receive.
TopicNotifyTopicHandler.SelectionMode - Enum in com.pushtechnology.diffusion.api.client.notify
Deprecated.
Specifies the mode when selecting topic ranges for notification.
TopicNotifyTopicListener - Interface in com.pushtechnology.diffusion.api.client.notify
Deprecated.
Since 5.9

The classic client API will be removed in a future release.

TopicProperty - Enum in com.pushtechnology.diffusion.api.topic
Specifies Topic Property keys that may be used in TopicDefinitions.
TopicProvider - Interface in com.pushtechnology.diffusion.api.topic
A Topic Provider maintains and provides the state for one or more Topics.
topicReferenceChanged(Topic) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeListener
Notified when a Topic's reference has been changed.
topicRemoved(String) - Method in interface com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicListener
Deprecated.
Notifies the removal of a Topic at the server
topicRemoved(String) - Method in interface com.pushtechnology.diffusion.api.topic.TopicTreeListener
Called whenever a topic is removed.
TopicReplicationConfig - Interface in com.pushtechnology.diffusion.api.config
The configuration for topic replication.
TopicSelector - Class in com.pushtechnology.diffusion.api.topic
A Topic Selector is a mechanism for selecting Topics either by name or by a Topic selector pattern.
TopicSelector(String, boolean, boolean) - Constructor for class com.pushtechnology.diffusion.api.topic.TopicSelector
Create a Topic Selector
TopicSelector.Type - Enum in com.pushtechnology.diffusion.api.topic
The selector type
TopicSet - Class in com.pushtechnology.diffusion.api.topic
An ordered set of Topic names and/or TopicSelector strings.
TopicSet() - Constructor for class com.pushtechnology.diffusion.api.topic.TopicSet
Constructs an empty topic set.
TopicSet(String...) - Constructor for class com.pushtechnology.diffusion.api.topic.TopicSet
Constructs a Topic set from any number of TopicSelector strings.
TopicSet(Collection<String>) - Constructor for class com.pushtechnology.diffusion.api.topic.TopicSet
Constructs a Topic set from a collection of Topic names and/or TopicSelector strings.
TopicStatistics - Interface in com.pushtechnology.diffusion.api.statistics
Read-only statistics values for a single Topic.
TopicStatisticsConfig - Interface in com.pushtechnology.diffusion.api.config
Topic Statistics Configuration.
TopicStatus - Enum in com.pushtechnology.diffusion.api.topic
Topic Status.
TopicSubscriptionHandler - Interface in com.pushtechnology.diffusion.api.topic
Deprecated.
since 5.5. Consider using routing topics instead.
TopicTree - Interface in com.pushtechnology.diffusion.api.topic
The root node of a Topic tree.
TopicTreeListener - Interface in com.pushtechnology.diffusion.api.topic
Interface for an object that wishes to listen for changes to the TopicTree.
TopicTreeNode - Interface in com.pushtechnology.diffusion.api.topic
Represents any node within a Topic tree.
topicUpdated(String, Map<TopicProperty, Object>) - Method in interface com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicListener
Deprecated.
Notifies a change to one or more of the non static properties of a Topic.
toString() - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
Returns a String representation of the connection detail.
toString() - Method in enum com.pushtechnology.diffusion.api.config.ConnectorConfig.ClientApiType
Deprecated.
 
toString() - Method in enum com.pushtechnology.diffusion.api.ConnectionCategory
 
toString() - Method in class com.pushtechnology.diffusion.api.Credentials
 
toString() - Method in class com.pushtechnology.diffusion.api.data.metadata.Multiplicity
 
toString() - Method in interface com.pushtechnology.diffusion.api.message.Message
Returns a full string representation of the Message.
toString() - Method in class com.pushtechnology.diffusion.api.message.Record
 
toString() - Method in class com.pushtechnology.diffusion.api.topic.TopicDefinition
 
toString() - Method in class com.pushtechnology.diffusion.api.topic.TopicSelector
Returns a String representation of the selector that is compatible with the TopicSelector.parse(String) method.
toString() - Method in class com.pushtechnology.diffusion.api.topic.TopicSet
Returns a delimited list of the Topic names or TopicSelector strings.
toString() - Method in class com.pushtechnology.diffusion.api.whois.GeoLocation
 
TRANSFER_ENCODING_BYTES - Static variable in class com.pushtechnology.diffusion.api.webserver.HTTPResponse
Transfer-Encoding header
TransportProtocol - Enum in com.pushtechnology.diffusion.api.connection
Defines a Diffusion Transport Protocol.

U

union(ClientGroup) - Method in interface com.pushtechnology.diffusion.api.topic.ClientGroup
Returns a temporary client group which is the union between the two groups.
UniversalTopicData<V> - Interface in com.pushtechnology.diffusion.api.data
This is the interface to a number of different topic types that are based on DataTypes.
unloadPublisher(String) - Static method in class com.pushtechnology.diffusion.api.publisher.Publishers
Unloads a publisher.
unlock() - Method in interface com.pushtechnology.diffusion.api.data.TopicData
Deprecated.
since 5.5. All API topic locking methods are deprecated and will be removed in a future release, see TopicData.lock() for details.
unlock() - Method in interface com.pushtechnology.diffusion.api.topic.Topic
Deprecated.
since 5.6

All API topic locking methods are deprecated and will be removed in a future release, see Topic.lock() for details.

unregister(Manageable) - Static method in class com.pushtechnology.diffusion.api.management.Management
Deprecated.
Unregister a Manageable object.
unsetTopicPolicy(String) - Method in interface com.pushtechnology.diffusion.api.config.ConflationConfig
Remove the Topic to Conflation Policy mapping for a specified Topic selector pattern.
unsubscribe(String...) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
unsubscribe(TopicSet) - Method in class com.pushtechnology.diffusion.api.client.ExternalClientConnection
Deprecated.
 
unsubscribe(TopicSet) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Unsubscribes from a set of topics.
unsubscribe(String...) - Method in interface com.pushtechnology.diffusion.api.ServerConnection
Deprecated.
Unsubscribes from a set of topics.
unsubscribe(Topic) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Unsubscribes the client from a given Topic.
unsubscribe(TopicSet) - Method in interface com.pushtechnology.diffusion.api.topic.TopicClient
Unsubscribe client from a set of Topics.
unsubscription(Client, Topic) - Method in class com.pushtechnology.diffusion.api.publisher.Publisher
This is called when a client unsubscribes from one of the publisher's topics.
update(PagedTopicHandler, PageStatus, int, Lines) - Method in interface com.pushtechnology.diffusion.api.client.paging.PagedTopicListener
Deprecated.
Notifies an update to the data of a line on the current page.
update(TopicMessage) - Method in class com.pushtechnology.diffusion.api.data.custom.AbstractCustomTopicDataHandler
Deprecated.
 
update(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.custom.CustomTopicDataHandler
Deprecated.
This will be called to update the state of the data from an incoming delta Message.
update(int, Record) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Update the line at the specified index with a given value.
update(Record) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedRecordTopicData
Deprecated.
Update the line that matches the specified Record with the specified line.
update(int, String) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Update the line at the specified index with a given value.
update(String) - Method in interface com.pushtechnology.diffusion.api.data.paging.PagedStringTopicData
Deprecated.
Update the line that matches the specified String with the specified line.
update(AbstractMessage) - Method in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
Updates the data using a Protocol Buffers Message.
update(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Updates the data with the data from a supplied message.
update(Record...) - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Update data from records.
update(Collection<Record>) - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Update data from records.
update(Record, int) - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Updates data from a Record.
update(String, int, String, Object...) - Method in interface com.pushtechnology.diffusion.api.data.record.RecordTopicData
Updates a specific field within a specified record within the data.
update(Object) - Method in interface com.pushtechnology.diffusion.api.data.single.SingleValueTopicData
Updates the data from a object.
update(V) - Method in interface com.pushtechnology.diffusion.api.data.UniversalTopicData
Updates the topic to the specified value.
UPDATE - Static variable in interface com.pushtechnology.diffusion.api.topic.TopicIntrospection
The mask setting which will allow a Topic to be updated via the Introspector tool.
updateAndPublish(AbstractMessage) - Method in interface com.pushtechnology.diffusion.api.data.pb.PBTopicData
Deprecated.
updateAndPublish(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
Convenience method to perform an atomic update and publish a delta message if any changes are detected.
updateAndPublish(TopicMessage, MessagePriority) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
As PublishingTopicData.updateAndPublish(TopicMessage) but allowing a message priority to be specified.
updateAndPublish(Object) - Method in interface com.pushtechnology.diffusion.api.data.single.SingleValueTopicData
updateAndPublishFromDelta(TopicMessage) - Method in interface com.pushtechnology.diffusion.api.data.PublishingTopicData
This method allows the topic data to be updated using input that represents only deltas of change to the topic.
UserLibrariesConfig - Interface in com.pushtechnology.diffusion.api.config
User Library Config Details.
UTF8 - Static variable in class com.pushtechnology.diffusion.api.APIProperties
Deprecated.
UTF8 - Static variable in class com.pushtechnology.diffusion.api.Utils
The UTF-8 Character encoding which is recommended for most message handling.
Utils - Class in com.pushtechnology.diffusion.api
General Purpose Utilities.

V

validate(String, String, String, Locale) - Method in interface com.pushtechnology.diffusion.api.config.ValidationPolicyConfig
Check to see if the supplied details are valid for this policy.
validate(boolean) - Method in class com.pushtechnology.diffusion.api.topic.TopicSet
Validates all of the entries in the Topic set.
ValidationPolicyConfig - Interface in com.pushtechnology.diffusion.api.config
Validation Policy Configuration.
ValidationPolicyConfig.Type - Enum in com.pushtechnology.diffusion.api.config
Policy type.
ValidationPolicyLocaleConfig - Interface in com.pushtechnology.diffusion.api.config
Validation Policy Locale Config.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler.NotificationLevel
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler.SelectionMode
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.client.paging.PageOption
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.client.service.ServiceErrorType
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.config.ConflationPolicyConfig.Mode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.config.ConnectorConfig.ClientApiType
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.config.ConnectorConfig.ProxyProtocol
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.config.ConnectorConfig.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.config.MultiplexerConfig.LoadBalancer
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.config.ReporterConfig.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.config.ValidationPolicyConfig.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.connection.TransportProtocol
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.ConnectionCategory
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.data.metadata.MDataType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.data.paging.PagedTopicData.Duplicates
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.data.pb.PBTopicData.UpdateMode
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.data.service.ServiceHeader
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.data.TopicDataType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.LogDescription.LogLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.message.Encoding
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.message.MessagePriority
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.message.MessageSourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.publisher.ClientCloseReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.publisher.ClientThrottlerType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.publisher.PublisherServerConnectionFailPolicy
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.server.EmbeddedDiffusion.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.ServerConnectionState
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.topic.TopicProperty
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.topic.TopicSelector.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pushtechnology.diffusion.api.topic.TopicStatus
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler.NotificationLevel
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.client.notify.TopicNotifyTopicHandler.SelectionMode
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.client.paging.PageOption
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.client.service.ServiceErrorType
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.config.ConflationPolicyConfig.Mode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.config.ConnectorConfig.ClientApiType
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.config.ConnectorConfig.ProxyProtocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.config.ConnectorConfig.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.config.MultiplexerConfig.LoadBalancer
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.config.ReporterConfig.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.config.ValidationPolicyConfig.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.connection.TransportProtocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.ConnectionCategory
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.data.metadata.MDataType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.data.paging.PagedTopicData.Duplicates
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.data.pb.PBTopicData.UpdateMode
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.data.service.ServiceHeader
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.data.TopicDataType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.LogDescription.LogLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.message.Encoding
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.message.MessagePriority
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.message.MessageSourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.publisher.ClientCloseReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.publisher.ClientThrottlerType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.publisher.PublisherServerConnectionFailPolicy
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.server.EmbeddedDiffusion.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.ServerConnectionState
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.topic.TopicProperty
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.topic.TopicSelector.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pushtechnology.diffusion.api.topic.TopicStatus
Returns an array containing the constants of this enum type, in the order they are declared.
VirtualHostCacheConfig - Interface in com.pushtechnology.diffusion.api.config
Virtual Host Cache Configuration.
VirtualHostConfig - Interface in com.pushtechnology.diffusion.api.config
Virtual Host Configuration.
VirtualHostRealmConfig - Interface in com.pushtechnology.diffusion.api.config
Virtual Host Realm Configuration.
VirtualHostRealmUserConfig - Interface in com.pushtechnology.diffusion.api.config
Virtual Host Realm User Configuration.

W

WebServerConfig - Interface in com.pushtechnology.diffusion.api.config
Web Server Configuration.
whoIs(String, WhoIsDetails) - Method in class com.pushtechnology.diffusion.api.whois.WhoIsDefaultProvider
Performs a WhoIs lookup.
whoIs(String, WhoIsDetails) - Method in interface com.pushtechnology.diffusion.api.whois.WhoIsProvider
Resolves a supplied IP address.
WhoIsConfig - Interface in com.pushtechnology.diffusion.api.config
WhoIs configuration Details.
WhoIsData - Interface in com.pushtechnology.diffusion.api.whois
This object encapsulates the details of a 'WhoIs' database lookup.
WhoIsDefaultProvider - Class in com.pushtechnology.diffusion.api.whois
This is the default WhoIs provider used for resolving IP addresses.
WhoIsDefaultProvider(WhoIsConfig) - Constructor for class com.pushtechnology.diffusion.api.whois.WhoIsDefaultProvider
Create WhoIs Default provider.
WhoIsDetails - Interface in com.pushtechnology.diffusion.api.whois
This object encapsulates the details of a 'WhoIs' lookup on the WhoIs service.
WhoIsProvider - Interface in com.pushtechnology.diffusion.api.whois
The interface for a WhoIs provider class.
writeResponse(ByteBuffer) - Method in interface com.pushtechnology.diffusion.api.webserver.HTTPRequest
Write a response.
WriteSelectorConfig - Interface in com.pushtechnology.diffusion.api.config
Deprecated.
this configuration is not used since 5.3
writeURLConnection(URLConnection) - Static method in class com.pushtechnology.diffusion.api.HTTPUtils
Write URL Connection.

X

XMLProperties - Interface in com.pushtechnology.diffusion.api.publisher
Deprecated.
since 5.5; in future releases XMLPropertiesEvents will no longer be generated
XMLPropertiesListener - Interface in com.pushtechnology.diffusion.api.publisher
Deprecated.
since 5.5; in future releases XMLPropertiesEvents will no longer be generated
xmlPropertiesLoaded(XMLProperties) - Method in interface com.pushtechnology.diffusion.api.publisher.XMLPropertiesListener
Deprecated.
This is called to notify the load of an XML Properties instance.
xmlPropertiesSaved(XMLProperties) - Method in interface com.pushtechnology.diffusion.api.publisher.XMLPropertiesListener
Deprecated.
This is called to notify the save of an XML Properties instance.
XMLUtils - Class in com.pushtechnology.diffusion.api
XML Utilities to simplify XML Handling.
A B C D E F G H I J K L M N O P Q R S T U V W X 
DiffusionTM Java API 5.9.4

Copyright © 2016 Push Technology Ltd. All Rights Reserved.