Package | Description |
---|---|
com.pushtechnology.diffusion.api.publisher |
Diffusion Internal Publisher API.
|
Modifier and Type | Method and Description |
---|---|
static Client |
Publishers.getClient(String clientID)
Returns Client given a Client ID.
|
Modifier and Type | Method and Description |
---|---|
static List<Client> |
Publishers.getClients()
Returns a list of all currently known Clients.
|
static List<Client> |
Publishers.getClients(ConnectionCategory category)
Returns a list of all currently known Clients that are of a specified
connection category.
|
Modifier and Type | Method and Description |
---|---|
boolean |
AuthorisationHandler.canConnect(Client client)
Deprecated.
since 5.2
Use an authentication handler in preference. This method is
still invoked for backwards compatibility, and can veto
attempts to connect |
boolean |
AuthorisationHandler.canFetch(Client client,
Topic topic)
Checks whether a given client is allowed to fetch the current state of a
specified Topic, even when not subscribed.
|
boolean |
AuthorisationHandler.canFetch(Client client,
TopicSelector selector)
Checks whether a given Client is allowed to fetch using a specified Topic
Selector.
|
boolean |
AuthorisationHandler.canSubscribe(Client client,
Topic topic)
Deprecated.
since 5.9
This method is deprecated and will be removed in a future release. This method is called frequently from performance sensitive code. When a new topic is added is added, this method will be called for all existing Clients. Implementations must be heavily optimized to avoid severely degrading server performance. Blocking I/O, allocation, use of locks, and computationally expensive operations should be avoided. Prefer Diffusion's declarative role-based security. |
boolean |
AuthorisationHandler.canSubscribe(Client client,
TopicSelector selector)
Checks whether a given Client is allowed to subscribe using a specified
Topic Selector.
|
boolean |
AuthorisationHandler.canWrite(Client client,
Topic topic)
Checks whether a given Client is allowed to send Messages to a specified
Topic.
|
void |
DefaultClientListener.clientClosed(Client client) |
void |
ClientListener.clientClosed(Client client)
This is called when a client connection is closed.
|
void |
DefaultClientListener.clientConnected(Client client) |
void |
ClientListener.clientConnected(Client client)
This is called when a new client is connected.
|
void |
DefaultClientListener.clientCredentials(Client client,
Credentials credentials) |
void |
ClientListener.clientCredentials(Client client,
Credentials credentials)
Notifies that a Client has sent new credentials.
|
void |
DefaultClientListener.clientFetchInvalid(Client client,
String topicName,
List<String> headers) |
void |
ClientListener.clientFetchInvalid(Client client,
String topicName,
List<String> headers)
This is called when a client attempts to fetch a topic that does not
exist.
|
void |
DefaultClientListener.clientQueueThresholdReached(Client client,
boolean upper,
int threshold) |
void |
ClientListener.clientQueueThresholdReached(Client client,
boolean upper,
int threshold)
Notifies an outbound message queue threshold has been reached.
|
void |
DefaultClientListener.clientResolved(Client client) |
void |
ClientListener.clientResolved(Client client)
This is called when a client's Internet address details have been
resolved.
|
void |
DefaultClientListener.clientSendInvalid(Client client,
TopicMessage message) |
void |
ClientListener.clientSendInvalid(Client client,
TopicMessage message)
This is called when a client attempts to send a message to a topic that
doesn't exist, or to which it is not currently subscribed.
|
void |
DefaultClientListener.clientSubscriptionInvalid(Client client,
String topicName) |
void |
ClientListener.clientSubscriptionInvalid(Client client,
String topicName)
This is called when a client attempts to subscribe to a topic that does
not exist.
|
boolean |
AuthorisationHandler.credentialsSupplied(Client client,
Credentials credentials)
Deprecated.
since 5.2
Use an authentication handler in preference. This method is
still invoked for backwards compatibility, and can veto
attempts to change the authenticated principal by returning
|
protected TopicMessage |
Publisher.fetchForClient(Client client,
Topic topic,
List<String> headers)
Deprecated.
since 5.6. Currently a classic client can issue a fetch
request to a stateless topic. This method enables a publisher
to return a reply. At future releases this capability will be
removed.
|
protected void |
Publisher.messageFromClient(TopicMessage message,
Client client)
This is called when a message has been received from a client.
|
protected void |
Publisher.subscription(Client client,
Topic topic,
boolean loaded)
This method is called when a client subscribes to a topic.
|
protected void |
Publisher.unsubscription(Client client,
Topic topic)
This is called when a client unsubscribes from one of the publisher's
topics.
|
Copyright © 2016 Push Technology Ltd. All Rights Reserved.