Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abort() - Method in interface com.pushtechnology.diffusion.client.session.reconnect.ReconnectionStrategy.ReconnectionAttempt
-
Abort the reconnection attempt.
- ABORTED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
The client connection was aborted by the server, possibly because the connection was disallowed.
- abstain() - Method in interface com.pushtechnology.diffusion.client.security.authentication.Authenticator.Callback
-
The authentication has neither passed nor failed.
- ABSTAIN - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.AnonymousConnectionAction
-
Defer authentication decision for anonymous connection attempts to subsequent authentication handlers.
- abstainAnonymousConnections() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Instruct the system authentication handler to defer authentication decisions for anonymous connections to subsequent handlers.
- ACCESS_DENIED - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
The request was rejected because the caller has insufficient permissions.
- ACQUIRE_LOCK - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Acquire a session lock.
- ACTIVE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.State
-
The session is connected and active.
- add(String...) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.MutableRecordModel
-
Adds new values to the end of a variable length field list.
- add(String, int, String...) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.MutableRecordModel
-
Adds new values to the end of a variable length field list.
- addAndSet(String, TopicSpecification, Class<T>, T) - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Ensures a topic exists and sets its value.
- addAndSet(String, TopicSpecification, Class<T>, T, UpdateConstraint) - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Ensures a topic exists and sets its value.
- addBranchMapping(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SessionTrees.BranchMappingTable.Builder
-
Add a new branch mapping.
- ADDED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener.NotificationType
-
The topic has been added.
- addFallbackStream(Class<? extends V>, Topics.ValueStream<V>) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Add a fallback stream.
- addFields(String...) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Builder
-
Adds one or more field values.
- addFields(Collection<String>) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Builder
-
Adds one or more field values.
- addListener(TopicNotifications.TopicNotificationListener) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications
-
Register a listener to receive topic notifications.
- addListener(Session.Listener) - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Add a session listener.
- addMissingTopicHandler(String, TopicControl.MissingTopicNotificationStream) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl
-
Register a
TopicControl.MissingTopicNotificationStream
to handle requests for a branch of the topic tree. - addPrincipal(String, String, Set<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Add a new principal.
- addPrincipal(String, String, Set<String>, String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Add a new locked principal.
- addRecord() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.MutableRecordModel
-
Adds a new initialized record occurrence to the end of a variable multiplicity record list.
- addRecord(String...) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Builder
-
Adds a new record comprising the specified field values.
- addRecord(Collection<String>) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Builder
-
Adds a new record comprising the specified field values.
- addRequestHandler(String, Class<? extends T>, Class<? super R>, Messaging.RequestHandler<T, R>, String...) - Method in interface com.pushtechnology.diffusion.client.features.Messaging
-
Register a request handler to handle requests from other client sessions for a branch of the message path hierarchy.
- addSessionEventListener(ClientControl.SessionEventStream, ClientControl.SessionEventParameters) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Register a listener that will be notified of
client session events
. - addStream(TopicSelector, Class<? extends V>, Topics.ValueStream<V>) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Add a value stream to receive topic events for topics that match a given
TopicSelector
and have a value class that matches a specified type. - addStream(String, Class<? extends V>, Topics.ValueStream<V>) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Add a value stream to receive topic events for topics that match a given
TopicSelector
expression and have a value class that matches a specified type. - addTimeSeriesStream(TopicSelector, Class<? extends V>, Topics.ValueStream<TimeSeries.Event<V>>) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Add a value stream to receive topic events for time series topics that match a given
TopicSelector
and have a compatible time series event value class. - addTimeSeriesStream(String, Class<? extends V>, Topics.ValueStream<TimeSeries.Event<V>>) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Add a value stream to receive topic events for time series topics that match a given
TopicSelector
expression and have a compatible time series value class. - addTopic(String, TopicSpecification) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl
-
Request creation of a topic.
- addTopic(String, TopicType) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl
-
Request creation of a topic.
- AddTopicException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.control.topics.TopicControl.AddTopicException
- after() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventParameters
-
Indicates a session start time after which session events should be notified.
- after(String) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies a logical start point within the topic tree.
- after(Instant) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventParameters.Builder
-
Used to indicate that events are only to be reported for sessions that start after a specified time.
- ALL_FIXED_PROPERTIES - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
This constant can be used instead of a property key in requests for session property values to indicate that all fixed session properties are required.
- ALL_TYPES - Static variable in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
A constant set of all topic types that can be fetched.
- ALL_USER_PROPERTIES - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
This constant can be used instead of a property key in requests for session property values to indicate that all user defined session properties are required.
- allEdits() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery configured to perform an edit range query with the edit range that selects all edits in the entire time series.
- allow() - Method in interface com.pushtechnology.diffusion.client.security.authentication.Authenticator.Callback
-
Authentication passed - allow the authentication request with fixed properties as supplied but no user-defined properties.
- allow(Map<String, String>) - Method in interface com.pushtechnology.diffusion.client.security.authentication.Authenticator.Callback
-
Authentication passed - allow the authentication request with modified fixed session properties and/or specified user-defined properties.
- ALLOW - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.AnonymousConnectionAction
-
Accept anonymous connection attempts.
- allowAnonymousConnections(Set<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Instruct the system authentication handler to allow anonymous connections.
- and(UpdateConstraint) - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint
-
Returns a composed constraint that represents a logical AND of this constraint and another.
- ANONYMOUS - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Value returned by
Session.getPrincipal()
if no principal name is associated with the session. - anyOf(TopicSelector...) - Method in interface com.pushtechnology.diffusion.client.topics.TopicSelectors
-
Create a
SELECTOR_SET
selector that matches if any of the providedselectors
match. - anyOf(String...) - Method in interface com.pushtechnology.diffusion.client.topics.TopicSelectors
-
Convenient wrapper of
TopicSelectors.anyOf(TopicSelector...)
that first parses the supplied expressions to create selectors. - append(SecurityControl.ScriptBuilder) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Append all the operations of
other
to this ScriptBuilder. - append(SystemAuthenticationControl.ScriptBuilder) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Append all the operations of
other
to this ScriptBuilder. - append(String, Class<V>, V) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries
-
Update a time series topic by appending a new value.
- append(String, Class<V>, V, Instant) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries
-
Update a time series topic by appending a new value with a supplied timestamp.
- apply(BinaryDelta) - Method in interface com.pushtechnology.diffusion.datatype.binary.Binary
-
Apply a binary delta to this value to create a new value.
- apply(BinaryDelta) - Method in interface com.pushtechnology.diffusion.datatype.json.JSON
-
Apply a binary delta to this JSON value to create a new value.
- apply(V, D) - Method in interface com.pushtechnology.diffusion.datatype.DeltaType
-
Apply a delta to a value.
- applyJsonPatch(String, String) - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Applies a JSON Patch to a JSON topic.
- applyJsonPatch(String, String, UpdateConstraint) - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Applies a JSON Patch to a JSON topic.
- as(Class<T>) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with a different query value type.
- asFields() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2
-
Returns the data value as a list of fields.
- asInputStream() - Method in interface com.pushtechnology.diffusion.datatype.Bytes
-
Returns a stream that provides the data.
- asJSONString() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.Schema
-
Returns the schema in a JSON format.
- asModel(Schema) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2
-
Parses the value into a model based upon a specified schema.
- asRecords() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2
-
Returns the data value as a list of lists of strings.
- assignRoles(String, Set<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Change a principal's assigned roles.
- asValidatedModel(Schema) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2
-
Parses the value into a model based upon a specified schema.
- asValue() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.RecordModel
-
Creates an immutable
RecordV2
object generated from the model. - authenticate(String, Credentials, Map<String, String>, Map<String, String>, Authenticator.Callback) - Method in interface com.pushtechnology.diffusion.client.security.authentication.Authenticator
-
Processes an authentication request.
- AUTHENTICATE - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
Add an authentication handler.
- AuthenticationControl - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
This feature allows a client session to authenticate the credentials of other sessions, and optionally revoke such authentications.
- AuthenticationControl.ControlAuthenticator - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
A control authenticator.
- AuthenticationException - Exception in com.pushtechnology.diffusion.client.session
-
The session operation failed due to an authentication failure.
- AuthenticationException() - Constructor for exception com.pushtechnology.diffusion.client.session.AuthenticationException
-
Constructor.
- AuthenticationException(String) - Constructor for exception com.pushtechnology.diffusion.client.session.AuthenticationException
- AuthenticationException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.client.session.AuthenticationException
- Authenticator - Interface in com.pushtechnology.diffusion.client.security.authentication
-
An authentication handler that processes authentication requests from the server.
- Authenticator.Callback - Interface in com.pushtechnology.diffusion.client.security.authentication
-
Single-use callback provided to the
authenticate
call. - author() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.EventMetadata
-
Server-authenticated identity of the session that created the event.
- AUTHORIZATION - Enum constant in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
The unsubscription occurred because the session is no longer authorized to access the topic.
B
- BACK_PRESSURE - Enum constant in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
The server has a significant backlog of messages for the session, and the topic specification has the
conflation topic property
set to "unsubscribe". - basic(String, String) - Method in interface com.pushtechnology.diffusion.client.session.proxy.ProxyAuthenticationFactory
-
Provides an implementation of Basic proxy authentication.
- before(String) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies a logical end point within the topic tree.
- binary() - Method in interface com.pushtechnology.diffusion.datatype.DataTypes
-
Data type that supports arbitrary binary data.
- Binary - Interface in com.pushtechnology.diffusion.datatype.binary
-
A read-only binary value with support for binary deltas.
- BINARY - Enum constant in enum class com.pushtechnology.diffusion.client.topics.details.TopicType
-
Topic that stores and publishes binary values.
- BINARY_DATATYPE_NAME - Static variable in interface com.pushtechnology.diffusion.datatype.DataTypes
-
Binary data type name.
- BinaryDataType - Interface in com.pushtechnology.diffusion.datatype.binary
-
Binary data type.
- BinaryDelta - Interface in com.pushtechnology.diffusion.datatype
-
Binary delta type.
- binaryDeltaType() - Method in interface com.pushtechnology.diffusion.datatype.binary.BinaryDataType
-
Returns support for binary deltas.
- binaryDeltaType() - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Returns the binary delta type for this data type, if any.
- binaryDeltaType() - Method in interface com.pushtechnology.diffusion.datatype.json.JSONDataType
-
Returns support for binary deltas.
- binaryDeltaType() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2DataType
-
Returns support for binary deltas.
- binaryDiff(JSON) - Method in interface com.pushtechnology.diffusion.datatype.json.JSON
-
Compare this JSON value with an earlier version to create a binary delta.
- BRANCH_MAPPINGS - Enum constant in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
The unsubscription occurred because branch mapping rules changed.
- build() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventParameters.Builder
-
Builds a new
SessionEventParameters
instance with the current settings of the builder. - build() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Builder
-
Builds a
RecordV2
object from the current builder state. - build() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Build an immutable Schema.
- build(String, Class<T>) - Method in interface com.pushtechnology.diffusion.client.features.UpdateStream.Builder
-
Creates an
UpdateStream
to use for updating a specific topic. - build(String, Class<T>, RetryStrategy) - Method in interface com.pushtechnology.diffusion.client.features.UpdateStream.Builder
-
Creates a
RecoverableUpdateStream
to use for updating a specific topic. - build(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryAcceptor.SecondaryAcceptorBuilder
-
Builds a secondary acceptor using the current values known to this builder.
- build(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryInitiator.SecondaryInitiatorBuilder
-
Builds a secondary initiator instance using the current values known to this builder.
- build(String, List<String>, String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.PrimaryInitiator.PrimaryInitiatorBuilder
-
Builds a primary initiator using the current values known to this builder.
- Bytes - Interface in com.pushtechnology.diffusion.datatype
-
Read-only interface for values that are internally represented as binary data.
C
- Callback - Interface in com.pushtechnology.diffusion.client.callbacks
-
Callback interface that provides responses from the server.
- CALLBACK_EXCEPTION - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
An application callback threw an exception.
- Callback.Default - Class in com.pushtechnology.diffusion.client.callbacks
-
Abstract default callback.
- canReadAs(Class<T>) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Test whether this data type is compatible with
classOfT
. - changedProperties() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event
-
Provides a map of the previous values of session properties that have changed.
- changePrincipal(String, Credentials) - Method in interface com.pushtechnology.diffusion.client.features.Security
-
Deprecated.
- changeRoles(SessionId, Set<String>, Set<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Changes the assigned roles of another session.
- changeRoles(String, Set<String>, Set<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Allows a session to change the assigned roles of all sessions that satisfy a given session filter.
- changes(Schema) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta
-
Returns a list of the changes represented by the delta with reference to a specified schema.
- checkRemoteServer(String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers
-
Check the current state of a named remote server.
- clear() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Builder
-
Clears all current values from the builder allowing it to be reused to generate new data.
- clearVariableFields(String, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.MutableRecordModel
-
Remove all optional instances of a variable multiplicity field.
- clearVariableRecords() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.MutableRecordModel
-
Removes all optional instances of a variable multiplicity record.
- CLIENT_IP - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for client IP address.
- CLIENT_TYPE - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for client type.
- CLIENT_UNRESPONSIVE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
The client had become unresponsive.
- ClientControl - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
This feature provides the ability for a client session to control other client sessions.
- ClientControl.CloseReason - Enum Class in com.pushtechnology.diffusion.client.features.control.clients
-
The server's view of why a client session was closed.
- ClientControl.QueueEventStream - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Handler for client queue events.
- ClientControl.QueueEventStream.Default - Class in com.pushtechnology.diffusion.client.features.control.clients
-
This provides a default implementation of
ClientControl.QueueEventStream
. - ClientControl.SessionEventParameters - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Provides parameters which specify the level of detail required by a
ClientControl.SessionEventStream
registered usingsetSessionEventListener
. - ClientControl.SessionEventParameters.Builder - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
A builder for
SessionEventParameters
. - ClientControl.SessionEventStream - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
The stream to receive for session event listener notifications.
- ClientControl.SessionEventStream.Default - Class in com.pushtechnology.diffusion.client.features.control.clients
-
This provides a default implementation of
ClientControl.SessionEventStream
which will simply log session event callbacks at debug level. - ClientControl.SessionEventStream.Event - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
The interface for an event delivered by the stream.
- ClientControl.SessionEventStream.Event.State - Enum Class in com.pushtechnology.diffusion.client.features.control.clients
-
The session state.
- ClientControl.SessionEventStream.Event.Type - Enum Class in com.pushtechnology.diffusion.client.features.control.clients
-
The event type.
- ClientControl.SessionFilterOperationResult - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Result of ClientControl operations that identify sessions using a client filter and provide a result through a
CompletableFuture
. - ClientControl.SessionLockDetails - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Provides details of a session lock.
- ClientControl.SessionPropertiesStream - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Deprecated.since 6.11
Use the new
ClientControl.addSessionEventListener(com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream, com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventParameters)
, which provides greater functionality and reports sessions at all cluster members. This interface will be removed in a future release. - ClientControl.SessionPropertiesStream.Default - Class in com.pushtechnology.diffusion.client.features.control.clients
-
Deprecated.This provides a default implementation of
ClientControl.SessionPropertiesStream
which will simply log session properties callbacks at debug level. - ClientControl.SessionPropertiesStream.EventType - Enum Class in com.pushtechnology.diffusion.client.features.control.clients
-
Deprecated.Event type.
- close() - Method in interface com.pushtechnology.diffusion.client.callbacks.Registration
-
Request that the handler is unregistered from the server.
- close() - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Close the session.
- close(SessionId) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Close a client session.
- close(String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Close all client sessions matching a given session filter.
- CLOSED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.State
-
The session has closed.
- CLOSED_BY_CLIENT - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
The client requested close.
- CLOSED_BY_CLIENT - Enum constant in enum class com.pushtechnology.diffusion.client.session.Session.State
-
The session has been closed by the client.
- CLOSED_BY_CONTROLLER - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
Closed by a client session.
- CLOSED_BY_SERVER - Enum constant in enum class com.pushtechnology.diffusion.client.session.Session.State
-
The session has been closed (or rejected) by the server.
- CLOSED_FAILED - Enum constant in enum class com.pushtechnology.diffusion.client.session.Session.State
-
The session has lost its connection to a server and could not be recovered.
- closeReason() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event
-
Provides the reason a session was closed.
- CLUSTER_REPARTITION - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
A cluster operation failed because partition ownership changed during processing.
- CLUSTER_ROUTING - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
A cluster operation failed to be routed to a server within the cluster due to a communication failure, or the server that owns a partition is not currently known.
- ClusterRepartitionException - Exception in com.pushtechnology.diffusion.client.features
-
Indicates a cluster operation failed because partition ownership changed during processing.
- ClusterRepartitionException() - Constructor for exception com.pushtechnology.diffusion.client.features.ClusterRepartitionException
-
Constructor.
- ClusterRepartitionException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.ClusterRepartitionException
-
Constructor.
- ClusterRepartitionException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.client.features.ClusterRepartitionException
-
Constructor.
- ClusterRoutingException - Exception in com.pushtechnology.diffusion.client.features
-
Indicates a cluster operation failed to be routed to a server within the cluster due to a communication failure.
- ClusterRoutingException() - Constructor for exception com.pushtechnology.diffusion.client.features.ClusterRoutingException
-
Constructor.
- ClusterRoutingException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.ClusterRoutingException
-
Constructor.
- ClusterRoutingException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.client.features.ClusterRoutingException
-
Constructor.
- com.pushtechnology.diffusion.client - package com.pushtechnology.diffusion.client
-
Client API.
- com.pushtechnology.diffusion.client.callbacks - package com.pushtechnology.diffusion.client.callbacks
-
Client API : Callback Interfaces.
- com.pushtechnology.diffusion.client.features - package com.pushtechnology.diffusion.client.features
-
Client API : Standard Features.
- com.pushtechnology.diffusion.client.features.control - package com.pushtechnology.diffusion.client.features.control
-
Client API : Control Features.
- com.pushtechnology.diffusion.client.features.control.clients - package com.pushtechnology.diffusion.client.features.control.clients
-
Client API : Client Control Features.
- com.pushtechnology.diffusion.client.features.control.topics - package com.pushtechnology.diffusion.client.features.control.topics
-
Client API : Topic Control Features.
- com.pushtechnology.diffusion.client.features.control.topics.views - package com.pushtechnology.diffusion.client.features.control.topics.views
-
Client API : Topic View Features.
- com.pushtechnology.diffusion.client.security - package com.pushtechnology.diffusion.client.security
-
Client API : Security.
- com.pushtechnology.diffusion.client.security.authentication - package com.pushtechnology.diffusion.client.security.authentication
-
Client API : Security - Authentication.
- com.pushtechnology.diffusion.client.session - package com.pushtechnology.diffusion.client.session
-
Client API : Sessions.
- com.pushtechnology.diffusion.client.session.proxy - package com.pushtechnology.diffusion.client.session.proxy
-
Client API : Proxy.
- com.pushtechnology.diffusion.client.session.reconnect - package com.pushtechnology.diffusion.client.session.reconnect
-
Client API : Reconnect.
- com.pushtechnology.diffusion.client.session.retry - package com.pushtechnology.diffusion.client.session.retry
-
Client API : Retry.
- com.pushtechnology.diffusion.client.topics - package com.pushtechnology.diffusion.client.topics
-
Client API : Topics.
- com.pushtechnology.diffusion.client.topics.details - package com.pushtechnology.diffusion.client.topics.details
-
Client API : Topic Specifications.
- com.pushtechnology.diffusion.client.types - package com.pushtechnology.diffusion.client.types
-
Client API : Common Types.
- com.pushtechnology.diffusion.datatype - package com.pushtechnology.diffusion.datatype
-
Data Types.
- com.pushtechnology.diffusion.datatype.binary - package com.pushtechnology.diffusion.datatype.binary
-
Binary Data Type.
- com.pushtechnology.diffusion.datatype.json - package com.pushtechnology.diffusion.datatype.json
-
JSON Data Type.
- com.pushtechnology.diffusion.datatype.recordv2 - package com.pushtechnology.diffusion.datatype.recordv2
-
RecordV2 Data Type.
- com.pushtechnology.diffusion.datatype.recordv2.model - package com.pushtechnology.diffusion.datatype.recordv2.model
-
RecordV2 Data Type : Data Model.
- com.pushtechnology.diffusion.datatype.recordv2.schema - package com.pushtechnology.diffusion.datatype.recordv2.schema
-
RecordV2 Data Type : Schemas.
- COMMUNICATION_FAILURE - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
Communication with the server failed.
- COMPRESSION - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that allows the compression policy to be set on a per-topic basis.
- CONFLATION - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies the conflation policy of the topic.
- CONNECTED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.CheckRemoteServerResult.ConnectionState
-
The remote server is connected.
- CONNECTED_ACTIVE - Enum constant in enum class com.pushtechnology.diffusion.client.session.Session.State
-
An active connection with the server has been established.
- CONNECTING - Enum constant in enum class com.pushtechnology.diffusion.client.session.Session.State
-
The session is establishing its initial connection.
- CONNECTION_LOST - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
The connection to the client was lost - possibly dropped by the client.
- CONNECTION_TIMEOUT - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption
-
Specifies the connection timeout session attribute value (in milliseconds).
- connectionOption(RemoteServers.RemoteServer.ConnectionOption, String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Builder
-
Deprecated.Specifies a single connection option.
- connectionOption(RemoteServers.RemoteServer.ConnectionOption, String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryServer.SecondaryBuilder
-
Specifies a single connection option.
- connectionOptions(Map<RemoteServers.RemoteServer.ConnectionOption, String>) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Builder
-
Deprecated.Specifies a map of
RemoteServers.RemoteServer.ConnectionOption
settings. - connectionOptions(Map<RemoteServers.RemoteServer.ConnectionOption, String>) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryServer.SecondaryBuilder
-
Specifies a map of
RemoteServers.RemoteServer.ConnectionOption
settings. - connectionTimeout(int) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets the connection timeout.
- CONNECTOR - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for connector name.
- constraint(UpdateConstraint) - Method in interface com.pushtechnology.diffusion.client.features.UpdateStream.Builder
-
Specifies an update constraint for this update stream.
- CONTROL - Enum constant in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
The unsubscription was requested either by another session or by the server.
- CONTROL_SERVER - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
Change the server's runtime state - for example, shut it down.
- copyTo(OutputStream) - Method in interface com.pushtechnology.diffusion.datatype.Bytes
-
Write the bytes to an output stream.
- COUNTER - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
-
Counters measure discrete events.
- COUNTRY - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for country code.
- create(String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SessionTrees.BranchMappingTable.Builder
-
Create a new branch mapping table.
- create(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.SessionMetricCollector.Builder
-
Create a new
Metrics.SessionMetricCollector
using the values currently known to this builder. - create(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.TopicMetricCollector.Builder
-
Create a new
Metrics.TopicMetricCollector
using the values currently known to this builder. - create(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Builder
-
Deprecated.Creates a remote server object using the current values known to this builder.
- CREATED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.topics.TopicControl.AddTopicResult
-
A new topic was created.
- CREATED - Enum constant in enum class com.pushtechnology.diffusion.client.features.TopicCreationResult
-
A new topic was created.
- createHandler(SessionAttributes) - Method in interface com.pushtechnology.diffusion.client.session.proxy.HTTPProxyAuthentication
-
Create a challenge handler using this proxy authentication scheme.
- createMutableModel() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.Schema
-
Create a mutable model based upon the schema.
- createRemoteServer(RemoteServers.RemoteServer) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers
-
Create a new remote server instance at the server.
- createTopicView(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.views.TopicViews
-
Create a new named topic view.
- createUpdateStream(String, TopicSpecification, Class<T>) - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Deprecated.since 6.9
- createUpdateStream(String, TopicSpecification, Class<T>, UpdateConstraint) - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Deprecated.since 6.9
- createUpdateStream(String, Class<T>) - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Deprecated.since 6.9
- createUpdateStream(String, Class<T>, UpdateConstraint) - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Deprecated.since 6.9
- credentials() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Returns shared credentials factory to use for creating credentials.
- credentials(Credentials) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Builder
-
Deprecated.Specifies the credentials to use when connecting to the primary server.
- credentials(Credentials) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryServer.SecondaryBuilder
-
Specifies the credentials to use to authenticate the connection.
- credentials(Credentials) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set credentials.
- Credentials - Interface in com.pushtechnology.diffusion.client.types
-
Immutable value containing the proof material to support an authentication request.
- Credentials.Factory - Interface in com.pushtechnology.diffusion.client.types
-
Factory for the standard credential types.
- Credentials.Type - Enum Class in com.pushtechnology.diffusion.client.types
-
Type code indicated the type of the credentials.
- currentServer() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricsRequest
-
Specifies that metrics should be fetched from the server to which the current session is connected.
- custom(byte[]) - Method in interface com.pushtechnology.diffusion.client.types.Credentials.Factory
-
Create a
Credentials
of typeCUSTOM
. - CUSTOM - Enum constant in enum class com.pushtechnology.diffusion.client.types.Credentials.Type
-
Application-specific credentials.
- customCredentials(byte[]) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set credentials of type
Credentials.Type.CUSTOM
.
D
- DataType<V> - Interface in com.pushtechnology.diffusion.datatype
-
A data type is specified for a particular class (its value class).
- dataTypes() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Returns data type implementations.
- DataTypes - Interface in com.pushtechnology.diffusion.datatype
-
Diffusion data type implementations.
- decimal(String, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a single occurrence decimal field to the current record.
- decimal(String, int, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a fixed multiplicity decimal field to the current record.
- decimal(String, int, int, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a decimal field to the current record.
- DECIMAL - Enum constant in enum class com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Field.Type
-
Decimal.
- Default() - Constructor for class com.pushtechnology.diffusion.client.callbacks.Callback.Default
- Default() - Constructor for class com.pushtechnology.diffusion.client.callbacks.Stream.Default
- Default() - Constructor for class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.QueueEventStream.Default
- Default() - Constructor for class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Default
- Default() - Constructor for class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.Default
-
Deprecated.
- Default() - Constructor for class com.pushtechnology.diffusion.client.features.control.topics.TopicControl.MissingTopicNotificationStream.Default
- Default() - Constructor for class com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener.Default
- Default() - Constructor for class com.pushtechnology.diffusion.client.features.Messaging.FilteredRequestCallback.Default
- Default() - Constructor for class com.pushtechnology.diffusion.client.features.Topics.SubscriberStream.Default
- Default() - Constructor for class com.pushtechnology.diffusion.client.features.Topics.ValueStream.Default
- Default() - Constructor for class com.pushtechnology.diffusion.client.session.Session.ErrorHandler.Default
- Default() - Constructor for class com.pushtechnology.diffusion.client.session.Session.Listener.Default
- DEFAULT - Static variable in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventParameters
-
Provides a default instance of
SessionEventParameters
that will request notifications for all sessions, including those currently active, but providing no session properties. - DEFAULT_CONNECTION_TIMEOUT - Static variable in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
The default connection timeout = 2 seconds.
- DEFAULT_INPUT_BUFFER_SIZE - Static variable in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
The default size of socket and message input buffers in bytes.
- DEFAULT_MAXIMUM_MESSAGE_SIZE - Static variable in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
The default maximum message size in bytes.
- DEFAULT_MAXIMUM_QUEUE_SIZE - Static variable in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
The default maximum outbound queue size in messages.
- DEFAULT_OUTPUT_BUFFER_SIZE - Static variable in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
The default size of socket and message output buffers in bytes.
- DEFAULT_RECONNECTION_TIMEOUT - Static variable in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
The default reconnection timeout = 60 seconds.
- DEFAULT_RECOVERY_BUFFER_SIZE - Static variable in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
The default recovery buffer size in messages.
- DEFAULT_REQUEST_PATH - Static variable in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
The default request path.
- DEFAULT_SELECTION_SCOPE - Static variable in interface com.pushtechnology.diffusion.client.features.Topics
-
The default topic selection scope.
- DEFAULT_WRITE_TIMEOUT - Static variable in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
The default write timeout for blocking writes = 2 seconds.
- deisolatePath(String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Re-instate inheritance of path permission assignments from parents of the given path.
- deltaType(Class<D>) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Obtain a
DeltaType
by class. - deltaType(String) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Obtain a
DeltaType
by name. - DeltaType<V,
D> - Interface in com.pushtechnology.diffusion.datatype -
Optional extension provided by
DataType
implementations that support incremental changes to values. - deny() - Method in interface com.pushtechnology.diffusion.client.security.authentication.Authenticator.Callback
-
Authentication failed - deny the authentication request.
- DENY - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.AnonymousConnectionAction
-
Deny anonymous connection attempts.
- denyAnonymousConnections() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Instruct the system authentication handler to deny anonymous connections.
- descendants(String) - Method in interface com.pushtechnology.diffusion.datatype.json.JSONDelta.ChangeMap
-
Returns a view of the portion of this map whose keys are descendants of
pointer
. - deselect(TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.NotificationRegistration
-
Request to stop receiving notifications for all topics matched by the given selector.
- deselect(String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.NotificationRegistration
-
Request to stop receiving notifications for all topics matched by the given selector.
- DESELECT - Enum constant in enum class com.pushtechnology.diffusion.client.topics.TopicSelection.Type
-
Represents deselection of topics (i.e.
- DESELECTED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener.NotificationType
-
The topic is no longer selected due to the removal of a selector.
- diff(Binary) - Method in interface com.pushtechnology.diffusion.datatype.binary.Binary
-
Compare this value with an earlier version to calculate a binary delta.
- diff(JSON) - Method in interface com.pushtechnology.diffusion.datatype.json.JSON
-
Compare this JSON value with an earlier version to calculate a structural delta.
- diff(RecordV2) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2
-
Compare this value with an earlier version to calculate a structural delta.
- diff(V, V) - Method in interface com.pushtechnology.diffusion.datatype.DeltaType
-
Create a delta from two values.
- Diffusion - Enum Class in com.pushtechnology.diffusion.client
-
Provides facilities that are shared between sessions.
- Diffusion.Implementation - Interface in com.pushtechnology.diffusion.client
-
The contract with the implementation.
- DISCONNECTED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.State
-
The session is disconnected.
- DISCONNECTED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.EventType
-
Deprecated.Session has disconnected.
- DONT_RETAIN_VALUE - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies a topic should not retain its last value.
- DOUBLE - Enum constant in enum class com.pushtechnology.diffusion.client.topics.details.TopicType
-
Topic that stores and publishes IEEE 754 double-precision floating point numbers.
- DOUBLE_DATATYPE_NAME - Static variable in interface com.pushtechnology.diffusion.datatype.DataTypes
-
Double data type name.
- doubleFloat() - Method in interface com.pushtechnology.diffusion.datatype.DataTypes
-
Data type that supports double-precision floating point numbers.
E
- edit(String, long, Class<V>, V) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries
-
Update a time series topic by appending a new value that overrides the value of an existing event.
- EDIT_EVENT_STREAM - Enum constant in enum class com.pushtechnology.diffusion.client.features.TimeSeries.QueryResult.StreamStructure
-
The stream is presented in time series order.
- EDIT_OWN_TIME_SERIES_EVENTS - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Submit edits to time series topic events which have an author which is the same as the principal of the calling session.
- EDIT_TIME_SERIES_EVENTS - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Submit edits to time series topic events.
- editRange() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery configured to perform a value range query with the edit range set to the entire time series.
- ENVIRONMENT - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for client environment.
- EQ - Enum constant in enum class com.pushtechnology.diffusion.client.features.UpdateConstraint.Operator
-
Lenient equals.
- equals(Object) - Method in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
- equals(Object) - Method in class com.pushtechnology.diffusion.client.session.retry.RetryStrategy
- equals(Object) - Method in interface com.pushtechnology.diffusion.client.session.SessionId
-
Checks identifier against another object for equality.
- errorHandler(Session.ErrorHandler) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Nominates an error handler for a session.
- ErrorReason - Class in com.pushtechnology.diffusion.client.callbacks
-
Reason codes used to report error conditions.
- ErrorReason(int, String) - Constructor for class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
Constructor.
- ErrorReport - Interface in com.pushtechnology.diffusion.client.types
-
An error report.
- ErrorReportsException - Exception in com.pushtechnology.diffusion.client.features
-
Thrown to report one or more
ErrorReport
s}. - ErrorReportsException(String, List<ErrorReport>) - Constructor for exception com.pushtechnology.diffusion.client.features.ErrorReportsException
-
Constructor.
- escape(String) - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Escapes special characters in a string that is to be used within a topic property or a session filter.
- escape(String) - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
-
Escapes special characters in a string.
- ExistingTopicException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.control.topics.TopicControl.ExistingTopicException
- EXISTS - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.topics.TopicControl.AddTopicResult
-
A topic with the same specification already exists.
- EXISTS - Enum constant in enum class com.pushtechnology.diffusion.client.features.TopicCreationResult
-
A topic with the same specification already exists.
- EXPIRED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
The session had an
Session.EXPIRY_TIME
specified which expired before the sessionre-authenticated
. - EXPIRY_TIME - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for client session expiry time.
- exportsToPrometheus() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricCollector
-
Indicates whether the metric collector exports to Prometheus.
- exportToPrometheus(boolean) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.Builder
-
Specifies whether the metric collector should export metrics to Prometheus or not.
- EXPOSE_BRANCH - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Expose a branch of the topic tree as a virtual session tree.
F
- FAILED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.CheckRemoteServerResult.ConnectionState
-
The connection has failed.
- FAILED_OVER - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
The session has failed over to a different Diffusion server.
- FAILED_OVER - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.State
-
The session has failed over to a different server in the cluster after a disconnection.
- FAILED_OVER - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.EventType
-
Deprecated.Use in a clustered configuration to indicate that the session failed over from another server.
- failedOperation() - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate.JsonPatchResult
- FailedPatchException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.TopicUpdate.FailedPatchException
-
Constructor.
- FailedPatchException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.client.features.TopicUpdate.FailedPatchException
-
Constructor.
- feature(Class<T>) - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Obtain a feature.
- Feature - Interface in com.pushtechnology.diffusion.client.session
-
This is the base interface for features that may be added directly to a client
session
. - fetch() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricsRequest
-
Fetches the metrics from the server.
- fetch(TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Sends a fetch request to the server.
- fetch(String) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Sends a fetch request to the server.
- fetchRequest() - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Creates an unconfigured fetch request.
- FIELD_CHANGED - Enum constant in enum class com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change.Type
-
The change indicates that a field had its value changed.
- fieldCount(String, int, String) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.RecordModel
-
Returns the actual number of occurrences of a named field within a specified record occurrences.
- fieldIndex() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change
-
Returns the index of the affected field.
- fieldName() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change
-
Returns the name of the affected field.
- FIELDS_ADDED - Enum constant in enum class com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change.Type
-
The change indicates that one or more field values have been added.
- FIELDS_REMOVED - Enum constant in enum class com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change.Type
-
The change indicates that a field value has been removed.
- filter() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventParameters
-
Returns the session filter.
- filter(String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventParameters.Builder
-
Sets a session filter which will determine which sessions events will be notified for.
- filter(Pattern) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricsRequest
-
Allows specifying a regular expression to filter the metrics returned.
- filter(Set<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricsRequest
-
Allows specifying a set of filters to limit the metrics returned.
- first(int) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies a maximum number of topic results to be returned from the start of the required range.
- forEdits() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery configured to perform an edit range query with the view range set to the entire time series.
- forValues() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery configured to perform a value range query with the view range set to the entire time series.
- from(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the anchor of the current range configured to be an absolute sequence number.
- from(String) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies a logical start point within the topic tree.
- from(Instant) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the anchor of the current range configured to be an absolute time.
- from(Date) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the anchor of the current range configured to be an absolute time.
- fromJsonString(String) - Method in interface com.pushtechnology.diffusion.datatype.json.JSONDataType
-
Parse a JSON string.
- fromLast(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the anchor of the current range configured to be a relative offset before the end of the time series.
- fromLast(Duration) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the anchor of the current range configured to be a relative time from the timestamp of the last event in the time series.
- fromLastMillis(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the anchor of the current range configured to be a relative time from the timestamp of the last event in the time series.
- fromStart() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the anchor of the current range configured to be the start of the time series.
- FULL_PATH_PATTERN - Enum constant in enum class com.pushtechnology.diffusion.client.topics.TopicSelector.Type
-
The selector is a full-path pattern.
- FULL_PATH_PATTERN_PREFIX - Static variable in interface com.pushtechnology.diffusion.client.topics.TopicSelector
-
Prefix used for
FULL_PATH_PATTERN
expressions.
G
- GATEWAY_ID - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for gateway client identifier.
- GATEWAY_TYPE - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for gateway client type.
- GAUGE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
-
Gauges are current measurements, such as bytes of memory currently used or the number of items in a queue.
- GAUGE_HISTOGRAM - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
-
GaugeHistograms measure current distributions.
- GE - Enum constant in enum class com.pushtechnology.diffusion.client.features.UpdateConstraint.Operator
-
Lenient greater than or equals.
- get() - Method in interface com.pushtechnology.diffusion.client.features.UpdateStream
-
Return the latest value of the topic set using this update stream.
- get(String) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.RecordModel
-
Get a field value.
- get(String, int, String, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.RecordModel
-
Get a field value.
- getAnonymousAction() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.SystemAuthenticationConfiguration
-
Returns the action to take for anonymous connection attempts.
- getAssignedRoles() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.SystemPrincipal
-
Returns the roles that the system authentication handler will assign to the principal.
- getAttempts() - Method in class com.pushtechnology.diffusion.client.session.retry.RetryStrategy
-
Returns the number of retry attempts.
- getAttributes() - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Returns the session attributes.
- getBranchMappings() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SessionTrees.BranchMappingTable
-
Returns the branch mappings.
- getBranchMappingTable(String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SessionTrees
-
Retrieve a branch mapping table from the server.
- getByClass(Class<V>) - Method in interface com.pushtechnology.diffusion.datatype.DataTypes
-
Obtain a
DataType
implementation by class. - getByName(String) - Method in interface com.pushtechnology.diffusion.datatype.DataTypes
-
Obtain a
DataType
implementation by type name. - getColumn() - Method in interface com.pushtechnology.diffusion.client.types.ErrorReport
- getConnectionOptions() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer
-
Deprecated.since 6.9
For backwards compatibility this method is retained for secondary initiator compatibility but will be removed at a future release.
- getConnectionOptions() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryServer
-
Return the remote server connection options.
- getConnectionState() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.CheckRemoteServerResult
-
Returns the connection state of the remote server.
- getConnectionTimeout() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the connection timeout value.
- getConnector() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.PrimaryInitiator
-
Returns the connector that the primary initiator will use to establish a connection between the secondary server and the primary server.
- getCredentialsFactory() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- getDataTypes() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- getDefaultPathPermissions() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.Role
-
Returns the set of default path permissions assigned to the role.
- getDescription() - Method in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
Description of the error reason, may be context-specific.
- getExpression() - Method in interface com.pushtechnology.diffusion.client.topics.TopicSelector
-
The expression associated with this selector.
- getExpressionPrefix() - Method in enum class com.pushtechnology.diffusion.client.topics.TopicSelector.Type
-
The expression prefix character used for this type.
- getFailureMessage() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.CheckRemoteServerResult
-
Returns a failure message when the state returned is
RemoteServers.CheckRemoteServerResult.ConnectionState.FAILED
orRemoteServers.CheckRemoteServerResult.ConnectionState.RETRYING
. - getFields() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Record
-
Returns an immutable, ordered list of field definitions.
- getGlobalPermissions() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.Role
-
Returns the set of global permissions assigned to the role.
- getGlobalPermissions() - Method in interface com.pushtechnology.diffusion.client.features.Security
-
Query the global permissions assigned to the calling session.
- getGroupByProperties() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.SessionMetricCollector
-
Returns the list of properties to group by.
- getHttpProxyAuth() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the proxy authenticator used to route a connection to the server via an HTTP proxy.
- getHttpProxyHost() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the proxy host name used to route a connection to the server via an HTTP proxy.
- getHttpProxyPort() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the proxy port used to route a connection to the server via an HTTP proxy.
- getIncludedRoles() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.Role
-
Returns a set of roles included within the role.
- getInitialRetryStrategy() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the initial retry strategy.
- getInputBufferSize() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the input buffer size for socket connection buffers and message receiving buffers.
- getInterval() - Method in class com.pushtechnology.diffusion.client.session.retry.RetryStrategy
-
Returns the time interval between attempts.
- getIsolatedPaths() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.SecurityConfiguration
-
Returns the set of isolated paths.
- getLabelNames() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricSample
-
Returns the list of label names for the metric sample.
- getLabelValues() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricSample
-
Returns the list of label values for the metric sample.
- getLine() - Method in interface com.pushtechnology.diffusion.client.types.ErrorReport
- getLocalSocketAddress() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the local socket address.
- getLockingPrincipal() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.Role
-
Returns an
Optional
, if the role is locked this will return the name of the principal that can update the role. - getLockingPrincipal() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.SystemPrincipal
-
Returns the name of the principal this principal is locked by.
- getMax() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Node
-
Returns maximum number of occurrences.
- getMaximumConversations() - Method in interface com.pushtechnology.diffusion.client.session.proxy.HTTPProxyAuthentication.ChallengeHandler
-
This method returns the maximum number of HTTP transactions permitted by the authentication method before authentication fails.
- getMaximumMessageSize() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the maximum message size that will be accepted by this session.
- getMaximumQueueSize() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the maximum size of the outbound message queue for the connection.
- getMessage() - Method in interface com.pushtechnology.diffusion.client.session.Session.SessionError
-
Returns a description of the error.
- getMessage() - Method in interface com.pushtechnology.diffusion.client.types.ErrorReport
- getMetrics(String) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricsResult
-
Returns the metrics for a server.
- getMin() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Node
-
Returns minimum number of occurrences.
- getMissingTopicNotificationFilter() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer
-
Deprecated.since 6.9
For backwards compatibility this method is retained for secondary initiator compatibility but will be removed at a future release.
- getMissingTopicNotificationFilter() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryServer
-
Return the missing topic notification filter expression.
- getName() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.Role
-
Returns the role name.
- getName() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.SystemPrincipal
-
Returns the system principal name.
- getName() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricAlert
-
The name of the metric alert.
- getName() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricCollector
-
Returns the name of the metric collector.
- getName() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricSample
-
Returns the name of the metric sample.
- getName() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricSampleCollection
-
Returns the name of the metric sample collection.
- getName() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer
-
Return the remote server name.
- getName() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.views.TopicView
-
The name of the topic view.
- getName() - Method in interface com.pushtechnology.diffusion.client.session.Session.SessionLock
- getName() - Method in interface com.pushtechnology.diffusion.datatype.DeltaType
-
Returns the external identifier for this delta type.
- getName() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Node
-
Returns the node name.
- getOutputBufferSize() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the output buffer size for socket connection buffers and message sending buffers.
- getPath() - Method in interface com.pushtechnology.diffusion.client.features.Messaging.RequestHandler.RequestContext
-
Returns the message path of the request.
- getPath() - Method in interface com.pushtechnology.diffusion.client.topics.TopicPathSelector
-
Return the associated topic path.
- getPathPermissions() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.Role
-
Returns a map of path to path permission assignments for the role.
- getPathPrefix() - Method in interface com.pushtechnology.diffusion.client.topics.TopicSelector
-
Get the topic path prefix from this selector pattern.
- getPermissionsForPath(String) - Method in interface com.pushtechnology.diffusion.client.features.Security
-
Query the path permissions assigned to the calling session on a given path.
- getPrimaryHostName() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryAcceptor
-
Returns the primary server host name used in SSL validation.
- getPrincipal() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricAlert
-
The principal associated with the metric alert.
- getPrincipal() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer
-
Deprecated.since 6.9
For backwards compatibility this method is retained for secondary initiator compatibility but will be removed at a future release.
- getPrincipal() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryServer
-
Return the principal used for the connection.
- getPrincipal() - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Returns the name of the security principal requested when opening the session.
- getPrincipals() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.SystemAuthenticationConfiguration
-
Returns the system principals stored on the server.
- getProperties() - Method in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Returns the topic properties.
- getProxyAuthenticationFactory() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- getReasonCode() - Method in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
A code that uniquely identifies this reason.
- getReconnectionStrategy() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the reconnection strategy.
- getReconnectionTimeout() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the reconnection timeout.
- getRecords() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.Schema
-
Returns an immutable, ordered list of record definitions.
- getRecoveryBufferSize() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the maximum number of sent messages that can be recovered on reconnection.
- getRegex() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.SessionPropertyValidation.MatchesSessionPropertyValidation
-
Returns the regular expression.
- getRemovedCount() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl.TopicRemovalResult
-
The integer returned represents the number of topics removed by the operation.
- getReports() - Method in exception com.pushtechnology.diffusion.client.features.ErrorReportsException
- getRequestedTransports() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the transports the session will use to connect to the server.
- getRequestPath() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the path used for any HTTP requests made by the session.
- getResponse(Map<String, String>) - Method in interface com.pushtechnology.diffusion.client.session.proxy.HTTPProxyAuthentication.ChallengeHandler
-
Called when a challenge from the proxy is received.
- getRetryDelay() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.PrimaryInitiator
-
Returns the interval in milliseconds between connection retries.
- getRoles() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.SecurityConfiguration
-
Returns a list of the roles defined including their permissions assignments and included roles.
- getRoles() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.views.TopicView
-
The roles used by the view when evaluating permissions.
- getRolesForAnonymousSessions() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.SecurityConfiguration
-
Returns the default set of roles to be assigned to anonymous sessions.
- getRolesForAnonymousSessions() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.SystemAuthenticationConfiguration
-
Returns the roles the system authentication handler will assign to anonymous sessions.
- getRolesForNamedSessions() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.SecurityConfiguration
-
Returns the default set of roles to be assigned to named sessions.
- getRoundTripTime() - Method in interface com.pushtechnology.diffusion.client.features.Pings.PingDetails
-
Round trip time in milliseconds from when the ping was sent to the time the response was received.
- getSamples() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricSampleCollection
-
Returns the list of metric samples in the collection.
- getScale() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Field
-
Returns the scale of a
decimal
field or 0 for other types. - getScope() - Method in interface com.pushtechnology.diffusion.client.session.Session.SessionLock
-
The scope of the lock.
- getSecurity() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl
-
Obtain the current contents of the security store.
- getSelector() - Method in interface com.pushtechnology.diffusion.client.topics.TopicSelection
-
Returns the topic selector for the selection or deselection.
- getSequence() - Method in interface com.pushtechnology.diffusion.client.session.Session.SessionLock
-
A value that identifies the acquisition of the lock with the given
name
. - getServerHost() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the host name or IP of the server the session will connect to.
- getServerNames() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricsResult
-
Returns a list of server names for which the result has metrics.
- getServerNames() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl.MissingTopicNotification
-
Returns a list of the names of the servers through which the notification has been routed.
- getServerPort() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the port of the server the session will connect to.
- getServerURL() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the URL used to create the session.
- getSession() - Method in interface com.pushtechnology.diffusion.client.session.Feature
-
This returns the session that the feature applies to.
- getSessionFactory() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- getSessionFilter() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.SessionMetricCollector
-
Returns the session filter.
- getSessionFilter() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SessionTrees.BranchMapping
-
Returns the session filter.
- getSessionId() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl.MissingTopicNotification
-
Returns the identity of the session that made the request.
- getSessionId() - Method in interface com.pushtechnology.diffusion.client.features.Messaging.RequestHandler.RequestContext
-
SessionId of the session that sent the request.
- getSessionId() - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Returns the unique identifier for the session as assigned by the (first) server it connects to.
- getSessionLock(String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Returns details of the session (if any) that holds a named session lock.
- getSessionLocks() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Returns details of all session locks currently held.
- getSessionProperties() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl.MissingTopicNotification
-
Returns the session properties of the session that made the request.
- getSessionProperties() - Method in interface com.pushtechnology.diffusion.client.features.Messaging.RequestHandler.RequestContext
-
Session properties of the session that sent the request.
- getSessionProperties() - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Returns the values of the session's fixed session properties.
- getSessionProperties(SessionId, Collection<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Query the server for property values of a specified client session.
- getSessionTreeBranch() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SessionTrees.BranchMappingTable
-
Returns the branch of the session tree to which this table is bound.
- getSpecification() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricAlert
-
The specification of the metric alert.
- getSpecification() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.views.TopicView
-
The specification of the topic view.
- getSslContext() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the SSL context for secure connections.
- getState() - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Returns the current state of the session.
- getSystemAuthentication() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl
-
Obtain the current contents of the store.
- getTimestamp() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricSample
-
Returns the timestamp for the metric sample.
- getTimestamp() - Method in interface com.pushtechnology.diffusion.client.features.Pings.PingDetails
-
Timestamp when the ping was sent.
- getTopicPath() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl.MissingTopicNotification
-
Returns the topic path derived from the requested topic selector.
- getTopicSelections(SessionId) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Returns a map of the current topic selection state for a specified session, keyed on topic selection scope.
- getTopicSelector() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.TopicMetricCollector
-
Returns the topic selector.
- getTopicSelector() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl.MissingTopicNotification
-
Returns the
TopicSelector
that triggered this notification. - getTopicSelectors() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- getTopicTreeBranch() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SessionTrees.BranchMapping
-
Returns the target branch in the topic tree for sessions matching the session filter.
- getTopicView(String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.views.TopicViews
-
Get a named Topic View.
- getTrustedClientProposedProperties() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.SystemAuthenticationConfiguration
-
Returns the map of trusted client proposed properties, where the key is the permitted property name and the value defines the validation applied to the property.
- getType() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricSampleCollection
-
Returns the type of the metric samples in the collection.
- getType() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer
-
Returns the remote server type.
- getType() - Method in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Returns the topic type.
- getType() - Method in interface com.pushtechnology.diffusion.client.topics.TopicSelection
-
Returns the selection type.
- getType() - Method in interface com.pushtechnology.diffusion.client.topics.TopicSelector
-
The type of this selector.
- getType() - Method in interface com.pushtechnology.diffusion.client.types.Credentials
-
Return the type of credentials.
- getType() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Field
-
Returns the field type.
- getTypeName() - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Returns the external type identifier.
- getUnit() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricSampleCollection
-
Returns the unit of measurement for the metric samples in the collection.
- getUrl() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer
-
Deprecated.since 6.9
For backwards compatibility this method is retained for secondary initiator compatibility but will be removed at a future release.
- getUrl() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryInitiator
-
Returns the url for connection to primary server.
- getUrls() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.PrimaryInitiator
-
Returns the urls for connection to secondary servers.
- getValue() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricSample
-
Returns the value of the metric sample.
- getValues() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.SessionPropertyValidation.ValuesSessionPropertyValidation
-
Returns the set of permitted values.
- getWriteTimeout() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Returns the write timeout value.
- GlobalPermission - Enum Class in com.pushtechnology.diffusion.client.types
-
Permissions that protect globally scoped, access-controlled operations.
- GLOBALS - Enum constant in enum class com.pushtechnology.diffusion.client.Diffusion
-
The implementation.
- groupByPathPrefixParts() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.TopicMetricCollector
-
Returns the number of leading parts of the topic path to group by.
- groupByPathPrefixParts(int) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.TopicMetricCollector.Builder
-
Specifies the number of leading parts of the topic path the metric collector should use to group results.
- groupByProperties(List<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.SessionMetricCollector.Builder
-
Specifies a list of session property names to group by, replacing any current list known to this builder.
- groupByProperty(String) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.SessionMetricCollector.Builder
-
Adds the name of a session property to group by to the list known to this builder.
- groupByTopicType(boolean) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.TopicMetricCollector.Builder
-
Specifies whether the metric collector should group by topic type.
- groupByTopicView(boolean) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.TopicMetricCollector.Builder
-
Specifies whether the metric collector should group by topic view.
- groupsByTopicType() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.TopicMetricCollector
-
Indicates whether the collector groups by topic type.
- groupsByTopicView() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.TopicMetricCollector
-
Indicates whether the collector groups by topic view.
- GT - Enum constant in enum class com.pushtechnology.diffusion.client.features.UpdateConstraint.Operator
-
Lenient greater than.
H
- HANDLER_CONFLICT - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
A conflicting registration exists.
- HandlerConflictException - Exception in com.pushtechnology.diffusion.client.features
-
Thrown to indicate a handler could not be registered because it conflicts with an existing handler.
- HandlerConflictException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.HandlerConflictException
-
Constructor.
- hasChanges() - Method in interface com.pushtechnology.diffusion.datatype.BinaryDelta
-
Returns whether the two values used to create this instance are different.
- hasChanges() - Method in interface com.pushtechnology.diffusion.datatype.json.JSONDelta
-
Returns whether the two JSON values used to create this instance are different.
- hashCode() - Method in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
- hashCode() - Method in class com.pushtechnology.diffusion.client.session.retry.RetryStrategy
- hashCode() - Method in interface com.pushtechnology.diffusion.client.session.SessionId
-
Returns hash code of session identifier.
- hasMore() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult
-
Indicates whether the fetch could have returned more results if it had not been constrained by the
first
,last
ormaximumResultSize
limits. - HISTOGRAM - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
-
Histograms measure distributions of discrete events.
- HTTP_POLLING - Enum constant in enum class com.pushtechnology.diffusion.client.session.SessionAttributes.Transport
-
HTTP long polling transport.
- httpProxy(String, int) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set the address of the HTTP Proxy that should be used to make connections to the server.
- httpProxy(String, int, HTTPProxyAuthentication) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
A variant of
SessionFactory.httpProxy(String, int)
that provides authentication details to the HTTP proxy. - HTTPProxyAuthentication - Interface in com.pushtechnology.diffusion.client.session.proxy
-
Interface that defines a proxy authentication scheme.
- HTTPProxyAuthentication.ChallengeHandler - Interface in com.pushtechnology.diffusion.client.session.proxy
-
Allows for an authentication implementation to be provided for connections routed via HTTP proxies.
I
- ignoreClientProposedProperty(String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Specifies the name of a client proposed session property that should now be ignored by the system authenticator.
- INACTIVE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.CheckRemoteServerResult.ConnectionState
-
The connection is inactive.
- INCOMPATIBLE_DATATYPE - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
A datatype operation has failed due to incompatibility.
- INCOMPATIBLE_STATE - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
A topic update could not be performed because the topic is managed by a component (for example, fan-out) which prohibits external updates.
- IncompatibleDatatypeException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report that an operation has failed because the receiver could not process the supplied data.
- IncompatibleDatatypeException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.IncompatibleDatatypeException
-
Constructor.
- IncompatibleExistingTopicException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.control.topics.TopicControl.IncompatibleExistingTopicException
- IncompatibleTopicException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report a topic is incompatible with an operation.
- IncompatibleTopicException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.control.topics.TopicControl.IncompatibleTopicException
- IncompatibleTopicException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.IncompatibleTopicException
-
Constructor.
- IncompatibleTopicStateException - Exception in com.pushtechnology.diffusion.client.features
-
An operation could not be performed because the topic is managed by a component (such as fan-out) that prohibits updates from the caller.
- IncompatibleTopicStateException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.IncompatibleTopicStateException
-
Constructor.
- INFO - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
-
Info metrics are used to expose textual information which SHOULD NOT change during process lifetime.
- initialRetryStrategy(RetryStrategy) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets the initial retry strategy.
- INPUT_BUFFER_SIZE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption
-
Specifies the input buffer size session attribute.
- inputBufferSize(int) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets the input buffer size for socket connection buffers and message receiving buffers.
- inserted() - Method in interface com.pushtechnology.diffusion.datatype.json.JSONDelta
-
Returns the parts of the second JSON value not found in the first JSON value.
- int64() - Method in interface com.pushtechnology.diffusion.datatype.DataTypes
-
Data type that supports 64-bit, signed integer values.
- INT64 - Enum constant in enum class com.pushtechnology.diffusion.client.topics.details.TopicType
-
Topic that stores and publishes 64-bit integer values.
- INT64_DATATYPE_NAME - Static variable in interface com.pushtechnology.diffusion.datatype.DataTypes
-
INT64 data type name.
- integer(String) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a single occurrence integer field to the current record.
- integer(String, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a fixed multiplicity integer field to the current record.
- integer(String, int, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add an integer field to the current record.
- INTEGER - Enum constant in enum class com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Field.Type
-
Integer.
- INTERNAL_ERROR - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
An internal error occurred.
- intersection(String) - Method in interface com.pushtechnology.diffusion.datatype.json.JSONDelta.ChangeMap
-
Returns a view of the portion of this map whose keys are descendants or parents of
pointer
. - INVALID_DATA - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
An operation failed because invalid data was received.
- INVALID_INBOUND_MESSAGE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
An inbound message with an invalid format was received.
- INVALID_PATH - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
An invalid path was supplied.
- InvalidBranchMappingException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.control.topics.SessionTrees.InvalidBranchMappingException
-
Constructor.
- InvalidDataException - Exception in com.pushtechnology.diffusion.datatype
-
Unchecked exception indicating that binary data could not be parsed as a value.
- InvalidDataException(Exception) - Constructor for exception com.pushtechnology.diffusion.datatype.InvalidDataException
-
Constructor.
- InvalidDataException(String) - Constructor for exception com.pushtechnology.diffusion.datatype.InvalidDataException
-
Constructor.
- InvalidFilterException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report a filter expression is invalid.
- InvalidFilterException(String, List<ErrorReport>) - Constructor for exception com.pushtechnology.diffusion.client.features.InvalidFilterException
-
Constructor.
- InvalidPatchException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.TopicUpdate.InvalidPatchException
-
Constructor.
- InvalidPatchException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.client.features.TopicUpdate.InvalidPatchException
-
Constructor.
- InvalidQueryException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.TimeSeries.InvalidQueryException
-
Constructor.
- InvalidTopicPathException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.control.topics.TopicControl.InvalidTopicPathException
- InvalidTopicSpecificationException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.control.topics.TopicControl.InvalidTopicSpecificationException
- InvalidUpdateStreamException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report an operation was performed with an invalid
update stream
. - InvalidUpdateStreamException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.InvalidUpdateStreamException
-
Constructor.
- InvalidUpdateStreamException(Throwable) - Constructor for exception com.pushtechnology.diffusion.client.features.InvalidUpdateStreamException
-
Constructor.
- IO_EXCEPTION - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
An unexpected IO Exception occurred.
- IS - Enum constant in enum class com.pushtechnology.diffusion.client.features.UpdateConstraint.Operator
-
Strict binary equality.
- isClosed() - Method in enum class com.pushtechnology.diffusion.client.session.Session.State
-
Returns true if a disconnected state.
- isComplete() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.QueryResult
-
Returns whether this result includes all events selected by the query.
- isConflated() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.MessageQueuePolicy
- isConnected() - Method in enum class com.pushtechnology.diffusion.client.session.Session.State
-
Returns true if a connected state.
- isEditEvent() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.Event
-
Return whether this is an edit event.
- isEmpty() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult
-
Returns
true
if the result contains zero elements. - isolatePath(String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Set a path not to inherit path permissions from its parent paths or the default path permissions.
- isOpenEvent() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event
-
Convenience method to determine whether the event notifies the opening of a new session.
- isOwned() - Method in interface com.pushtechnology.diffusion.client.session.Session.SessionLock
-
Test whether the session lock is still owned.
- isRecoverable() - Method in interface com.pushtechnology.diffusion.client.features.RecoverableUpdateStream
-
Check if recovery is possible following an exceptionally completed future returned from
RecoverableUpdateStream
. - isRecovering() - Method in enum class com.pushtechnology.diffusion.client.session.Session.State
-
Returns true if a recovering state.
- isTransportSecure() - Method in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
Indicates whether the session will use transport layer security to connect to Diffusion.
- isValueCheaper(V, D) - Method in interface com.pushtechnology.diffusion.datatype.DeltaType
-
Calculate if
value
is cheaper thandelta
. - isVariable() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Node
-
Returns true of the node has variable multiplicity.
i.e.
J
- json() - Method in interface com.pushtechnology.diffusion.datatype.DataTypes
-
JSON is "JavaScript Object Notation", a lightweight data-interchange format.
- JSON - Enum constant in enum class com.pushtechnology.diffusion.client.topics.details.TopicType
-
Topic that stores and publishes JSON (JavaScript Object Notation) values.
- JSON - Interface in com.pushtechnology.diffusion.datatype.json
-
Immutable JSON data value.
- JSON_DATATYPE_NAME - Static variable in interface com.pushtechnology.diffusion.datatype.DataTypes
-
JSON data type name.
- JSONDataType - Interface in com.pushtechnology.diffusion.datatype.json
-
JSON data type.
- JSONDelta - Interface in com.pushtechnology.diffusion.datatype.json
-
Structural delta type for
JSON
. - JSONDelta.ChangeMap - Interface in com.pushtechnology.diffusion.datatype.json
-
An unmodifiable map describing the changes to a JSON value.
- jsonValue() - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint.Factory
-
Create a constraint that partially matches the current topic value.
K
- key() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change
-
Returns the string key representation of the affected item in the form recordName(recordIndex).fieldName(fieldIndex) or just recordName(recordIndex) in the case of
RECORDS_ADDED
orRECORDS_REMOVED
.
L
- LANGUAGE - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for language code.
- last(int) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies a maximum number of topic results to be returned from the end of the required range.
- latestEdits() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery configured to perform an edit range query with the edit range that selects latest edits in the entire time series.
- LATITUDE - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for client latitude.
- LE - Enum constant in enum class com.pushtechnology.diffusion.client.features.UpdateConstraint.Operator
-
Lenient less than or equals.
- length() - Method in interface com.pushtechnology.diffusion.datatype.BinaryDelta
- length() - Method in interface com.pushtechnology.diffusion.datatype.Bytes
- limit(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery that returns at most count events.
- limitDeepBranches(int, int) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies a limit on the number of results returned for each deep branch.
- listener(Session.Listener) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Nominates a listener for session events from a session.
- listMetricAlerts() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics
-
List all metric alerts that have been created.
- listRemoteServers() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers
-
List all the remote servers that have been created.
- listSessionMetricCollectors() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics
-
Retrieves the current session metric collectors.
- listSessionTreeBranchesWithMappings() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SessionTrees
-
Retrieve the session tree branches of the server's branch mapping tables.
- listTopicMetricCollectors() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics
-
Retrieves the current topic metric collectors.
- listTopicViews() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.views.TopicViews
-
List all the topic views that have been created.
- localSocketAddress(SocketAddress) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set the optional local socket address, used prior to connection.
- lock(String) - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Attempt to acquire a
session lock
. - lock(String, Session.SessionLockScope) - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Variant of
Session.lock(String)
that provides control over when a lock will be released. - locked(Session.SessionLock) - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint.Factory
-
Create a constraint requiring a lock to be held by the session.
- LONGITUDE - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for client longitude.
- LOST_MESSAGES - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
Loss of messages from the client has been detected.
- LT - Enum constant in enum class com.pushtechnology.diffusion.client.features.UpdateConstraint.Operator
-
Lenient less than.
M
- MAXIMUM_MESSAGE_SIZE_MIN - Static variable in interface com.pushtechnology.diffusion.client.session.SessionAttributes
-
The minimum value that the maximum message size can be set to in bytes.
- MAXIMUM_QUEUE_SIZE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption
-
Specifies the maximum queue size session attribute.
- maximumGroups() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricCollector
-
Limit the number of groups maintained by this metric collector.
- maximumGroups(int) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.Builder
-
Set the maximum number of groups maintained by the metric collector.
- maximumMessageSize(int) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set the maximum message size.
- maximumQueueSize(int) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets the maximum size of the outbound message queue for the connection.
- maximumResultSize(int) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies the maximum data size of the result set.
- merge(TimeSeries.QueryResult<V>) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.QueryResult
-
Merge this result with
other
, combining original events and edit events, to produce anTimeSeries.QueryResult
of typeVALUE_EVENT_STREAM
- MESSAGE_QUEUE_LIMIT_REACHED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
The maximum outbound queue size was reached for the client.
- MESSAGE_TOO_LARGE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
The client sent a message that exceeded the maximum message size that can be processed by the server.
- MessageQueuePolicy - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Policy for managing a client message queue.
- Messaging - Interface in com.pushtechnology.diffusion.client.features
-
This feature provides a client session with request-response messaging capabilities that can be used to implement application services.
- Messaging.FilteredRequestCallback<R> - Interface in com.pushtechnology.diffusion.client.features
-
Callback interface for requests dispatched through a filter.
- Messaging.FilteredRequestCallback.Default<R> - Class in com.pushtechnology.diffusion.client.features
-
Default implementation of
Messaging.FilteredRequestCallback
. - Messaging.RequestHandler<T,
R> - Interface in com.pushtechnology.diffusion.client.features -
Interface which specifies a request handler to receive request notifications.
- Messaging.RequestHandler.RequestContext - Interface in com.pushtechnology.diffusion.client.features
-
Context of the request received.
- Messaging.RequestHandler.Responder<R> - Interface in com.pushtechnology.diffusion.client.features
-
Responder interface to dispatch responses to requests.
- Messaging.RequestStream<T,
R> - Interface in com.pushtechnology.diffusion.client.features -
Interface which specifies a request stream to receive request notifications.
- Messaging.RequestStream.Responder<R> - Interface in com.pushtechnology.diffusion.client.features
-
Responder interface to dispatch responses to requests.
- Metrics - Interface in com.pushtechnology.diffusion.client.features.control
-
This feature allows a client to configure metric collectors.
- Metrics.Builder<B extends Metrics.Builder<B>> - Interface in com.pushtechnology.diffusion.client.features.control
-
Common interface for metric collector builders.
- Metrics.MetricAlert - Interface in com.pushtechnology.diffusion.client.features.control
-
Description of a metric alert.
- Metrics.MetricCollector - Interface in com.pushtechnology.diffusion.client.features.control
-
The common base interface for metric collectors.
- Metrics.MetricSample - Interface in com.pushtechnology.diffusion.client.features.control
-
Represents a single metric sample.
- Metrics.MetricSampleCollection - Interface in com.pushtechnology.diffusion.client.features.control
-
Represents a collection of metric samples.
- Metrics.MetricsRequest - Interface in com.pushtechnology.diffusion.client.features.control
-
A parameterized query that can be used to fetch metrics from the server.
- Metrics.MetricsResult - Interface in com.pushtechnology.diffusion.client.features.control
-
The result of a fetch metrics operation, initiated by a
Metrics.MetricsRequest
. - Metrics.MetricType - Enum Class in com.pushtechnology.diffusion.client.features.control
-
Enumeration defining the metric types available.
- Metrics.SessionMetricCollector - Interface in com.pushtechnology.diffusion.client.features.control
-
The definition of a session metric collector.
- Metrics.SessionMetricCollector.Builder - Interface in com.pushtechnology.diffusion.client.features.control
-
A session metric collector builder.
- Metrics.TopicMetricCollector - Interface in com.pushtechnology.diffusion.client.features.control
-
The definition of a topic metric collector.
- Metrics.TopicMetricCollector.Builder - Interface in com.pushtechnology.diffusion.client.features.control
-
A topic metric collector builder.
- metricsRequest() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics
-
Creates an unconfigured
Metrics.MetricsRequest
. - MISSING - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.CheckRemoteServerResult.ConnectionState
-
The named remote server did not exist.
- missingTopicNotificationFilter(String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Builder
-
Deprecated.Specifies a topic selector expression which will filter missing topic notifications propagated from secondary to primary server.
- missingTopicNotificationFilter(String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryServer.SecondaryBuilder
-
Specifies a topic selector expression which will filter missing topic notifications propagated from secondary to primary server.
- MODIFY_SECURITY - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
Change the security configuration.
- MODIFY_SESSION - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
Alter a client session.
- MODIFY_TOPIC - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Add a topic or remove a topic.
- MODIFY_TOPIC_VIEWS - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
Modify topic views.
- MQTT_CLIENT_ID - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for MQTT client identifier.
- MutableRecordModel - Interface in com.pushtechnology.diffusion.datatype.recordv2.model
N
- NE - Enum constant in enum class com.pushtechnology.diffusion.client.features.UpdateConstraint.Operator
-
Lenient not equals.
- newBranchMappingTableBuilder() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- newBranchMappingTableBuilder() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Create a new
SessionTrees.BranchMappingTable.Builder
. - newRemoteServerBuilder() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- newRemoteServerBuilder() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Deprecated.since 6.9
This method may only be used to create an old style builder for secondary initiators. The newer
Diffusion.newRemoteServerBuilder(Class)
specifying the secondary initiator builder class should be used in preference. This method will be removed in a future release. - newRemoteServerBuilder(Class<B>) - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- newRemoteServerBuilder(Class<B>) - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Create a new
RemoteServers.RemoteServer.RemoteServerBuilder
. - newSessionEventParametersBuilder() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- newSessionEventParametersBuilder() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Create a new
ClientControl.SessionEventParameters.Builder
. - newSessionMetricCollectorBuilder() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- newSessionMetricCollectorBuilder() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Create a new
Metrics.SessionMetricCollector.Builder
. - newTopicMetricCollectorBuilder() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- newTopicMetricCollectorBuilder() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Create a new
Metrics.TopicMetricCollector.Builder
. - newTopicSpecification(TopicType) - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- newTopicSpecification(TopicType) - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Create a new
TopicSpecification
for a given topic type. - newUpdateStreamBuilder() - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Creates an update stream builder to use for creating update streams.
- next(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to select a range of events following the anchor.
- next(Duration) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to select a temporal range of events following the anchor.
- nextMillis(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to select a temporal range of events following the anchor.
- NO_RETRY - Static variable in class com.pushtechnology.diffusion.client.session.retry.RetryStrategy
-
The retry strategy that indicates that no retry is to be attempted.
- NO_SUCH_SESSION - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
The session does not exist on the server.
- noChange() - Method in interface com.pushtechnology.diffusion.datatype.DeltaType
-
Constant returned by
DeltaType.diff(Object, Object)
to indicateoldValue
andnewValue
are equivalent. - noCredentials() - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set credentials to
Credentials.Type.NONE
. - noCredentials() - Method in interface com.pushtechnology.diffusion.client.types.Credentials.Factory
-
Create a
Credentials
of typeNONE
. - NONE - Enum constant in enum class com.pushtechnology.diffusion.client.types.Credentials.Type
-
No credentials are supplied.
- noReconnection() - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Disable reconnection.
- NoSuchEventException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.TimeSeries.NoSuchEventException
-
Constructor.
- NoSuchSessionException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report there is no session for a given session ID.
- NoSuchSessionException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.NoSuchSessionException
-
Constructor.
- NoSuchTopicException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report there is no topic bound to a topic path.
- NoSuchTopicException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.NoSuchTopicException
-
Constructor.
- noTopic() - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint.Factory
-
Create a constraint requiring the path to have no topic.
- noValue() - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint.Factory
-
Create a constraint requiring the topic to have no value.
- numberSelected() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl.SubscriptionByFilterResult
O
- onClose() - Method in class com.pushtechnology.diffusion.client.callbacks.Stream.Default
- onClose() - Method in interface com.pushtechnology.diffusion.client.callbacks.Stream
-
Notification that a stream context was closed normally.
- onDescendantNotification(String, TopicNotifications.TopicNotificationListener.NotificationType) - Method in class com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener.Default
- onDescendantNotification(String, TopicNotifications.TopicNotificationListener.NotificationType) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener
-
Notification for an immediate descendant of a selected topic path.
- onError(ErrorReason) - Method in class com.pushtechnology.diffusion.client.callbacks.Callback.Default
- onError(ErrorReason) - Method in interface com.pushtechnology.diffusion.client.callbacks.Callback
-
Notification of a contextual error related to this callback.
- onError(Session, Session.SessionError) - Method in class com.pushtechnology.diffusion.client.session.Session.ErrorHandler.Default
- onError(Session, Session.SessionError) - Method in interface com.pushtechnology.diffusion.client.session.Session.ErrorHandler
-
Called when an error has occurred.
- onLowerThresholdCrossed(SessionId, MessageQueuePolicy) - Method in class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.QueueEventStream.Default
- onLowerThresholdCrossed(SessionId, MessageQueuePolicy) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.QueueEventStream
-
The configured lower threshold for a client's queue has been reached.
- onMissingTopic(TopicControl.MissingTopicNotification) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl.MissingTopicNotificationStream
-
Called when a session requests a topic that does not exist, and the topic path belongs to part of the topic tree for which this handler was registered.
- onRequest(String, T, Messaging.RequestStream.Responder<R>) - Method in interface com.pushtechnology.diffusion.client.features.Messaging.RequestStream
-
Called to indicate a request has been received.
- onRequest(T, Messaging.RequestHandler.RequestContext, Messaging.RequestHandler.Responder<R>) - Method in interface com.pushtechnology.diffusion.client.features.Messaging.RequestHandler
-
Called to indicate a request has been received.
- onResponse(SessionId, R) - Method in class com.pushtechnology.diffusion.client.features.Messaging.FilteredRequestCallback.Default
- onResponse(SessionId, R) - Method in interface com.pushtechnology.diffusion.client.features.Messaging.FilteredRequestCallback
-
Called when a response has been received.
- onResponseError(SessionId, Throwable) - Method in class com.pushtechnology.diffusion.client.features.Messaging.FilteredRequestCallback.Default
- onResponseError(SessionId, Throwable) - Method in interface com.pushtechnology.diffusion.client.features.Messaging.FilteredRequestCallback
-
Called when a response from a session results in an error.
- onSessionClose(SessionId, Map<String, String>, ClientControl.CloseReason) - Method in class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.Default
-
Deprecated.
- onSessionClose(SessionId, Map<String, String>, ClientControl.CloseReason) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream
-
Deprecated.Notification that a client session has closed.
- onSessionEvent(ClientControl.SessionEventStream.Event) - Method in class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Default
- onSessionEvent(ClientControl.SessionEventStream.Event) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream
-
Notification of a session event.
- onSessionEvent(SessionId, ClientControl.SessionPropertiesStream.EventType, Map<String, String>, Map<String, String>) - Method in class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.Default
-
Deprecated.
- onSessionEvent(SessionId, ClientControl.SessionPropertiesStream.EventType, Map<String, String>, Map<String, String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream
-
Deprecated.Notification of a session event that can result in a change of properties.
- onSessionOpen(SessionId, Map<String, String>) - Method in class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.Default
-
Deprecated.
- onSessionOpen(SessionId, Map<String, String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream
-
Deprecated.Notification that a new client session has been opened.
- onSessionStateChanged(Session, Session.State, Session.State) - Method in class com.pushtechnology.diffusion.client.session.Session.Listener.Default
- onSessionStateChanged(Session, Session.State, Session.State) - Method in interface com.pushtechnology.diffusion.client.session.Session.Listener
-
Called whenever the state of a session changes.
- onSubscription(String, TopicSpecification) - Method in class com.pushtechnology.diffusion.client.features.Topics.SubscriberStream.Default
- onSubscription(String, TopicSpecification) - Method in interface com.pushtechnology.diffusion.client.features.Topics.SubscriberStream
-
Subscription notification.
- onTopicNotification(String, TopicSpecification, TopicNotifications.TopicNotificationListener.NotificationType) - Method in class com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener.Default
- onTopicNotification(String, TopicSpecification, TopicNotifications.TopicNotificationListener.NotificationType) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener
-
A notification for a selected topic.
- onUnsubscription(String, TopicSpecification, Topics.UnsubscribeReason) - Method in class com.pushtechnology.diffusion.client.features.Topics.SubscriberStream.Default
- onUnsubscription(String, TopicSpecification, Topics.UnsubscribeReason) - Method in interface com.pushtechnology.diffusion.client.features.Topics.SubscriberStream
-
Unsubscription notification.
- onUpperThresholdCrossed(SessionId, MessageQueuePolicy) - Method in class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.QueueEventStream.Default
- onUpperThresholdCrossed(SessionId, MessageQueuePolicy) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.QueueEventStream
-
The configured upper threshold for a client's queue has been reached.
- onValue(String, TopicSpecification, V, V) - Method in class com.pushtechnology.diffusion.client.features.Topics.ValueStream.Default
- onValue(String, TopicSpecification, V, V) - Method in interface com.pushtechnology.diffusion.client.features.Topics.ValueStream
-
Notifies an update to a topic value from the server.
- open() - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Open a connection to a server and request a new session.
- open(String) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Open a connection to a server and request a new client session.
- openAsync() - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Open a connection to a server and request a new session.
- openAsync(String) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Open a connection to a server and request a new session.
- or(UpdateConstraint) - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint
-
Returns a composed constraint that represents a logical OR of this constraint and another.
- originalEvent() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.Event
-
If this is an edit event, returns the metadata of the original event that this event replaces; otherwise returns this event.
- OUTPUT_BUFFER_SIZE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption
-
Specifies the output buffer size session attribute.
- outputBufferSize(int) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets the output buffer size for socket connection buffers and message sending buffers.
- OWNER - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that allows the creator of a topic to extend READ_TOPIC, MODIFY_TOPIC, and UPDATE_TOPIC permissions to a specific principal, in addition to the permissions granted by the authorisation rules in the security store.
P
- parse(String) - Method in interface com.pushtechnology.diffusion.client.topics.TopicSelectors
-
Parse an expression to create a selector.
- parseSchema(String) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2DataType
-
Parse a schema from a JSON string.
- password(String) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set credentials of type
Credentials.Type.PLAIN_PASSWORD
. - password(String) - Method in interface com.pushtechnology.diffusion.client.types.Credentials.Factory
-
Create a
Credentials
of typePLAIN_PASSWORD
. - path() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult.TopicResult
-
Returns the topic path.
- PATH - Enum constant in enum class com.pushtechnology.diffusion.client.topics.TopicSelector.Type
-
The selector is a simple topic path.
- PATH_PREFIX - Static variable in interface com.pushtechnology.diffusion.client.topics.TopicSelector
-
Prefix used for
PATH
expressions. - PathPermission - Enum Class in com.pushtechnology.diffusion.client.types
-
Permissions protecting access-controlled operations that are evaluated for a specific path.
- performReconnection(ReconnectionStrategy.ReconnectionAttempt) - Method in interface com.pushtechnology.diffusion.client.session.reconnect.ReconnectionStrategy
-
This method is called before each reconnection attempt.
- Permission - Interface in com.pushtechnology.diffusion.client.types
-
A permission protects an access-controlled operation.
- PermissionsException - Exception in com.pushtechnology.diffusion.client.session
-
The session operation failed due to a permissions failure.
- PermissionsException() - Constructor for exception com.pushtechnology.diffusion.client.session.PermissionsException
-
Constructor.
- PermissionsException(String) - Constructor for exception com.pushtechnology.diffusion.client.session.PermissionsException
- PermissionsException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.client.session.PermissionsException
- PERSISTENT - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that can be used to prevent a topic from being persisted when the server is configured to enable persistence.
- Pings - Interface in com.pushtechnology.diffusion.client.features
-
This feature provides a client session with the ability to test its connection to the server.
- Pings.PingDetails - Interface in com.pushtechnology.diffusion.client.features
-
Server response to a ping.
- pingServer() - Method in interface com.pushtechnology.diffusion.client.features.Pings
-
Send a ping request to the server.
- PLAIN_PASSWORD - Enum constant in enum class com.pushtechnology.diffusion.client.types.Credentials.Type
-
A plain-text password, encoded with UTF-8.
- previous(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to select a range of events preceding the anchor.
- previous(Duration) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to select a temporal range of events preceding the anchor.
- previousMillis(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to select a temporal range of events preceding the anchor.
- PRIMARY_INITIATOR - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Type
-
Primary initiator.
- principal(String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Builder
-
Deprecated.Specifies the name of a principal used by the remote server to connect to the primary server.
- principal(String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.SecondaryServer.SecondaryBuilder
-
Specifies the name of a principal to use to use for the connection.
- principal(String) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets the security principal.
- PRINCIPAL - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for principal.
- PRIORITY - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies the topic delivery priority.
- properties() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventParameters
-
Returns the requested properties.
- properties() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event
-
Provides the session's properties.
- properties(String...) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventParameters.Builder
-
Specifies the session property keys of all session properties to be returned with events.
- properties(Map<String, String>) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets user-defined session property values.
- PROPERTIES - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.Type
-
The event indicates a change to the session properties of the identified session.
- property(String, String) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets a user-defined session property value.
- proxyAuthentication() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Returns a proxy authentication scheme factory.
- ProxyAuthenticationFactory - Interface in com.pushtechnology.diffusion.client.session.proxy
-
Factory for
proxy authentication
instances. - PUBLISH_VALUES_ONLY - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies whether a topic should publish only values.
- putBranchMappingTable(SessionTrees.BranchMappingTable) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SessionTrees
-
Create or replace a branch mapping table.
- putSessionMetricCollector(Metrics.SessionMetricCollector) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics
-
Add a session metric collector, replacing any with the same name.
- putTopicMetricCollector(Metrics.TopicMetricCollector) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics
-
Add a topic metric collector, replacing any with the same name.
Q
- QUERY_OBSOLETE_TIME_SERIES_EVENTS - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Evaluate queries that return a non-current view of a time series topic.
R
- rangeQuery() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries
-
Return a default range query that performs a value range query of an entire time series.
- READ_TOPIC - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Required to receive information from a topic.
- READ_TOPIC_VIEWS - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
Read topic views.
- readAs(Class<T>, byte[]) - Method in interface com.pushtechnology.diffusion.datatype.binary.BinaryDataType
-
Create a value of a compatible class from binary.
- readAs(Class<T>, byte[]) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Create a value of a compatible class from binary.
- readAs(Class<T>, byte[], int, int) - Method in interface com.pushtechnology.diffusion.datatype.binary.BinaryDataType
-
Create a value of a compatible class from a binary.
- readAs(Class<T>, byte[], int, int) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Create a value of a compatible class from a binary.
- readAs(Class<T>, Bytes) - Method in interface com.pushtechnology.diffusion.datatype.binary.BinaryDataType
-
Create a value of a compatible class from binary.
- readAs(Class<T>, Bytes) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Create a value of a compatible class from binary.
- readDelta(byte[]) - Method in interface com.pushtechnology.diffusion.datatype.DeltaType
-
Create a delta from binary.
- readDelta(byte[], int, int) - Method in interface com.pushtechnology.diffusion.datatype.DeltaType
-
Create a delta from binary.
- readDelta(Bytes) - Method in interface com.pushtechnology.diffusion.datatype.DeltaType
-
Create a delta from binary.
- readValue(byte[]) - Method in interface com.pushtechnology.diffusion.datatype.binary.BinaryDataType
-
Create a value from binary.
- readValue(byte[]) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Create a value from binary.
- readValue(byte[]) - Method in interface com.pushtechnology.diffusion.datatype.json.JSONDataType
-
Parse a value from CBOR-format binary.
- readValue(byte[]) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2DataType
-
Parse a value from a
RecordV2
format byte array. - readValue(byte[], int, int) - Method in interface com.pushtechnology.diffusion.datatype.binary.BinaryDataType
-
Create a value from binary.
- readValue(byte[], int, int) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Create a value from binary.
- readValue(byte[], int, int) - Method in interface com.pushtechnology.diffusion.datatype.json.JSONDataType
-
Parse a value from CBOR-format binary.
- readValue(byte[], int, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2DataType
-
Parse a value from a
RecordV2
format byte array. - readValue(Bytes) - Method in interface com.pushtechnology.diffusion.datatype.binary.BinaryDataType
-
Create a value from binary.
- readValue(Bytes) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Create a value from binary.
- readValue(Bytes) - Method in interface com.pushtechnology.diffusion.datatype.json.JSONDataType
-
Parse a value from CBOR-format binary.
- reauthenticate(String, Credentials, Map<String, String>) - Method in interface com.pushtechnology.diffusion.client.features.Security
-
Re-authenticate the session.
- RECONNECTED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.State
-
The session has reconnected to the same server after a disconnection.
- RECONNECTED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.EventType
-
Deprecated.Session has reconnected.
- RECONNECTION_TIMEOUT - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption
-
Specifies the reconnection timeout session attribute.
- reconnectionStrategy(ReconnectionStrategy) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets the reconnection strategy.
- ReconnectionStrategy - Interface in com.pushtechnology.diffusion.client.session.reconnect
-
Interface that defines a reconnection strategy.
- ReconnectionStrategy.ReconnectionAttempt - Interface in com.pushtechnology.diffusion.client.session.reconnect
-
A single reconnection attempt that can either be started or aborted.
- reconnectionTimeout(int) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets the reconnection timeout.
- record(String) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a new single occurrence record to the schema.
- record(String, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a new fixed multiplicity record to the schema.
- record(String, int, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a new record to the schema.
- RECORD_V2 - Enum constant in enum class com.pushtechnology.diffusion.client.topics.details.TopicType
-
Topic that stores and publishes data in the form of records and fields.
- RECORD_V2_DATATYPE_NAME - Static variable in interface com.pushtechnology.diffusion.datatype.DataTypes
-
RecordV2 data type name.
- recordCount(String) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.RecordModel
-
Returns the actual number of occurrences of a named record.
- recordIndex() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change
-
Returns the index of the affected record.
- RecordModel - Interface in com.pushtechnology.diffusion.datatype.recordv2.model
-
RecordV2
data model. - recordName() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change
-
Returns the name of the affected record.
- RECORDS_ADDED - Enum constant in enum class com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change.Type
-
The change indicates that one or more records have been added.
- RECORDS_REMOVED - Enum constant in enum class com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change.Type
-
The change indicates that one or more records have been removed.
- recordV2() - Method in interface com.pushtechnology.diffusion.datatype.DataTypes
-
Data type that supports data in the form of records and fields.
- RecordV2 - Interface in com.pushtechnology.diffusion.datatype.recordv2
-
An immutable value representing a list of records.
- RecordV2Builder - Interface in com.pushtechnology.diffusion.datatype.recordv2
-
Builds free format
RecordV2 value
. - RecordV2DataType - Interface in com.pushtechnology.diffusion.datatype.recordv2
-
Record-based data type.
- RecordV2Delta - Interface in com.pushtechnology.diffusion.datatype.recordv2
-
RecordV2
structural delta. - RecordV2Delta.Change - Interface in com.pushtechnology.diffusion.datatype.recordv2
-
Represents a single change between one record value and another.
- RecordV2Delta.Change.Type - Enum Class in com.pushtechnology.diffusion.datatype.recordv2
-
Indicates the type of change.
- recover() - Method in interface com.pushtechnology.diffusion.client.features.RecoverableUpdateStream
-
Reestablish the inner recovery stream.
- RecoverableUpdateStream<T> - Interface in com.pushtechnology.diffusion.client.features
-
An extension to
UpdateStream
that includes recovery functionality. - RECOVERING_RECONNECT - Enum constant in enum class com.pushtechnology.diffusion.client.session.Session.State
-
Connection with a server has been lost and the session is attempting reconnection.
- RECOVERY_BUFFER_SIZE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption
-
Specifies the recovery buffer size session attribute.
- recoveryBufferSize(int) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set the recovery buffer size.
- REGISTER_HANDLER - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
Required to register any server-side handler.
- Registration - Interface in com.pushtechnology.diffusion.client.callbacks
-
A reference to a registered handler.
- reject(String) - Method in interface com.pushtechnology.diffusion.client.features.Messaging.RequestHandler.Responder
-
Reject a request.
- reject(String) - Method in interface com.pushtechnology.diffusion.client.features.Messaging.RequestStream.Responder
-
Reject a request.
- RejectedRequestException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report that a recipient session has rejected a request.
- RejectedRequestException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.RejectedRequestException
-
Constructor.
- RemoteServerExistsException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServerExistsException
-
Constructor.
- RemoteServerOptionsException(String, List<ErrorReport>) - Constructor for exception com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServerOptionsException
-
Constructor.
- RemoteServers - Interface in com.pushtechnology.diffusion.client.features.control
-
This feature allows a client session to manage remote servers.
- RemoteServers.CheckRemoteServerResult - Interface in com.pushtechnology.diffusion.client.features.control
-
Result returned from a
RemoteServers.checkRemoteServer(java.lang.String)
invocation. - RemoteServers.CheckRemoteServerResult.ConnectionState - Enum Class in com.pushtechnology.diffusion.client.features.control
-
Represents the current connection state of the remote server.
- RemoteServers.PrimaryInitiator - Interface in com.pushtechnology.diffusion.client.features.control
-
A primary initiator.
- RemoteServers.PrimaryInitiator.PrimaryInitiatorBuilder - Interface in com.pushtechnology.diffusion.client.features.control
-
Builder for a
RemoteServers.PrimaryInitiator
. - RemoteServers.RemoteServer - Interface in com.pushtechnology.diffusion.client.features.control
-
Base interface for a remote server definition.
- RemoteServers.RemoteServer.Builder - Interface in com.pushtechnology.diffusion.client.features.control
-
Deprecated.since 6.9
This builder is retained for backwards compatibility only. It can only be used to create a secondary initiator.
RemoteServers.SecondaryInitiator.SecondaryInitiatorBuilder
should be used in preference. This builder will be removed in a future release. - RemoteServers.RemoteServer.ConnectionOption - Enum Class in com.pushtechnology.diffusion.client.features.control
-
Connection options for use with
RemoteServers.SecondaryServer
s. - RemoteServers.RemoteServer.RemoteServerBuilder<B> - Interface in com.pushtechnology.diffusion.client.features.control
-
The base interface for all remote server builders.
- RemoteServers.RemoteServer.Type - Enum Class in com.pushtechnology.diffusion.client.features.control
-
The remote server type.
- RemoteServers.RemoteServerExistsException - Exception in com.pushtechnology.diffusion.client.features.control
-
Exception thrown when an attempt has been made to create a remote server when one with the same name is already defined.
- RemoteServers.RemoteServerOptionsException - Exception in com.pushtechnology.diffusion.client.features.control
-
Exception thrown when one or more of the options specified when creating a remote server have been found to be invalid.
- RemoteServers.SecondaryAcceptor - Interface in com.pushtechnology.diffusion.client.features.control
-
Secondary remote server that accepts a connection from a primary server.
- RemoteServers.SecondaryAcceptor.SecondaryAcceptorBuilder - Interface in com.pushtechnology.diffusion.client.features.control
-
Builder for a
RemoteServers.SecondaryAcceptor
. - RemoteServers.SecondaryInitiator - Interface in com.pushtechnology.diffusion.client.features.control
-
Secondary remote server that initiates a connection to a primary server.
- RemoteServers.SecondaryInitiator.SecondaryInitiatorBuilder - Interface in com.pushtechnology.diffusion.client.features.control
-
Builder for an
SecondaryInitiator
. - RemoteServers.SecondaryServer - Interface in com.pushtechnology.diffusion.client.features.control
-
Base interface for a secondary remote server.
- RemoteServers.SecondaryServer.SecondaryBuilder<B> - Interface in com.pushtechnology.diffusion.client.features.control
-
Base builder interface for
RemoteServers.SecondaryServer
. - REMOVAL - Enum constant in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
The unsubscription occurred because the topic was removed.
- REMOVAL - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies a removal policy for automatic removal of the topic (and/or other topics).
- removed() - Method in interface com.pushtechnology.diffusion.datatype.json.JSONDelta
-
Returns the parts of the first JSON value not found in the second JSON value.
- REMOVED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener.NotificationType
-
The topic has been removed.
- removeField(String, int, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.MutableRecordModel
-
Removes the specified occurrence of a variable multiplicity field.
- removeListener(Session.Listener) - Method in interface com.pushtechnology.diffusion.client.session.Session
-
Remove a session listener.
- removeMetricAlert(String) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics
-
Remove a named metric alert if it exists.
- removeMetricsWithNoMatches(boolean) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.SessionMetricCollector.Builder
-
Specifies whether the metric collector should remove any metrics that have no matches.
- removePathPermissions(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Removes any path permissions previously assigned to a particular path for a given role.
- removePrincipal(String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Remove a principal.
- removeRecord(int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.MutableRecordModel
-
Removes the specified occurrence of a variable multiplicity record.
- removeRemoteServer(String) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers
-
Remove a named remote server if it exists.
- removeRequestStream(String) - Method in interface com.pushtechnology.diffusion.client.features.Messaging
-
Remove the request stream at a particular path.
- removeSessionMetricCollector(String) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics
-
Removes any session metric collector with the given name, if it exists.
- removesMetricsWithNoMatches() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.SessionMetricCollector
-
Indicates whether metrics with no matches should be removed.
- removeStream(Stream) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Remove a stream.
- removeTopicMetricCollector(String) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics
-
Removes any topic metric collector with the given name, if it exists.
- removeTopics(TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl
-
Send a request to remove one or more topics.
- removeTopics(String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicControl
-
Send a request to remove one or more topics.
- removeTopicView(String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.views.TopicViews
-
Remove a named topic view if it exists.
- REQUEST_TIME_OUT - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
Communication with the server failed because a service request timed out.
- REQUESTED - Enum constant in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
Unsubscribed by the subscribing session.
- requestPath(String) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set the path used for HTTP requests.
- reset() - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.Builder
-
Reset the builder.
- reset() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Builder
-
Deprecated.Reset the builder.
- reset() - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.RemoteServerBuilder
-
Reset the builder to its default values.
- reset() - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SessionTrees.BranchMappingTable.Builder
-
Reset the builder.
- reset() - Method in interface com.pushtechnology.diffusion.client.features.UpdateStream.Builder
-
Resets the builder to its default parameters.
- respond(R) - Method in interface com.pushtechnology.diffusion.client.features.Messaging.RequestHandler.Responder
-
Dispatch a response to a request.
- respond(R) - Method in interface com.pushtechnology.diffusion.client.features.Messaging.RequestStream.Responder
-
Dispatch a response to a request.
- results() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult
-
Returns the results from the fetch operation.
- RETRY_DELAY - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption
-
Specifies the delay after losing a connection before attempting a reconnection.
- retryDelay(int) - Method in interface com.pushtechnology.diffusion.client.features.control.RemoteServers.PrimaryInitiator.PrimaryInitiatorBuilder
-
Specifies the delay after losing a connection before attempting a reconnection.
- RETRYING - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.CheckRemoteServerResult.ConnectionState
-
The connection has failed but is retrying.
- RetryStrategy - Class in com.pushtechnology.diffusion.client.session.retry
-
Defines a retry strategy.
- RetryStrategy(long) - Constructor for class com.pushtechnology.diffusion.client.session.retry.RetryStrategy
-
Creates a new retry strategy that will retry indefinitely at the specified interval.
- RetryStrategy(long, int) - Constructor for class com.pushtechnology.diffusion.client.session.retry.RetryStrategy
-
Creates a new retry strategy object.
- revokeAuthentication(SessionId) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.AuthenticationControl
-
Revokes a session's authentication.
- REVOKED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
The session's authentication was revoked by a privileged user.
- ROLES - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for session roles.
- rolesToString(Set<String>) - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
-
Formats set of roles into a string.
- rolesToString(Set<String>) - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Utility method which converts a set of authorisation roles to the string format required by the
$Roles
session property.
S
- Schema - Interface in com.pushtechnology.diffusion.datatype.recordv2.schema
-
RecordV2
schema. - SCHEMA - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies a schema which constrains topic values.
- Schema.Field - Interface in com.pushtechnology.diffusion.datatype.recordv2.schema
-
Field Definition.
- Schema.Field.Type - Enum Class in com.pushtechnology.diffusion.datatype.recordv2.schema
-
Field Type.
- Schema.Node - Interface in com.pushtechnology.diffusion.datatype.recordv2.schema
-
Schema Node - A
Schema.Record
or aSchema.Field
. - Schema.Record - Interface in com.pushtechnology.diffusion.datatype.recordv2.schema
-
Record Definition.
- schemaBuilder() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2DataType
-
Creates a new schema builder.
- SchemaBuilder - Interface in com.pushtechnology.diffusion.datatype.recordv2.schema
-
Used to build an immutable
Schema
. - SchemaParseException - Exception in com.pushtechnology.diffusion.datatype.recordv2.schema
-
Indicates a problem that has occurred when parsing a
Schema
. - SchemaParseException(String) - Constructor for exception com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaParseException
-
Constructor.
- SchemaParseException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaParseException
-
Constructor.
- SchemaViolationException - Exception in com.pushtechnology.diffusion.datatype.recordv2.schema
-
Indicates a problem that has occurred when building a
Schema
. - SchemaViolationException(String) - Constructor for exception com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaViolationException
-
Constructor.
- SchemaViolationException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaViolationException
-
Constructor.
- script() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Create a script.
- script() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Create a script.
- scriptBuilder() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl
-
Returns a builder that can be used to create scripts for use with
updateStore
. - scriptBuilder() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl
-
Returns a builder that can be used to create scripts for use with
updateStore
. - ScriptException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report problems evaluating a script.
- ScriptException(String, List<ErrorReport>) - Constructor for exception com.pushtechnology.diffusion.client.features.ScriptException
-
Constructor.
- SECONDARY_ACCEPTOR - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Type
-
Secondary acceptor remote server.
- SECONDARY_INITIATOR - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Type
-
Secondary initiator remote server.
- secureTransport(boolean) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set if a secure transport should be used.
- Security - Interface in com.pushtechnology.diffusion.client.features
-
This feature provides a client session with the ability to re-authenticate the session, as well as to query permissions assigned to it.
- SecurityControl - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
This feature allows a client session to query and update the security store.
- SecurityControl.Role - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Encapsulates the defined details for an individual role.
- SecurityControl.ScriptBuilder - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
A script builder may be used to create a script of commands to apply to the security store at the server.
- SecurityControl.SecurityConfiguration - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Snapshot of information from the security store.
- SecurityStoreFeature - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
The super interface for features that update security stores.
- select(TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.NotificationRegistration
-
Request to receive notifications for all topics matched by the provided topic selector.
- select(String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.NotificationRegistration
-
Request to receive notifications for all topics matched by the provided selector.
- SELECT - Enum constant in enum class com.pushtechnology.diffusion.client.topics.TopicSelection.Type
-
Represents selection of topics (i.e.
- SELECT_TOPIC - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Use a topic selector that selects a topic path.
- selected() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionFilterOperationResult
- SELECTED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener.NotificationType
-
The topic existed at the time of the selector registration.
- selectedCount() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.QueryResult
-
Returns the number of events selected by the query.
- selectFrom(String) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.Query
-
Evaluate this query for a time series topic.
- SELECTOR_SET - Enum constant in enum class com.pushtechnology.diffusion.client.topics.TopicSelector.Type
-
The selector is a composite of other selectors.
- SELECTOR_SET_PREFIX - Static variable in interface com.pushtechnology.diffusion.client.topics.TopicSelector
-
Prefix used for
SET
expressions. - selects(String) - Method in interface com.pushtechnology.diffusion.client.topics.TopicSelector
-
Evaluate this selector against a topic path.
- SEND_TO_MESSAGE_HANDLER - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Send a message to a handler registered with the server for a particular message path.
- SEND_TO_SESSION - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Send a message to a client session for a particular message path.
- sendRequest(SessionId, String, T, Class<T>, Class<R>) - Method in interface com.pushtechnology.diffusion.client.features.Messaging
-
Send a request to a session.
- sendRequest(String, T, Class<T>, Class<R>) - Method in interface com.pushtechnology.diffusion.client.features.Messaging
-
Send a request.
- sendRequestToFilter(String, String, T, Class<T>, Class<R>, Messaging.FilteredRequestCallback<? super R>) - Method in interface com.pushtechnology.diffusion.client.features.Messaging
-
Send a request to all sessions that satisfy a given session filter.
- sequence() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionLockDetails
-
Returns the lock sequence number.
- sequence() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.EventMetadata
-
Sequence number identifying this event within its time series.
- serializedBinaryDeltaType() - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Return the binary delta type that for serialized data of this data type, if any.
- server(String) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics.MetricsRequest
-
Specifies the name of the server to fetch metrics from.
- SERVER_NAME - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for server name.
- serverHost(String) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set the host name of the server to connect the session to.
- ServerInitializingException - Exception in com.pushtechnology.diffusion.client.session
-
A session could not be established because the server was initializing.
- ServerInitializingException(String) - Constructor for exception com.pushtechnology.diffusion.client.session.ServerInitializingException
-
Constructor.
- serverName() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionLockDetails
-
Returns the name of the server that the session holding the lock is connected to.
- serverPort(int) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set the port of the server to connect the session to.
- Session - Interface in com.pushtechnology.diffusion.client.session
-
A client session to a server (or cluster of servers).
- SESSION_CLOSED - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
Communication with the server failed because the session is closed.
- SESSION_ID - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for session identifier.
- SESSION_TAKEN_OVER - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
The session has been closed to make way for a new session.
- Session.ErrorHandler - Interface in com.pushtechnology.diffusion.client.session
-
The error notification interface for a session.
- Session.ErrorHandler.Default - Class in com.pushtechnology.diffusion.client.session
-
Default
Session.ErrorHandler
implementation which simply logs errors at error level. - Session.Listener - Interface in com.pushtechnology.diffusion.client.session
-
The optional listener interface for a session which may be used to receive state notifications.
- Session.Listener.Default - Class in com.pushtechnology.diffusion.client.session
-
Default
Session.Listener
implementation which simply logs events at debug level. - Session.SessionError - Interface in com.pushtechnology.diffusion.client.session
-
Encapsulates the detail of a reported error.
- Session.SessionLock - Interface in com.pushtechnology.diffusion.client.session
-
A session lock is a server-managed resource that can be used to coordinate exclusive access to shared resources across sessions.
- Session.SessionLockScope - Enum Class in com.pushtechnology.diffusion.client.session
-
Values for the
scope
parameter ofSession.lock(String, SessionLockScope)
. - Session.State - Enum Class in com.pushtechnology.diffusion.client.session
-
Session state.
- SessionAttributes - Interface in com.pushtechnology.diffusion.client.session
-
Session Attributes.
- SessionAttributes.Transport - Enum Class in com.pushtechnology.diffusion.client.session
-
The transports available to Java clients.
- SessionClosedException - Exception in com.pushtechnology.diffusion.client.session
-
The session is closed.
- SessionClosedException() - Constructor for exception com.pushtechnology.diffusion.client.session.SessionClosedException
-
Constructor.
- SessionClosedException(String) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionClosedException
-
Constructor.
- SessionClosedException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionClosedException
- SessionClosedException(Throwable) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionClosedException
- SessionEstablishmentException - Exception in com.pushtechnology.diffusion.client.session
-
There was a problem when establishing a Session.
- SessionEstablishmentException(String) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionEstablishmentException
-
Constructor.
- SessionEstablishmentException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionEstablishmentException
- SessionEstablishmentException(Throwable) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionEstablishmentException
- SessionEstablishmentTransientException - Exception in com.pushtechnology.diffusion.client.session
-
Represents a transient problem when establishing a session.
- SessionEstablishmentTransientException(String) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionEstablishmentTransientException
-
Constructor.
- SessionEstablishmentTransientException(Throwable) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionEstablishmentTransientException
-
Constructor.
- SessionException - Exception in com.pushtechnology.diffusion.client.session
-
General class of exceptions indicating a
Session
specific failure. - SessionException() - Constructor for exception com.pushtechnology.diffusion.client.session.SessionException
- SessionException(String) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionException
- SessionException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionException
- SessionException(Throwable) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionException
- SessionFactory - Interface in com.pushtechnology.diffusion.client.session
-
Factory for client
sessions
. - sessionId() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event
-
Provides the session identifier of the client session that the event relates to.
- sessionId() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionLockDetails
-
Returns the session identifier of the session that holds the lock.
- SessionId - Interface in com.pushtechnology.diffusion.client.session
-
A unique
Session
identifier, allocated by the server. - sessionIdFromString(String) - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
-
Parses a session id from a string.
- sessionIdFromString(String) - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Parse a
SessionId
from a string. - sessions() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Returns the shared session factory.
- SessionSecurityException - Exception in com.pushtechnology.diffusion.client.session
-
The session operation failed due to a security constraint.
- SessionSecurityException() - Constructor for exception com.pushtechnology.diffusion.client.session.SessionSecurityException
-
Constructor.
- SessionSecurityException(String) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionSecurityException
- SessionSecurityException(String, Throwable) - Constructor for exception com.pushtechnology.diffusion.client.session.SessionSecurityException
- SessionTrees - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
This feature allows a client session to configure session trees.
- SessionTrees.BranchMapping - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
A session tree branch mapping.
- SessionTrees.BranchMappingTable - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
A session tree branch mapping table.
- SessionTrees.BranchMappingTable.Builder - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
Builder for
SessionTrees.BranchMappingTable
instances. - SessionTrees.InvalidBranchMappingException - Exception in com.pushtechnology.diffusion.client.features.control.topics
-
Exception indicating an invalid
SessionTrees.BranchMapping
orSessionTrees.BranchMappingTable
. - set(String, int, String, int, String) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.MutableRecordModel
-
Sets a specified field value.
- set(String, Class<T>, T) - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Sets the topic to a specified value.
- set(String, Class<T>, T, UpdateConstraint) - Method in interface com.pushtechnology.diffusion.client.features.TopicUpdate
-
Sets the topic to a specified value.
- set(String, String) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.model.MutableRecordModel
-
Sets a specified field value.
- set(T) - Method in interface com.pushtechnology.diffusion.client.features.UpdateStream
-
Sets the topic to a specified value.
- setAuthenticationHandler(String, AuthenticationControl.ControlAuthenticator) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.AuthenticationControl
-
Register an authenticator for client authentication events.
- setConflated(SessionId, boolean) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Control client queue conflation.
- setConflated(String, boolean) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Control client queue conflation.
- setDefaultPathPermissions(String, Set<PathPermission>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Sets the default path permissions to be assigned to a role.
- setGlobalPermissions(String, Set<GlobalPermission>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Sets the global permissions to be assigned to a role.
- setMetricAlert(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.Metrics
-
Set or update a metric alert with a given name and specification.
- setPassword(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Set a principal's password.
- setPathPermissions(String, String, Set<PathPermission>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Sets specific path permissions to be assigned for a role for a path.
- setQueueEventHandler(ClientControl.QueueEventStream) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Register a handler for client queue threshold events.
- setRequestStream(String, Class<? extends T>, Class<? super R>, Messaging.RequestStream<T, R>) - Method in interface com.pushtechnology.diffusion.client.features.Messaging
-
Set a request stream to handle requests to a specified path.
- setRoleIncludes(String, Set<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Sets the roles that are to be included within a specified role.
- setRoleLockedByPrincipal(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Restrict a role so it can only be edited by a specific principal.
- setRolesForAnonymousSessions(Set<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Sets the roles to be assigned by default to all anonymous sessions.
- setRolesForNamedSessions(Set<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityControl.ScriptBuilder
-
Sets the roles to be assigned by default to all named sessions.
- setSessionProperties(SessionId, Map<String, String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Send a request to the server to change the user-defined session properties for a session.
- setSessionProperties(String, Map<String, String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Send a request to the server to set all sessions that satisfy a session filter with the new user-defined session properties.
- setSessionPropertiesListener(ClientControl.SessionPropertiesStream, String...) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl
-
Deprecated.since 6.11
Use the new
ClientControl.addSessionEventListener(com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream, com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventParameters)
, which provides greater functionality and reports on sessions at all cluster members. This method will be removed in a future release. - size() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult
-
The number of elements in the fetch result.
- specification() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult.TopicResult
-
Returns the topic specification.
- specification(TopicSpecification) - Method in interface com.pushtechnology.diffusion.client.features.UpdateStream.Builder
-
Specifies a TopicSpecification for this update stream.
- SPLIT_PATH_PATTERN - Enum constant in enum class com.pushtechnology.diffusion.client.topics.TopicSelector.Type
-
The selector is a split-path pattern.
- SPLIT_PATH_PATTERN_PREFIX - Static variable in interface com.pushtechnology.diffusion.client.topics.TopicSelector
-
Prefix used for
SPLIT_PATH_PATTERN
expressions. - sslContext(SSLContext) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets the SSL Context if a secure connection is required.
- start() - Method in interface com.pushtechnology.diffusion.client.session.reconnect.ReconnectionStrategy.ReconnectionAttempt
-
Start the reconnection attempt.
- START_TIME - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for client start time.
- state() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event
-
Provides the current state of the session.
- STATE - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.Type
-
The event indicates a change of state of the identified session, including the opening of a new session.
- STATE_SET - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
-
StateSets represent a series of related boolean values, also called a bitset.
- stream() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.QueryResult
- Stream - Interface in com.pushtechnology.diffusion.client.callbacks
-
An extension of
Callback
that allows many callbacks for each call context. - STREAM_CHANGE - Enum constant in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
A fallback stream has been unsubscribed due to the addition of a stream that selects the topic.
- Stream.Default - Class in com.pushtechnology.diffusion.client.callbacks
-
Abstract default callback.
- streamStructure() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.QueryResult
-
Returns a description of the structure of the
result stream
. - string() - Method in interface com.pushtechnology.diffusion.datatype.DataTypes
-
Data type that supports string values.
- string(String) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a single occurrence string field to the current record.
- string(String, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a fixed multiplicity string field to the current record.
- string(String, int, int) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.schema.SchemaBuilder
-
Add a string field to the current record.
- STRING - Enum constant in enum class com.pushtechnology.diffusion.client.topics.details.TopicType
-
Topic that stores and publishes String values.
- STRING - Enum constant in enum class com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Field.Type
-
Plain String.
- STRING_DATATYPE_NAME - Static variable in interface com.pushtechnology.diffusion.datatype.DataTypes
-
String data type name.
- stringToRoles(String) - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
-
Parses a string with roles to a mutable set.
- stringToRoles(String) - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Utility method which converts a string of the format required by the
$Roles
session property into a mutable set of strings. - subscribe(SessionId, TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Subscribe another session to topics.
- subscribe(SessionId, TopicSelector, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Subscribe another session to topics.
- subscribe(SessionId, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Subscribe another session to topics.
- subscribe(SessionId, String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Subscribe another session to topics.
- subscribe(TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Request subscription to topics for the default topic selection scope.
- subscribe(TopicSelector, String) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Request subscription to topics.
- subscribe(String) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Request subscription to topics for the default topic selection scope.
- subscribe(String, String) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Request subscription to topics.
- subscribeByFilter(String, TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Subscribe sessions that satisfy a given session filter to topics.
- subscribeByFilter(String, TopicSelector, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Subscribe sessions that satisfy a given session filter to topics.
- subscribeByFilter(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Subscribe sessions that satisfy a given session filter to topics.
- subscribeByFilter(String, String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Subscribe sessions that satisfy a given session filter to topics.
- SUBSCRIPTION_REFRESH - Enum constant in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
The server has re-subscribed this session to the topic.
- SubscriptionControl - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
This feature allows a session to subscribe or unsubscribe other sessions to topics, on a single server or across a cluster.
- SubscriptionControl.SubscriptionByFilterResult - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
Result used by CompletableFuture variants of
subscribeByFilter
andunsubscribeByFilter
. - SUMMARY - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
-
Like Histograms, Summaries measure distributions of discrete events and MAY be used when Histograms are too expensive and/or an average event size is sufficient.
- suppressDeltas(boolean) - Method in interface com.pushtechnology.diffusion.client.features.UpdateStream.Builder
-
Specifies if delta compression should be disabled for this update stream.
- SystemAuthenticationControl - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
This feature allows a client session to query and update the system authentication store.
- SystemAuthenticationControl.AnonymousConnectionAction - Enum Class in com.pushtechnology.diffusion.client.features.control.clients
-
Action to be taken by the system authentication handler for connection attempts that do not provide a principal name and credentials.
- SystemAuthenticationControl.ScriptBuilder - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
A script builder may be used to create a script of commands to apply to the system authentication store at the server.
- SystemAuthenticationControl.SessionPropertyValidation - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Defines the validation for a trusted client proposed session property.
- SystemAuthenticationControl.SessionPropertyValidation.MatchesSessionPropertyValidation - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Defines regular expression based validation for a trusted client proposed session property.
- SystemAuthenticationControl.SessionPropertyValidation.ValuesSessionPropertyValidation - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Defines values based validation for a trusted client proposed session property.
- SystemAuthenticationControl.SystemAuthenticationConfiguration - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
Snapshot of information from the system authentication store.
- SystemAuthenticationControl.SystemPrincipal - Interface in com.pushtechnology.diffusion.client.features.control.clients
-
A principal in the system authentication store.
T
- TIDY_ON_UNSUBSCRIBE - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies the 'tidy on unsubscribe' option for a topic.
- TIME_SERIES - Enum constant in enum class com.pushtechnology.diffusion.client.topics.details.TopicType
-
Time Series Topic.
- TIME_SERIES_EVENT_VALUE_TYPE - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies the event data type for a time series topic.
- TIME_SERIES_RETAINED_RANGE - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies the range of events retained by a time series topic.
- TIME_SERIES_SUBSCRIPTION_RANGE - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies the range of time series topic events to send to new subscribers.
- TimeSeries - Interface in com.pushtechnology.diffusion.client.features
-
This feature allows a session to update and query time series topics.
- TimeSeries.Event<V> - Interface in com.pushtechnology.diffusion.client.features
-
An event in a time series.
- TimeSeries.EventMetadata - Interface in com.pushtechnology.diffusion.client.features
-
Time series event metadata.
- TimeSeries.InvalidQueryException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report a query that is invalid for the time series.
- TimeSeries.NoSuchEventException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report a time series topic does not have an original event with the sequence number provided by an
edit
operation. - TimeSeries.Query<V> - Interface in com.pushtechnology.diffusion.client.features
-
A configured query.
- TimeSeries.QueryResult<V> - Interface in com.pushtechnology.diffusion.client.features
-
Query result providing a
stream of events
. - TimeSeries.QueryResult.StreamStructure - Enum Class in com.pushtechnology.diffusion.client.features
-
Describes the structural properties of a stream.
- TimeSeries.RangeQuery<V> - Interface in com.pushtechnology.diffusion.client.features
-
Builder for queries that select a range of events from a time series.
- timestamp() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.EventMetadata
-
Event timestamp.
- to(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to end at an absolute sequence number.
- to(String) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies a logical end point within the topic tree.
- to(Instant) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to end at an absolute time.
- to(Date) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to end at an absolute time.
- toByteArray() - Method in interface com.pushtechnology.diffusion.datatype.Bytes
-
Returns a copy of the data as a byte array.
- toBytes() - Method in interface com.pushtechnology.diffusion.client.types.Credentials
-
Return the credential data as a byte array.
- toBytes(D) - Method in interface com.pushtechnology.diffusion.datatype.DeltaType
-
Returns the serialized form of
delta
as aBytes
. - toBytes(V) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Returns the serialized form of
value
as aBytes
. - toJsonString() - Method in interface com.pushtechnology.diffusion.datatype.json.JSON
- TOPIC_TREE_REGISTRATION_CONFLICT - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
A conflicting registration exists on the same branch of the topic tree.
- TopicControl - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
This feature allows a session to manage topics.
- TopicControl.AddTopicException - Exception in com.pushtechnology.diffusion.client.features.control.topics
-
Exception thrown to report a failure to add a topic.
- TopicControl.AddTopicResult - Enum Class in com.pushtechnology.diffusion.client.features.control.topics
-
Used to report the result of adding a topic.
- TopicControl.ExistingTopicException - Exception in com.pushtechnology.diffusion.client.features.control.topics
-
Exception thrown to report a topic could not be added because an existing topic with a different specification is bound to the topic path.
- TopicControl.IncompatibleExistingTopicException - Exception in com.pushtechnology.diffusion.client.features.control.topics
-
Exception thrown to report that a topic exists at the same path that is managed by a component that has exclusive control over the topic.
- TopicControl.IncompatibleTopicException - Exception in com.pushtechnology.diffusion.client.features.control.topics
-
Exception thrown to report a topic could not be added because there is an existing topic that is incompatible with the request.
- TopicControl.InvalidTopicPathException - Exception in com.pushtechnology.diffusion.client.features.control.topics
-
Exception thrown to report a topic could not be added because the topic path supplied is invalid.
- TopicControl.InvalidTopicSpecificationException - Exception in com.pushtechnology.diffusion.client.features.control.topics
-
Exception thrown to report a topic could not be added because the specification is invalid.
- TopicControl.MissingTopicNotification - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
Notification that a session has made a subscription request using a selector that does not match any topics.
- TopicControl.MissingTopicNotificationStream - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
Stream called when a session subscribes using a topic selector that matches no topics.
- TopicControl.MissingTopicNotificationStream.Default - Class in com.pushtechnology.diffusion.client.features.control.topics
- TopicControl.TopicLicenseLimitException - Exception in com.pushtechnology.diffusion.client.features.control.topics
-
Exception thrown to report a topic could not be added because a licence limit has been exceeded.
- TopicControl.TopicRemovalResult - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
Reports the number of topics removed by a call to
TopicControl.removeTopics(com.pushtechnology.diffusion.client.topics.TopicSelector)
. - TopicCreationResult - Enum Class in com.pushtechnology.diffusion.client.features
-
Result indicating whether the operation caused a topic to be created or if it already existed.
- TopicLicenseLimitException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.control.topics.TopicControl.TopicLicenseLimitException
- TopicNotifications - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
This feature allows a client session to receive notifications about changes to selected topics.
- TopicNotifications.NotificationRegistration - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
The NotificationRegistration represents the registration state of the associated listener on the server.
- TopicNotifications.TopicNotificationListener - Interface in com.pushtechnology.diffusion.client.features.control.topics
-
Listener for topic notifications.
- TopicNotifications.TopicNotificationListener.Default - Class in com.pushtechnology.diffusion.client.features.control.topics
-
Default listener.
- TopicNotifications.TopicNotificationListener.NotificationType - Enum Class in com.pushtechnology.diffusion.client.features.control.topics
-
The type of notification that has been received.
- TopicPathSelector - Interface in com.pushtechnology.diffusion.client.topics
-
A selector that selects a single topic path.
- Topics - Interface in com.pushtechnology.diffusion.client.features
-
This feature allows a client session to subscribe to topics to receive streamed topic updates, fetch the state of topics and/or update topics with new values.
- Topics.FetchRequest<V> - Interface in com.pushtechnology.diffusion.client.features
-
A parameterised query that can be used to search the topic tree.
- Topics.FetchResult<V> - Interface in com.pushtechnology.diffusion.client.features
-
Encapsulates the results from a fetch operation issued to the server.
- Topics.FetchResult.TopicResult<V> - Interface in com.pushtechnology.diffusion.client.features
-
Encapsulates the result of a
fetch
invocation for a single selected topic. - Topics.SubscriberStream - Interface in com.pushtechnology.diffusion.client.features
-
Base subscriber stream interface.
- Topics.SubscriberStream.Default - Class in com.pushtechnology.diffusion.client.features
-
Default
Topics.SubscriberStream
implementation. - Topics.UnsubscribeReason - Enum Class in com.pushtechnology.diffusion.client.features
-
The reason that an unsubscription occurred.
- Topics.ValueStream<V> - Interface in com.pushtechnology.diffusion.client.features
-
Stream interface that can be registered to receive subscription and value events whenever an update is received from the server.
- Topics.ValueStream.Default<V> - Class in com.pushtechnology.diffusion.client.features
-
Default
Topics.ValueStream
implementation. - TopicSelection - Interface in com.pushtechnology.diffusion.client.topics
-
A topic selection that represents either a subscription (selection) or an unsubscription (deselection).
- TopicSelection.Type - Enum Class in com.pushtechnology.diffusion.client.topics
-
Topic selector type.
- TopicSelector - Interface in com.pushtechnology.diffusion.client.topics
-
A
TopicSelector
is a value that identifies one or more topics. - TopicSelector.Type - Enum Class in com.pushtechnology.diffusion.client.topics
-
Topic selector type.
- topicSelectors() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Returns a parser for topic selector expressions.
- TopicSelectors - Interface in com.pushtechnology.diffusion.client.topics
-
Convert strings to
TopicSelector
s. - TopicSpecification - Interface in com.pushtechnology.diffusion.client.topics.details
-
Topic specifications provide the information required to create a topic.
- TopicType - Enum Class in com.pushtechnology.diffusion.client.topics.details
-
The topic type determines the type of the data values a topic publishes to subscribers.
- topicTypes(Set<TopicType>) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies that only topics of the specified topic types should be returned.
- TopicUpdate - Interface in com.pushtechnology.diffusion.client.features
-
This feature provides a client session with the ability to update topics.
- TopicUpdate.FailedPatchException - Exception in com.pushtechnology.diffusion.client.features
-
Exception thrown to report that applying a JSON Patch failed.
- TopicUpdate.InvalidPatchException - Exception in com.pushtechnology.diffusion.client.features
-
Exception thrown to report that a JSON Patch was invalid.
- TopicUpdate.JsonPatchResult - Interface in com.pushtechnology.diffusion.client.features
- TopicView - Interface in com.pushtechnology.diffusion.client.features.control.topics.views
-
Description of a topic view that has been created.
- TopicViews - Interface in com.pushtechnology.diffusion.client.features.control.topics.views
-
This feature allows a client session to manage topic views.
- toStart() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to end at the start of the time series.
- toString() - Method in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
- toString() - Method in class com.pushtechnology.diffusion.client.session.retry.RetryStrategy
- toString() - Method in interface com.pushtechnology.diffusion.client.session.Session.SessionError
-
Returns a string representation of the error.
- toString() - Method in interface com.pushtechnology.diffusion.client.session.SessionId
-
Returns a string representation of the session identifier.
- TRANSPORT - Static variable in interface com.pushtechnology.diffusion.client.session.Session
-
Session property key for transport.
- transports(SessionAttributes.Transport...) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Set the transports to use to connect the session to the server.
- trustClientProposedPropertyIn(String, Set<String>) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Specifies the name of a client proposed session property that should be allowed by the system authenticator along with a set of permissible values.
- trustClientProposedPropertyMatches(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Specifies the name of a client proposed session property that should be allowed by the system authenticator along with a regular expression to validate the property value.
- type() - Method in interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event
-
Provides the event type.
- type() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult.TopicResult
-
Returns the topic type.
- type() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change
-
Returns the change type.
U
- UNHANDLED_MESSAGE - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
A message was not handled by the server.
- UnhandledMessageException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report a message was not delivered to an application handler.
- UnhandledMessageException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.UnhandledMessageException
-
Constructor.
- UNKNOWN - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
-
An unknown metric type.
- UNKNOWN_GLOBAL_PERMISSION - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
A permission that is unsupported by the session.
- UNKNOWN_PATH_PERMISSION - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
A permission that is unsupported by the session.
- UNKNOWN_TOPIC_TYPE - Enum constant in enum class com.pushtechnology.diffusion.client.topics.details.TopicType
-
A topic type that is unsupported by the session.
- UNKNOWN_UNSUBSCRIBE_REASON - Enum constant in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
A reason that is unsupported by the session.
- unlock() - Method in interface com.pushtechnology.diffusion.client.session.Session.SessionLock
-
Release a session lock, if owned.
- UNLOCK_ON_CONNECTION_LOSS - Enum constant in enum class com.pushtechnology.diffusion.client.session.Session.SessionLockScope
-
The lock will be released when the acquiring session loses its current connection to the server.
- UNLOCK_ON_SESSION_LOSS - Enum constant in enum class com.pushtechnology.diffusion.client.session.Session.SessionLockScope
-
The lock will be released when the acquiring session is closed.
- UnsatisfiedConstraintException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report that a constraint was not satisfied.
- UnsatisfiedConstraintException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.UnsatisfiedConstraintException
-
Constructor.
- unsubscribe(SessionId, TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe another session from topics.
- unsubscribe(SessionId, TopicSelector, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe another session from topics.
- unsubscribe(SessionId, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe another session from topics.
- unsubscribe(SessionId, String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe another session from topics.
- unsubscribe(TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Unsubscribe from topics for the default topic selection scope.
- unsubscribe(TopicSelector, String) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Unsubscribe from topics.
- unsubscribe(String) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Unsubscribe from topics for the default topic selection scope.
- unsubscribe(String, String) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Unsubscribe from topics.
- unsubscribeAllScopes(SessionId, TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe topics from all topic selection scopes.
- unsubscribeAllScopes(SessionId, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe another session from topics for all topic selection scopes.
- unsubscribeAllScopes(TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Unsubscribe topics from all topic selection scopes.
- unsubscribeAllScopes(String) - Method in interface com.pushtechnology.diffusion.client.features.Topics
-
Unsubscribe topics from all topic selection scopes.
- unsubscribeAllScopesByFilter(String, TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe sessions that satisfy a given session filter from topics for all scopes.
- unsubscribeAllScopesByFilter(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe sessions that satisfy a given session filter from topics for all scopes.
- unsubscribeByFilter(String, TopicSelector) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe sessions that satisfy a given session filter from topics.
- unsubscribeByFilter(String, TopicSelector, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe sessions that satisfy a given session filter from topics.
- unsubscribeByFilter(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe sessions that satisfy a given session filter from topics.
- unsubscribeByFilter(String, String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.topics.SubscriptionControl
-
Unsubscribe sessions that satisfy a given session filter from topics.
- UNSUPPORTED - Static variable in class com.pushtechnology.diffusion.client.callbacks.ErrorReason
-
The request was rejected because the requested service is unsupported for this caller.
- untilLast(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to end a number of events before the end of the time series.
- untilLast(Duration) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to end at a relative time from the timestamp of the last event in the time series.
- untilLastMillis(long) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.RangeQuery
-
Return a copy of this RangeQuery with the span of the current range configured to end at a relative time from the timestamp of the last event in the time series.
- UPDATE_TOPIC - Enum constant in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Update a topic.
- UpdateConstraint - Interface in com.pushtechnology.diffusion.client.features
-
A constraint to be applied to an update operation or the creation of an update stream.
- UpdateConstraint.Factory - Interface in com.pushtechnology.diffusion.client.features
-
Factory for the constraint types.
- UpdateConstraint.Operator - Enum Class in com.pushtechnology.diffusion.client.features
-
An operator used in a constraint comparison.
- UpdateConstraint.PartialJSON - Interface in com.pushtechnology.diffusion.client.features
-
A constraint requiring the current value of a
JSON
topic to match the partially described value. - updateConstraints() - Method in interface com.pushtechnology.diffusion.client.Diffusion.Implementation
- updateConstraints() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Returns an update constraint factory.
- UPDATED - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.EventType
-
Deprecated.One or more relevant session properties have been updated.
- UpdateFailedException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report a topic update failed.
- UpdateFailedException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.UpdateFailedException
-
Constructor.
- updateStore(String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SecurityStoreFeature
-
Send a command script to the server to update the security store.
- UpdateStream<T> - Interface in com.pushtechnology.diffusion.client.features
-
An update stream provides a method for updating a specific topic.
- UpdateStream.Builder - Interface in com.pushtechnology.diffusion.client.features
-
Builder for
update stream
to use for updating a specific topic. - UpdateStreamBufferException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report the update stream buffer have exceeded its limit.
- UpdateStreamBufferException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.UpdateStreamBufferException
-
Constructor.
- UpdateStreamRetryLimitException - Exception in com.pushtechnology.diffusion.client.features
-
Exception used to report the number of retry attempts have exceeded the limit.
- UpdateStreamRetryLimitException(String) - Constructor for exception com.pushtechnology.diffusion.client.features.UpdateStreamRetryLimitException
-
Constructor.
V
- validate() - Method in interface com.pushtechnology.diffusion.client.features.UpdateStream
-
Validates the update stream.
- validate() - Method in interface com.pushtechnology.diffusion.datatype.json.JSON
-
Check whether this instance is valid.
- validate(Bytes) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Variant of
DataType.validate(Object)
that takes the serialized form of the value. - validate(V) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Check whether a value is valid.
- VALIDATE_VALUES - Static variable in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Key of the topic property that specifies whether a topic should validate inbound values.
- validateValueClass(Class<?>) - Method in interface com.pushtechnology.diffusion.datatype.DataTypes
-
Check if a given
valueClass
is a validDataType
or a superclass of one. - value() - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.Event
-
The value associated with the event.
- value() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult.TopicResult
-
Returns the topic value.
- value(UpdateConstraint.Operator, Object) - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint.Factory
-
Create a constraint comparing the current value of a topic to a supplied value.
- value(Object) - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint.Factory
-
Create a constraint requiring the current value of a topic to exactly match the supplied value.
- VALUE_EVENT_STREAM - Enum constant in enum class com.pushtechnology.diffusion.client.features.TimeSeries.QueryResult.StreamStructure
-
The stream is ordered by the original event sequence number, presenting edit events instead of the original events they replace.
- valueBuilder() - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2DataType
-
Creates a new
RecordV2Builder
. - valueCount() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult.TopicResult
-
Returns the number of values that the topic has.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.State
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.EventType
-
Deprecated.Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.AnonymousConnectionAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.CheckRemoteServerResult.ConnectionState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.topics.TopicControl.AddTopicResult
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener.NotificationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.TimeSeries.QueryResult.StreamStructure
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.TopicCreationResult
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.features.UpdateConstraint.Operator
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.session.Session.SessionLockScope
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.session.Session.State
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.session.SessionAttributes.Transport
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.topics.details.TopicType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.topics.TopicSelection.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.topics.TopicSelector.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.types.Credentials.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Field.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.pushtechnology.diffusion.client.Diffusion
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.State
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionEventStream.Event.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.EventType
-
Deprecated.Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.AnonymousConnectionAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.Metrics.MetricType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.CheckRemoteServerResult.ConnectionState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.topics.TopicControl.AddTopicResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.control.topics.TopicNotifications.TopicNotificationListener.NotificationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.TimeSeries.QueryResult.StreamStructure
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.TopicCreationResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.features.UpdateConstraint.Operator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.session.Session.SessionLockScope
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.session.Session.State
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.session.SessionAttributes.Transport
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.topics.details.TopicType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.topics.TopicSelection.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.topics.TopicSelector.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.types.Credentials.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.client.types.PathPermission
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.datatype.recordv2.RecordV2Delta.Change.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pushtechnology.diffusion.datatype.recordv2.schema.Schema.Field.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- valueSize() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult.TopicResult
-
Returns the size of the topic’s value (in bytes) or 0 if the topic has no value.
- valueTotalSize() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchResult.TopicResult
-
Return the total value size of a topic.
- verifyPassword(String, String) - Method in interface com.pushtechnology.diffusion.client.features.control.clients.SystemAuthenticationControl.ScriptBuilder
-
Assert that a principal's password is
password
. - VIEW_SECURITY - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
Read the security configuration.
- VIEW_SERVER - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
View the server's runtime state - for example, read metrics.
- VIEW_SESSION - Enum constant in enum class com.pushtechnology.diffusion.client.types.GlobalPermission
-
List or listen to client sessions.
W
- WEBSOCKET - Enum constant in enum class com.pushtechnology.diffusion.client.session.SessionAttributes.Transport
-
WebSocket transport.
- with(String, UpdateConstraint.Operator, Object) - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint.PartialJSON
-
Compares a location within the JSON topic value to a specified value.
- with(String, Class<V>, V) - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint.PartialJSON
-
Deprecated.since 6.10
Rather use the
with(String, Operator, Object)
method with theIS
operator. - without(String) - Method in interface com.pushtechnology.diffusion.client.features.UpdateConstraint.PartialJSON
-
Require a specific position in the JSON object to be absent.
- withoutProperties(String...) - Method in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Returns a new specification that does not have the specified properties.
- withProperties() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies that all properties associated with each topic's
specification
should be returned. - withProperties(Map<String, String>) - Method in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Creates a new specification with the specified properties.
- withProperty(String, String) - Method in interface com.pushtechnology.diffusion.client.topics.details.TopicSpecification
-
Creates a new specification with the specified property value set.
- withSchema(Schema) - Method in interface com.pushtechnology.diffusion.datatype.recordv2.RecordV2DataType
-
Bind a specific schema to a
RecordV2DataType
instance. - withSizes() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies that topic sizes should be returned.
- withUnpublishedDelayedTopics() - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Include the details of reference topics that are not yet published.
- withValue(T) - Method in interface com.pushtechnology.diffusion.client.features.TimeSeries.Event
-
Clone this event with a different value.
- withValues(Class<? extends T>) - Method in interface com.pushtechnology.diffusion.client.features.Topics.FetchRequest
-
Specifies that values should be returned for selected topics, constraining the selection to only those topics with a data type compatible with the specified value class.
- WRITE_TIMEOUT - Enum constant in enum class com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption
-
Specifies the write timeout session attribute value (in milliseconds).
- writeDelta(D, OutputStream) - Method in interface com.pushtechnology.diffusion.datatype.DeltaType
-
Serialize a delta to binary.
- writeTimeout(int) - Method in interface com.pushtechnology.diffusion.client.session.SessionFactory
-
Sets the write timeout value for blocking writes.
- writeValue(V, OutputStream) - Method in interface com.pushtechnology.diffusion.datatype.DataType
-
Serialize a value to binary.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Use the new
Security.reauthenticate(java.lang.String, com.pushtechnology.diffusion.client.types.Credentials, java.util.Map<java.lang.String, java.lang.String>)
in preference, which allows user proposed session properties to be supplied. This method will be removed in a future release.