Package | Description |
---|---|
com.pushtechnology.diffusion.client.features |
Unified API - Standard Client Features.
|
com.pushtechnology.diffusion.client.features.control.clients |
Unified API - Client Control Features.
|
com.pushtechnology.diffusion.client.features.control.topics |
Unified API - Topic Control Features.
|
com.pushtechnology.diffusion.client.session |
Unified API - Sessions.
|
Modifier and Type | Method and Description |
---|---|
void |
Messaging.addFallbackMessageStream(Messaging.MessageStream stream)
Add a fallback message stream.
|
<V> void |
Topics.addFallbackStream(Class<V> valueClass,
Topics.ValueStream<V> stream)
Add a fallback value stream.
|
void |
Topics.addFallbackTopicStream(Topics.TopicStream stream)
Add a fallback topic stream.
|
void |
Messaging.addMessageStream(String topics,
Messaging.MessageStream stream)
Add a message stream for messages received from the server on topics that
match the given
TopicSelector expression. |
void |
Messaging.addMessageStream(TopicSelector topics,
Messaging.MessageStream stream)
Adds a message stream for messages received from the server on topics
that match a given
TopicSelector . |
<V> void |
Topics.addStream(String topics,
Class<V> valueClass,
Topics.ValueStream<V> stream)
Add a value stream to receive topic events for topics that match a given
TopicSelector expression and have a value type that matches a
specified type. |
<V> void |
Topics.addStream(TopicSelector topics,
Class<V> valueClass,
Topics.ValueStream<V> stream)
Add a value stream to receive topic events for topics that match a given
TopicSelector and have a value type that matches a specified
type. |
void |
Topics.addTopicStream(String topics,
Topics.TopicStream stream)
Add a topic stream to receive topic events for all topics that match a
given
TopicSelector expression. |
void |
Topics.addTopicStream(TopicSelector topics,
Topics.TopicStream stream)
Add a topic stream to receive topic events for all topics that match a
given
TopicSelector . |
<C> void |
Security.changePrincipal(String principal,
Credentials credentials,
C context,
Security.ChangePrincipalContextCallback<C> callback)
Change the security principal associated with the current session.
|
void |
Security.changePrincipal(String principal,
Credentials credentials,
Security.ChangePrincipalCallback callback)
Change the security principal associated with the current session.
|
<C> void |
Topics.fetch(String topics,
C context,
Topics.FetchContextStream<C> callback)
Fetch the current state of topics.
|
void |
Topics.fetch(String topics,
Topics.FetchStream callback)
Fetch the current state of topics.
|
<C> void |
Topics.fetch(TopicSelector topics,
C context,
Topics.FetchContextStream<C> callback)
Fetch the current state of topics.
|
void |
Topics.fetch(TopicSelector topics,
Topics.FetchStream callback)
Fetch the current state of topics.
|
<C> void |
Topics.getTopicDetails(String topicPath,
TopicDetails.Level level,
C context,
Topics.TopicDetailsContextCallback<C> callback)
Get the details of a given topic.
|
void |
Topics.getTopicDetails(String topicPath,
TopicDetails.Level level,
Topics.TopicDetailsCallback callback)
Get the details of a given topic.
|
<C> void |
Pings.pingServer(C context,
Pings.PingContextCallback<C> callback)
Sends a ping request to the server.
|
void |
Pings.pingServer(Pings.PingCallback callback)
Sends a ping request to the server.
|
void |
Messaging.removeMessageStream(Messaging.MessageStream stream)
Remove a message stream.
|
void |
Topics.removeStream(Stream stream)
Remove a stream.
|
void |
Topics.removeTopicStream(Topics.TopicStream stream)
Deprecated.
since 5.7 use
removeStream . |
<C> void |
Messaging.send(String topicPath,
Bytes message,
C context,
Messaging.SendContextCallback<C> callback)
Send a message.
|
void |
Messaging.send(String topicPath,
Bytes message,
Messaging.SendCallback callback)
Send a message.
|
<C> void |
Messaging.send(String topicPath,
Bytes message,
SendOptions options,
C context,
Messaging.SendContextCallback<C> callback)
Send a message.
|
void |
Messaging.send(String topicPath,
Bytes message,
SendOptions options,
Messaging.SendCallback callback)
Send a message.
|
<C> void |
Messaging.send(String topicPath,
CharSequence message,
C context,
Messaging.SendContextCallback<C> callback)
Send a message.
|
void |
Messaging.send(String topicPath,
CharSequence message,
Messaging.SendCallback callback)
Send a message.
|
<C> void |
Topics.subscribe(String topics,
C context,
Topics.CompletionContextCallback<C> callback)
Request subscription to topics.
|
void |
Topics.subscribe(String topics,
Topics.CompletionCallback callback)
Request subscription to topics.
|
<C> void |
Topics.subscribe(TopicSelector topics,
C context,
Topics.CompletionContextCallback<C> callback)
Request subscription to topics.
|
void |
Topics.subscribe(TopicSelector topics,
Topics.CompletionCallback callback)
Request subscription to topics.
|
<C> void |
Topics.unsubscribe(String topics,
C context,
Topics.CompletionContextCallback<C> callback)
Unsubscribe from topics.
|
void |
Topics.unsubscribe(String topics,
Topics.CompletionCallback callback)
Unsubscribe from topics.
|
<C> void |
Topics.unsubscribe(TopicSelector topics,
C context,
Topics.CompletionContextCallback<C> callback)
Unsubscribe from topics.
|
void |
Topics.unsubscribe(TopicSelector topics,
Topics.CompletionCallback callback)
Unsubscribe from topics.
|
Modifier and Type | Method and Description |
---|---|
<C> void |
ClientControl.close(SessionId sessionId,
C context,
ClientControl.ClientContextCallback<C> callback)
Close a client session with a contextual callback.
|
void |
ClientControl.close(SessionId sessionId,
ClientControl.ClientCallback callback)
Close a client session.
|
<C> void |
ClientControl.close(SessionId sessionId,
String reason,
C context,
ClientControl.ClientContextCallback<C> callback)
Deprecated.
since 5.5. The reason parameter is not passed to the client
session being closed. Prefer
ClientControl.close(SessionId sessionId, ClientCallback callback)
instead.
If you want to notify the client being closed of the reason
for its closure, use the MessagingControl feature to send a
message to the client. To ensure that this message is
received before closing the client session, wait for the
callback to return before calling
ClientControl.close(SessionId sessionId, ClientCallback callback) |
void |
ClientControl.close(SessionId sessionId,
String reason,
ClientControl.ClientCallback callback)
Deprecated.
since 5.5. The reason parameter is not passed to the client
session being closed. Prefer
ClientControl.close(SessionId sessionId, ClientCallback callback)
instead.
If you want to notify the client being closed of the reason
for its closure, use the MessagingControl feature to send a
message to the client. To ensure that this message is
received before closing the client session, wait for the
callback to return before calling
ClientControl.close(SessionId sessionId, ClientCallback callback) |
<C> void |
SecurityControl.getSecurity(C context,
SecurityControl.ConfigurationContextCallback<C> callback)
Obtain the current contents of the security store, with a contextual
callback.
|
void |
SecurityControl.getSecurity(SecurityControl.ConfigurationCallback callback)
Obtain the current contents of the security store.
|
<C> void |
ClientControl.getSessionDetails(SessionId sessionId,
Set<SessionDetails.DetailType> types,
C context,
ClientControl.SessionDetailsContextCallback<C> callback)
Deprecated.
since 5.6 the use of
ClientControl.getSessionProperties(SessionId, Collection, Object, SessionPropertiesContextCallback)
is preferred and this method will be removed at a future
release |
void |
ClientControl.getSessionDetails(SessionId sessionId,
Set<SessionDetails.DetailType> types,
ClientControl.SessionDetailsCallback callback)
Deprecated.
since 5.6 the use of
ClientControl.getSessionProperties(SessionId, Collection, SessionPropertiesCallback)
is preferred and this method will be removed at a future
release |
<C> void |
ClientControl.getSessionProperties(SessionId sessionId,
Collection<String> requiredProperties,
C context,
ClientControl.SessionPropertiesContextCallback<C> callback)
Query the server for property values of a specified client session.
|
void |
ClientControl.getSessionProperties(SessionId sessionId,
Collection<String> requiredProperties,
ClientControl.SessionPropertiesCallback callback)
Query the server for property values of a specified client session.
|
<C> void |
SystemAuthenticationControl.getSystemAuthentication(C context,
SystemAuthenticationControl.ConfigurationContextCallback<C> callback)
Query the store for all of the system principals, with a contextual
callback.
|
void |
SystemAuthenticationControl.getSystemAuthentication(SystemAuthenticationControl.ConfigurationCallback callback)
Obtain the current contents of the store.
|
void |
AuthenticationControl.setAuthenticationHandler(String handlerName,
Set<SessionDetails.DetailType> requestedDetail,
AuthenticationControl.ControlAuthenticationHandler handler)
Register a handler for client authentication events.
|
<C> void |
ClientControl.setConflated(SessionId sessionId,
boolean conflate,
C context,
ClientControl.ClientContextCallback<C> callback)
Control client queue conflation with a contextual callback.
|
void |
ClientControl.setConflated(SessionId sessionId,
boolean conflate,
ClientControl.ClientCallback callback)
Control client queue conflation.
|
void |
ClientControl.setQueueEventHandler(ClientControl.QueueEventHandler handler)
Register a handler for client queue threshold events.
|
void |
ClientControl.setSessionDetailsListener(Set<SessionDetails.DetailType> requiredDetail,
ClientControl.SessionDetailsListener listener)
Deprecated.
since 5.6 the use of
ClientControl.setSessionPropertiesListener(SessionPropertiesListener, String...)
is preferred and this method will be removed at a future
release |
void |
ClientControl.setSessionPropertiesListener(ClientControl.SessionPropertiesListener listener,
String... requiredProperties)
Register a listener that will be notified when client sessions are
opened, disconnected, reconnected, closed or when selected session
property values are updated.
|
<C> void |
ClientControl.setThrottled(SessionId sessionId,
MessageQueuePolicy.ThrottlerType throttlerType,
int throttlingLimit,
C context,
ClientControl.ClientContextCallback<C> callback)
Instruct a client session to conflate its message queue, and to throttle
the queue according to the provided parameters.
|
void |
ClientControl.setThrottled(SessionId sessionId,
MessageQueuePolicy.ThrottlerType throttlerType,
int throttlingLimit,
ClientControl.ClientCallback callback)
Instruct a client session to conflate its message queue, and to throttle
the queue according to the provided parameters.
|
<C> void |
SecurityStoreFeature.updateStore(String commandScript,
C context,
SecurityStoreFeature.UpdateStoreContextCallback<C> callback)
Send a command script to the server to update the security store, with a
contextual callback.
|
void |
SecurityStoreFeature.updateStore(String commandScript,
SecurityStoreFeature.UpdateStoreCallback callback)
Send a command script to the server to update the security store.
|
Modifier and Type | Method and Description |
---|---|
void |
MessagingControl.addMessageHandler(String topicPath,
MessagingControl.MessageHandler handler,
String... sessionProperties)
Register a message handler to handle messages received from other client
sessions for a branch of the topic tree.
|
void |
TopicControl.addMissingTopicHandler(String topicPath,
TopicControl.MissingTopicHandler handler)
Register a
TopicControl.MissingTopicHandler to handle requests for a branch of
the topic tree. |
void |
SubscriptionControl.addRoutingSubscriptionHandler(String topicPath,
SubscriptionControl.RoutingSubscriptionRequest.Handler handler)
Adds a handler to associate with a particular node in the topic tree that
will be called upon requests by other client sessions to subscribe to
routing topics where there is no routing
subscription handler declared at the server. |
<C> void |
TopicControl.addTopic(String topicPath,
TopicDetails details,
Bytes value,
C context,
TopicControl.AddContextCallback<C> callback)
Version of
TopicControl.addTopic(String, TopicDetails, Bytes, AddCallback)
that allows a user defined context to be provided. |
void |
TopicControl.addTopic(String topicPath,
TopicDetails details,
Bytes value,
TopicControl.AddCallback callback)
Send a request to the server to add a topic, specifying its initial
value.
|
<C> void |
TopicControl.addTopic(String topicPath,
TopicDetails details,
C context,
TopicControl.AddContextCallback<C> callback)
Version of
TopicControl.addTopic(String, TopicDetails, AddCallback) that
allows a user defined context to be provided. |
void |
TopicControl.addTopic(String topicPath,
TopicDetails details,
TopicControl.AddCallback callback)
Send a request to the server to add a topic.
|
<C> void |
TopicControl.addTopic(String topicPath,
TopicSpecification specification,
Bytes value,
C context,
TopicControl.AddContextCallback<C> callback)
Version of
TopicControl.addTopic(String, TopicSpecification, Bytes, AddCallback) that
allows a user defined context to be provided. |
void |
TopicControl.addTopic(String topicPath,
TopicSpecification specification,
Bytes value,
TopicControl.AddCallback callback)
Send a request to the server to add a topic, specifying its initial
value.
|
<C> void |
TopicControl.addTopic(String topicPath,
TopicSpecification specification,
C context,
TopicControl.AddContextCallback<C> callback)
Version of
TopicControl.addTopic(String, TopicSpecification, AddCallback)
that allows a user defined context to be provided. |
void |
TopicControl.addTopic(String topicPath,
TopicSpecification specification,
TopicControl.AddCallback callback)
Send a request to the server to add a topic.
|
<C> TopicDetails |
TopicControl.addTopic(String topicPath,
TopicType topicType,
Bytes value,
C context,
TopicControl.AddContextCallback<C> callback)
Version of
TopicControl.addTopic(String, TopicType, Bytes, AddCallback) that
allows a user defined context to be provided. |
TopicDetails |
TopicControl.addTopic(String topicPath,
TopicType topicType,
Bytes value,
TopicControl.AddCallback callback)
Send a request to the server to add a topic.
|
<C> TopicDetails |
TopicControl.addTopic(String topicPath,
TopicType topicType,
C context,
TopicControl.AddContextCallback<C> callback)
Version of
TopicControl.addTopic(String, TopicType, AddCallback) that allows
a user defined context to be provided. |
TopicDetails |
TopicControl.addTopic(String topicPath,
TopicType topicType,
TopicControl.AddCallback callback)
Send a request to the server to add a topic.
|
void |
TopicControl.addTopicEventListener(String topicPath,
TopicControl.TopicEventListener listener)
Register a
TopicControl.TopicEventListener to receive topic events for a
branch of the topic tree. |
<T,C> TopicDetails |
TopicControl.addTopicFromValue(String topicPath,
T value,
C context,
TopicControl.AddContextCallback<C> callback)
Version of
TopicControl.addTopicFromValue(String, Object, AddCallback) that
allows a user defined context to be provided. |
<T> TopicDetails |
TopicControl.addTopicFromValue(String topicPath,
T value,
TopicControl.AddCallback callback)
Send a request to the server to add a topic where the type and initial
value for the topic are derived from a provided value object.
|
void |
TopicControl.MissingTopicNotification.cancel()
Cancel the client request on the server.
|
void |
SubscriptionControl.RoutingSubscriptionRequest.defer()
Defers the handling of this Routing Topic.
|
void |
TopicControl.MissingTopicNotification.proceed()
Instruct the server to complete processing of the session request.
|
void |
TopicUpdateControl.registerUpdateSource(String topicPath,
TopicUpdateControl.UpdateSource updateSource)
Register an
TopicUpdateControl.UpdateSource for a branch of the topic tree. |
<C> void |
TopicControl.remove(String topicSelector,
C context,
TopicControl.RemovalContextCallback<C> callback)
Version of
TopicControl.remove(String, RemovalCallback) that allows a user
defined context to be provided. |
void |
TopicControl.remove(String topicSelector,
TopicControl.RemovalCallback callback)
Send a request to remove one or more topics at the server.
|
<C> void |
TopicControl.removeTopics(String topicSelector,
C context,
TopicControl.RemoveContextCallback<C> callback)
Deprecated.
since 5.9
using |
void |
TopicControl.removeTopics(String topicSelector,
TopicControl.RemoveCallback callback)
Deprecated.
since 5.9
using |
void |
TopicControl.removeTopicsWithSession(String topicPath,
TopicTreeHandler registrationHandler)
Register a deferred action to remove a branch of the topic tree.
|
<C> void |
SubscriptionControl.RoutingSubscriptionRequest.route(String topicPath,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Provide a topic path to which the requested client will be routed via
the routing topic, with a contextual object.
|
void |
SubscriptionControl.RoutingSubscriptionRequest.route(String topicPath,
SubscriptionControl.SubscriptionCallback callback)
Provide a topic path to which the requested client will be routed via
the routing topic.
|
<C> void |
MessagingControl.send(SessionId sessionId,
String topicPath,
Bytes message,
C context,
MessagingControl.SendContextCallback<C> callback)
Send a message to a session via a specific topic.
|
void |
MessagingControl.send(SessionId sessionId,
String topicPath,
Bytes message,
MessagingControl.SendCallback callback)
Send a message to a session via a specific topic.
|
<C> void |
MessagingControl.send(SessionId sessionId,
String topicPath,
Bytes message,
SendOptions options,
C context,
MessagingControl.SendContextCallback<C> callback)
Send message to a session via a specific topic.
|
void |
MessagingControl.send(SessionId sessionId,
String topicPath,
Bytes message,
SendOptions options,
MessagingControl.SendCallback callback)
Send a message to a session via a specific topic.
|
<C> void |
MessagingControl.send(SessionId sessionId,
String topicPath,
CharSequence message,
C context,
MessagingControl.SendContextCallback<C> callback)
Send message to a session via a specific topic.
|
void |
MessagingControl.send(SessionId sessionId,
String topicPath,
CharSequence message,
MessagingControl.SendCallback callback)
Send a message to a session via a specific topic.
|
<C> void |
MessagingControl.sendToFilter(String filter,
String topicPath,
Bytes message,
C context,
MessagingControl.SendToFilterContextCallback<C> callback)
Send a message to all sessions that satisfy a given session filter.
|
void |
MessagingControl.sendToFilter(String filter,
String topicPath,
Bytes message,
MessagingControl.SendToFilterCallback callback)
Send a message to all sessions that satisfy a given session filter.
|
<C> void |
MessagingControl.sendToFilter(String filter,
String topicPath,
Bytes message,
SendOptions options,
C context,
MessagingControl.SendToFilterContextCallback<C> callback)
Send a message to all sessions that satisfy a given session filter.
|
void |
MessagingControl.sendToFilter(String filter,
String topicPath,
Bytes message,
SendOptions options,
MessagingControl.SendToFilterCallback callback)
Send a message to all sessions that satisfy a given session filter.
|
<C> void |
MessagingControl.sendToFilter(String filter,
String topicPath,
CharSequence message,
C context,
MessagingControl.SendToFilterContextCallback<C> callback)
Send a message to all sessions that satisfy a given session filter.
|
void |
MessagingControl.sendToFilter(String filter,
String topicPath,
CharSequence message,
MessagingControl.SendToFilterCallback callback)
Send a message to all sessions that satisfy a given session filter.
|
<C> void |
SubscriptionControl.subscribe(SessionId sessionId,
String topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Subscribe a client session to topics.
|
void |
SubscriptionControl.subscribe(SessionId sessionId,
String topics,
SubscriptionControl.SubscriptionCallback callback)
Subscribe a client session to topics.
|
<C> void |
SubscriptionControl.subscribe(SessionId sessionId,
TopicSelector topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Subscribe a client session to topics.
|
void |
SubscriptionControl.subscribe(SessionId sessionId,
TopicSelector topics,
SubscriptionControl.SubscriptionCallback callback)
Subscribe a client session to topics.
|
<C> void |
SubscriptionControl.subscribeByFilter(String filter,
String topics,
C context,
SubscriptionControl.SubscriptionByFilterContextCallback<C> callback)
Subscribe to all sessions that satisfy a given session filter to topics.
|
void |
SubscriptionControl.subscribeByFilter(String filter,
String topics,
SubscriptionControl.SubscriptionByFilterCallback callback)
Subscribe to all sessions that satisfy a given session filter to topics.
|
<C> void |
SubscriptionControl.subscribeByFilter(String filter,
TopicSelector topics,
C context,
SubscriptionControl.SubscriptionByFilterContextCallback<C> callback)
Subscribe to all sessions that satisfy a given session filter to topics.
|
void |
SubscriptionControl.subscribeByFilter(String filter,
TopicSelector topics,
SubscriptionControl.SubscriptionByFilterCallback callback)
Subscribe to all sessions that satisfy a given session filter to topics.
|
<C> void |
SubscriptionControl.unsubscribe(SessionId sessionId,
String topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Unsubscribe a client session from topics.
|
void |
SubscriptionControl.unsubscribe(SessionId sessionId,
String topics,
SubscriptionControl.SubscriptionCallback callback)
Unsubscribe a client session from topics.
|
<C> void |
SubscriptionControl.unsubscribe(SessionId sessionId,
TopicSelector topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Unsubscribe a client session from topics.
|
void |
SubscriptionControl.unsubscribe(SessionId sessionId,
TopicSelector topics,
SubscriptionControl.SubscriptionCallback callback)
Unsubscribe a client session from topics.
|
<C> void |
SubscriptionControl.unsubscribeByFilter(String filter,
String topics,
C context,
SubscriptionControl.SubscriptionByFilterContextCallback<C> callback)
Unsubscribe all sessions that satisfy a given session filter from topics.
|
void |
SubscriptionControl.unsubscribeByFilter(String filter,
String topics,
SubscriptionControl.SubscriptionByFilterCallback callback)
Unsubscribe all sessions that satisfy a given session filter from topics.
|
<C> void |
SubscriptionControl.unsubscribeByFilter(String filter,
TopicSelector topics,
C context,
SubscriptionControl.SubscriptionByFilterContextCallback<C> callback)
Unsubscribe all sessions that satisfy a given session filter from topics.
|
void |
SubscriptionControl.unsubscribeByFilter(String filter,
TopicSelector topics,
SubscriptionControl.SubscriptionByFilterCallback callback)
Unsubscribe all sessions that satisfy a given session filter from topics.
|
<C> void |
TopicUpdateControl.Updater.update(String topicPath,
Bytes data,
C context,
TopicUpdateControl.Updater.UpdateContextCallback<C> callback)
Updates a topic, with an attached context object.
|
void |
TopicUpdateControl.Updater.update(String topicPath,
Bytes data,
TopicUpdateControl.Updater.UpdateCallback callback)
Updates a topic with a
Bytes value. |
<C> void |
TopicUpdateControl.Updater.update(String topicPath,
CharSequence data,
C context,
TopicUpdateControl.Updater.UpdateContextCallback<C> callback)
Updates a topic, with an attached context object.
|
void |
TopicUpdateControl.Updater.update(String topicPath,
CharSequence data,
TopicUpdateControl.Updater.UpdateCallback callback)
Updates a topic.
|
<C> void |
TopicUpdateControl.Updater.update(String topicPath,
Update update,
C context,
TopicUpdateControl.Updater.UpdateContextCallback<C> callback)
Updates a topic with a context callback.
|
void |
TopicUpdateControl.Updater.update(String topicPath,
Update update,
TopicUpdateControl.Updater.UpdateCallback callback)
Updates a topic.
|
<C> void |
TopicUpdateControl.ValueUpdater.update(String topicPath,
V value,
C context,
TopicUpdateControl.Updater.UpdateContextCallback<C> callback)
Updates a topic to a specified value.
|
void |
TopicUpdateControl.ValueUpdater.update(String topicPath,
V value,
TopicUpdateControl.Updater.UpdateCallback callback)
Updates a topic to a specified value.
|
TopicUpdateControl.Updater |
TopicUpdateControl.updater()
Return an updater to use for non-exclusive updating.
|
Modifier and Type | Class and Description |
---|---|
class |
SessionEstablishmentException
There was a problem when establishing a Session.
|
Modifier and Type | Method and Description |
---|---|
<T extends Feature> |
Session.feature(Class<T> featureInterface)
Obtain a feature.
|
Session |
SessionFactory.open()
Open a new client session connected to a server using the configuration
of the factory.
|
Session |
SessionFactory.open(String url)
Open a new client session connected to a server via a given URL.
|
Copyright © 2016 Push Technology Ltd. All Rights Reserved.