Package | Description |
---|---|
com.pushtechnology.diffusion.api.data |
Diffusion Topic Data API.
|
com.pushtechnology.diffusion.api.data.routing |
Diffusion Routing Topic Data API.
|
com.pushtechnology.diffusion.api.publisher |
Diffusion Internal Publisher API.
|
com.pushtechnology.diffusion.api.topic |
Diffusion Topics API.
|
Modifier and Type | Method and Description |
---|---|
Topic |
SlaveTopicData.getMasterTopic()
Returns the master topic.
|
Topic |
TopicData.getTopic()
Returns the Topic that the data belongs to.
|
Modifier and Type | Method and Description |
---|---|
Topic |
RoutingTopicDataSubscriptionHandler.clientSubscriptionRequest(TopicClient client,
RoutingTopicData topicData)
This is called when a Client attempts to subscribe to the Routing Topic.
|
Topic |
RoutingTopicData.getTopicForClient(String clientId)
Returns the real Topic mapped to for a particular client.
|
Modifier and Type | Method and Description |
---|---|
List<Topic> |
RoutingTopicData.getMappedTopics()
Get the list of Topics that this Routing data maps to.
|
Modifier and Type | Method and Description |
---|---|
List<TopicClient> |
RoutingTopicData.getClientsForTopic(Topic topic)
Get the list of Clients that are mapped to a particular Topic.
|
void |
RoutingTopicData.subscribe(TopicClient client,
Topic topic)
This may be used to subscribe a client to a Topic other than the parent
Topic, bypassing any authorisation checks.
|
Modifier and Type | Method and Description |
---|---|
Topic |
Publisher.addTopic(String topicName) |
Topic |
Publisher.addTopic(String topicName,
TopicData data) |
Topic |
Publisher.addTopic(String topicName,
TopicDefinition definition) |
Topic |
Publisher.addTopic(String topicName,
TopicTreeNode parent) |
Topic |
Publisher.addTopic(String topicName,
TopicTreeNode parent,
TopicData data) |
Topic |
Publisher.addTopic(String topicName,
TopicTreeNode parent,
TopicDefinition definition) |
Topic |
Publisher.getTopic(String topicName) |
Topic |
Publisher.getTopic(TopicMessage message) |
Modifier and Type | Method and Description |
---|---|
List<Topic> |
Client.fetch(TopicSet topicSet,
List<String> headers)
Causes a forced fetch of one or more Topics for the Client.
|
List<Topic> |
Publisher.getTopics() |
Modifier and Type | Method and Description |
---|---|
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.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 |
Client.canSubscribe(SubscriptionValidationPolicyConfig policy,
Topic topic)
Indicates whether he client is allowed to subscribe to a given topic
according to a given subscription validation policy.
|
boolean |
AuthorisationHandler.canWrite(Client client,
Topic topic)
Checks whether a given Client is allowed to send Messages to a specified
Topic.
|
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.
|
List<TopicClient> |
Publisher.getClients(Topic topic)
Returns the list of clients currently subscribed to a given topic.
|
static Publisher |
Publishers.getPublisherForTopic(Topic topic)
Returns the Publisher for a given topic.
|
Subscription |
Client.getSubscription(Topic topic)
Returns details of a Client's subscription to a given Topic.
|
void |
Publisher.subscribeClients(Topic topic) |
void |
Publisher.subscribeClients(Topic topic,
boolean force)
Deprecated.
|
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.
|
Modifier and Type | Method and Description |
---|---|
Topic |
TopicProvider.addTopic(String topicName)
Add a Topic to the root of the Topic tree.
|
Topic |
Topic.addTopic(String topicName)
Add a Topic to this Topic.
|
Topic |
TopicProvider.addTopic(String topicName,
TopicData data)
Add a Topic to the root of the Topic tree.
|
Topic |
Topic.addTopic(String topicName,
TopicData data)
Add a Topic to this Topic.
|
Topic |
TopicProvider.addTopic(String topicName,
TopicDefinition definition)
Add a Topic to the root of the Topic tree.
|
Topic |
Topic.addTopic(String topicName,
TopicDefinition definition)
Add a Topic to this Topic.
|
Topic |
TopicProvider.addTopic(String topicName,
TopicTreeNode parent)
Adds a Topic to a specified parent Topic.
|
Topic |
TopicProvider.addTopic(String topicName,
TopicTreeNode parent,
TopicData data)
Adds a Topic to a specified parent Topic.
|
Topic |
TopicProvider.addTopic(String topicName,
TopicTreeNode parent,
TopicDefinition definition)
Adds a Topic to a specified parent Topic.
|
Topic |
Topic.getRootTopic()
Returns the Topic at the top of this Topic's hierarchy.
|
Topic |
Subscription.getTopic()
Returns the Topic.
|
Topic |
TopicTreeNode.getTopic(String topicName)
Gets a child or descendant Topic of the current node.
|
Topic |
TopicTree.getTopic(String topicName)
Gets a Topic.
|
Topic |
TopicProvider.getTopic(String topicName)
Returns a named Topic of the provider.
|
Topic |
TopicProvider.getTopic(TopicMessage message)
Returns the Topic belonging to the provider that matches a given Message.
|
Modifier and Type | Method and Description |
---|---|
Set<Topic> |
TopicTreeNode.getAllTopics()
Returns all Topics subordinate to this node.
|
Set<Topic> |
TopicTreeNode.getTopics()
Returns any child Topics of this Topic node.
|
List<Topic> |
TopicProvider.getTopics()
Returns a list of the provider's Topics.
|
List<Topic> |
TopicClient.getTopics()
Returns a list of Topics that the Client is currently subscribed to.
|
Set<Topic> |
TopicTreeNode.getTopics(Collection<TopicSelector> selectors)
Returns a set of Topics that match one or more of a given set of
selectors . |
Set<Topic> |
TopicTreeNode.getTopics(String pattern)
Returns a set of Topics that are children/descendants of this node that
match with a supplied Topic 'specifier'.
|
Set<Topic> |
TopicTreeNode.getTopics(TopicSelector selector)
Returns a set of Topics that match a given
selector relative to this node. |
Set<Topic> |
TopicTreeNode.getTopics(TopicSet topicSet)
Returns a set of Topics that are children/descendants of this node.
|
abstract Set<Topic> |
TopicSelector.select(TopicTreeNode node)
Deprecated.
|
List<Topic> |
TopicClient.subscribe(TopicSet topicSet,
boolean force)
Deprecated.
since 5.5.
auto
subscription is always enabled so setting force=false has no
effect. Prefer TopicClient.subscribe(TopicSet) instead. |
List<Topic> |
TopicClient.unsubscribe(TopicSet topicSet)
Unsubscribe client from a set of Topics.
|
Modifier and Type | Method and Description |
---|---|
boolean |
TopicSubscriptionHandler.clientSubscriptionRequest(TopicClient client,
Topic topic)
Deprecated.
This is called before a client is actually subscribed to the Topic and it
allows for additional validation or delegation of the authorisation to
some asynchronous process.
|
TopicMessage |
CachedTopicLoader.getTopicStateMessage(Topic topic)
Get the current state of the Topic
|
boolean |
TopicClient.isSubscribed(Topic topic)
Indicates whether the client is currently subscribed to a given Topic.
|
boolean |
TopicLoader.load(TopicClient client,
Topic topic)
This is used to perform the Topic Load processing for a Client when
requested.
|
boolean |
SimpleTopicLoader.load(TopicClient client,
Topic topic)
Simple Implementation of
TopicLoader.load(TopicClient, Topic) |
boolean |
CachedTopicLoader.load(TopicClient client,
Topic topic)
Cached Topic load implementation.
|
boolean |
TopicClient.selectsTopic(Topic topic)
This may be used to determine whether the Client has previously
registered an interest (or subscribed to) a given Topic.
|
void |
TopicClient.subscribe(Topic topic)
Subscribe the client to a specified topic.
|
boolean |
TopicClient.subscribe(Topic topic,
boolean force)
Deprecated.
since 5.5.
auto
subscription is always enabled so setting force=false has no
effect. Prefer TopicClient.subscribe(Topic) instead. |
void |
TopicProvider.subscribeClients(Topic topic)
Subscribe all connected clients to a specified topic.
|
void |
TopicProvider.subscribeClients(Topic topic,
boolean force)
Deprecated.
since 5.5.
auto subscription is always enabled so setting force=false
has no effect. Prefer TopicProvider.subscribeClients(Topic)
instead. |
void |
TopicTreeListener.topicAdded(Topic topic)
Called whenever a new Topic is added.
|
void |
TopicTreeListener.topicReferenceChanged(Topic topic)
Notified when a Topic's reference has been changed.
|
boolean |
TopicClient.unsubscribe(Topic topic)
Unsubscribes the client from a given Topic.
|
Copyright © 2016 Push Technology Ltd. All Rights Reserved.