## Uses of Class
org.richfaces.application.push.TopicKey

- Packages that use TopicKey
  Package | Description
  --- | ---
  org.richfaces.application.push |
  org.richfaces.application.push.impl |
  org.richfaces.application.push.impl.jms |
  org.richfaces.cdi.push | RichFaces push CDI

- - ### Uses of TopicKey in org.richfaces.application.push

    Methods in org.richfaces.application.push that return TopicKey
    Modifier and Type | Method and Description
    --- | ---
    `TopicKey` | Topic.`getKey()` Returns the key which this topic is associated with
    `TopicKey` | TopicKey.`getRootTopicKey()` Returns the `TopicKey` that identifies topic without subtopic.
    `TopicKey` | MessageData.`getTopicKey()` Returns a topic key with which this message is associated
    `TopicKey` | SessionTopicEvent.`getTopicKey()`
    `protected TopicKey` | TopicsContext.`getTopicKeyWithResolvedExpressions(TopicKey key)`

    Methods in org.richfaces.application.push that return types with arguments of type TopicKey
    Modifier and Type | Method and Description
    --- | ---
    `static com.google.common.base.Function<String,TopicKey>` | TopicKey.`factory()` Returns the function for creating `TopicKey`s from strings.
    `Map<TopicKey,String>` | Session.`getFailedSubscriptions()` Get a map of topic keys this session failed to be subscribed to including the message why the subscription failed
    `Collection<TopicKey>` | Session.`getSuccessfulSubscriptions()` Get a list of topic keys this session is successfully subscribed to
    `static com.google.common.base.Function<TopicKey,String>` | TopicKey.`toAddress()` Returns a function for converting `TopicKey` to address strings in format 'subtopic@topic'.

    Methods in org.richfaces.application.push with parameters of type TopicKey
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract Topic` | TopicsContext.`createTopic(TopicKey key)` Creates topic for given topic key
    `Topic` | TopicsContext.`getOrCreateTopic(TopicKey key)` Creates topic for given key or returns existing one when it was already created.
    `Topic` | TopicsContext.`getTopic(TopicKey key)` Returns topic for given key or null if no such topic was created yet.
    `protected TopicKey` | TopicsContext.`getTopicKeyWithResolvedExpressions(TopicKey key)`
    `void` | TopicsContext.`publish(TopicKey key, Object data)` Publishes data through the topic with given key.
    `void` | Session.`push(TopicKey topicKey, String serializedData)` Pushes given data to given topic key
    `void` | TopicsContext.`removeTopic(TopicKey key)` Removes topic with given key or does nothing when no such topic was created yet.

    Constructors in org.richfaces.application.push with parameters of type TopicKey
    Constructor and Description
    `MessageData(TopicKey topicKey, String serializedMessageData, long sequenceNumber)`
    `SessionPreSubscriptionEvent(Topic topic, TopicKey topicKey, Session session)`
    `SessionSubscriptionEvent(Topic topic, TopicKey topicKey, Session session)`
    `SessionTopicEvent(Topic topic, TopicKey topicKey, Session session)`
    `SessionUnsubscriptionEvent(Topic topic, TopicKey topicKey, Session session)`

  - ### Uses of TopicKey in org.richfaces.application.push.impl

    Methods in org.richfaces.application.push.impl that return TopicKey
    Modifier and Type | Method and Description
    --- | ---
    `TopicKey` | AbstractTopic.`getKey()`

    Methods in org.richfaces.application.push.impl that return types with arguments of type TopicKey
    Modifier and Type | Method and Description
    --- | ---
    `Map<TopicKey,String>` | SessionImpl.`getFailedSubscriptions()`
    `Collection<TopicKey>` | SessionImpl.`getSuccessfulSubscriptions()`

    Methods in org.richfaces.application.push.impl with parameters of type TopicKey
    Modifier and Type | Method and Description
    --- | ---
    `protected Topic` | TopicsContextImpl.`createTopic(TopicKey key)`
    `void` | SessionImpl.`push(TopicKey topicKey, String serializedData)`

    Constructors in org.richfaces.application.push.impl with parameters of type TopicKey
    Constructor and Description
    `AbstractTopic(TopicKey key)`
    `TopicImpl(TopicKey key, TopicsContextImpl topicsContext)`

  - ### Uses of TopicKey in org.richfaces.application.push.impl.jms

    Methods in org.richfaces.application.push.impl.jms with parameters of type TopicKey
    Modifier and Type | Method and Description
    --- | ---
    `protected Topic` | JMSTopicsContextImpl.`createTopic(TopicKey key)`

  - ### Uses of TopicKey in org.richfaces.cdi.push

    Methods in org.richfaces.cdi.push that return TopicKey
    Modifier and Type | Method and Description
    --- | ---
    `TopicKey` | TopicKeyResolver.`resolveTopicKey(Push pushAnnotation)` Resolves `TopicKey` from `Push` annotation properties.

Copyright © 2014 JBoss by Red Hat. All Rights Reserved.