Package com.zeroc.IceStorm

Interface TopicPrx

All Superinterfaces:
ObjectPrx
public interface TopicPrx extends ObjectPrx
Publishers publish information on a particular topic. A topic logically represents a type.
See Also:

  • Method Details

    • getName

      default String getName()
      Get the name of this topic.
      Returns:
      The name of the topic.
      See Also:

    • getName

      default String getName(Map<String,String> context)
      Get the name of this topic.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The name of the topic.
      See Also:

    • getNameAsync

      default CompletableFuture<String> getNameAsync()
      Get the name of this topic.
      Returns:
      The name of the topic.
      See Also:

    • getNameAsync

      default CompletableFuture<String> getNameAsync(Map<String,String> context)
      Get the name of this topic.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The name of the topic.
      See Also:

    • getPublisher

      default ObjectPrx getPublisher()
      Get a proxy to a publisher object for this topic. To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy. If a replicated IceStorm deployment is used this call may return a replicated proxy.
      Returns:
      A proxy to publish data on this topic.

    • getPublisher

      default ObjectPrx getPublisher(Map<String,String> context)
      Get a proxy to a publisher object for this topic. To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy. If a replicated IceStorm deployment is used this call may return a replicated proxy.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to publish data on this topic.

    • getPublisherAsync

      default CompletableFuture<ObjectPrx> getPublisherAsync()
      Get a proxy to a publisher object for this topic. To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy. If a replicated IceStorm deployment is used this call may return a replicated proxy.
      Returns:
      A proxy to publish data on this topic.

    • getPublisherAsync

      default CompletableFuture<ObjectPrx> getPublisherAsync(Map<String,String> context)
      Get a proxy to a publisher object for this topic. To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy. If a replicated IceStorm deployment is used this call may return a replicated proxy.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to publish data on this topic.

    • getNonReplicatedPublisher

      default ObjectPrx getNonReplicatedPublisher()
      Get a non-replicated proxy to a publisher object for this topic. To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy.
      Returns:
      A proxy to publish data on this topic.

    • getNonReplicatedPublisher

      default ObjectPrx getNonReplicatedPublisher(Map<String,String> context)
      Get a non-replicated proxy to a publisher object for this topic. To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to publish data on this topic.

    • getNonReplicatedPublisherAsync

      default CompletableFuture<ObjectPrx> getNonReplicatedPublisherAsync()
      Get a non-replicated proxy to a publisher object for this topic. To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy.
      Returns:
      A proxy to publish data on this topic.

    • getNonReplicatedPublisherAsync

      default CompletableFuture<ObjectPrx> getNonReplicatedPublisherAsync(Map<String,String> context)
      Get a non-replicated proxy to a publisher object for this topic. To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to publish data on this topic.

    • subscribeAndGetPublisher

      default ObjectPrx subscribeAndGetPublisher(Map<String,String> theQoS, ObjectPrx subscriber) throws AlreadySubscribed, BadQoS, InvalidSubscriber
      Subscribe with the given qos to this topic. A per-subscriber publisher object is returned.
      Parameters:
      theQoS - The quality of service parameters for this subscription.
      subscriber - The subscriber's proxy.
      Returns:
      The per-subscriber publisher object.
      Throws:
      AlreadySubscribed - Raised if the subscriber object is already subscribed.
      BadQoS - Raised if the requested quality of service is unavailable or invalid.
      InvalidSubscriber - Raised if the subscriber object is null.
      See Also:

    • subscribeAndGetPublisher

      default ObjectPrx subscribeAndGetPublisher(Map<String,String> theQoS, ObjectPrx subscriber, Map<String,String> context) throws AlreadySubscribed, BadQoS, InvalidSubscriber
      Subscribe with the given qos to this topic. A per-subscriber publisher object is returned.
      Parameters:
      theQoS - The quality of service parameters for this subscription.
      subscriber - The subscriber's proxy.
      context - The Context map to send with the invocation.
      Returns:
      The per-subscriber publisher object.
      Throws:
      AlreadySubscribed - Raised if the subscriber object is already subscribed.
      BadQoS - Raised if the requested quality of service is unavailable or invalid.
      InvalidSubscriber - Raised if the subscriber object is null.
      See Also:

    • subscribeAndGetPublisherAsync

      default CompletableFuture<ObjectPrx> subscribeAndGetPublisherAsync(Map<String,String> theQoS, ObjectPrx subscriber)
      Subscribe with the given qos to this topic. A per-subscriber publisher object is returned.
      Parameters:
      theQoS - The quality of service parameters for this subscription.
      subscriber - The subscriber's proxy.
      Returns:
      The per-subscriber publisher object.
      See Also:

    • subscribeAndGetPublisherAsync

      default CompletableFuture<ObjectPrx> subscribeAndGetPublisherAsync(Map<String,String> theQoS, ObjectPrx subscriber, Map<String,String> context)
      Subscribe with the given qos to this topic. A per-subscriber publisher object is returned.
      Parameters:
      theQoS - The quality of service parameters for this subscription.
      subscriber - The subscriber's proxy.
      context - The Context map to send with the invocation.
      Returns:
      The per-subscriber publisher object.
      See Also:

    • unsubscribe

      default void unsubscribe(ObjectPrx subscriber)
      Unsubscribe the given subscriber.
      Parameters:
      subscriber - The proxy of an existing subscriber.
      See Also:

    • unsubscribe

      default void unsubscribe(ObjectPrx subscriber, Map<String,String> context)
      Unsubscribe the given subscriber.
      Parameters:
      subscriber - The proxy of an existing subscriber.
      context - The Context map to send with the invocation.
      See Also:

    • unsubscribeAsync

      default CompletableFuture<Void> unsubscribeAsync(ObjectPrx subscriber)
      Unsubscribe the given subscriber.
      Parameters:
      subscriber - The proxy of an existing subscriber.
      Returns:
      A future that will be completed when the invocation completes.
      See Also:

    • unsubscribeAsync

      default CompletableFuture<Void> unsubscribeAsync(ObjectPrx subscriber, Map<String,String> context)
      Unsubscribe the given subscriber.
      Parameters:
      subscriber - The proxy of an existing subscriber.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.
      See Also:

    • link

      default void link(TopicPrx linkTo, int cost) throws LinkExists
      Create a link to the given topic. All events originating on this topic will also be sent to linkTo.
      Parameters:
      linkTo - The topic to link to.
      cost - The cost to the linked topic.
      Throws:
      LinkExists - Raised if a link to the same topic already exists.

    • link

      default void link(TopicPrx linkTo, int cost, Map<String,String> context) throws LinkExists
      Create a link to the given topic. All events originating on this topic will also be sent to linkTo.
      Parameters:
      linkTo - The topic to link to.
      cost - The cost to the linked topic.
      context - The Context map to send with the invocation.
      Throws:
      LinkExists - Raised if a link to the same topic already exists.

    • linkAsync

      default CompletableFuture<Void> linkAsync(TopicPrx linkTo, int cost)
      Create a link to the given topic. All events originating on this topic will also be sent to linkTo.
      Parameters:
      linkTo - The topic to link to.
      cost - The cost to the linked topic.
      Returns:
      A future that will be completed when the invocation completes.

    • linkAsync

      default CompletableFuture<Void> linkAsync(TopicPrx linkTo, int cost, Map<String,String> context)
      Create a link to the given topic. All events originating on this topic will also be sent to linkTo.
      Parameters:
      linkTo - The topic to link to.
      cost - The cost to the linked topic.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • unlink

      default void unlink(TopicPrx linkTo) throws NoSuchLink
      Destroy the link from this topic to the given topic linkTo.
      Parameters:
      linkTo - The topic to destroy the link to.
      Throws:
      NoSuchLink - Raised if a link to the topic does not exist.

    • unlink

      default void unlink(TopicPrx linkTo, Map<String,String> context) throws NoSuchLink
      Destroy the link from this topic to the given topic linkTo.
      Parameters:
      linkTo - The topic to destroy the link to.
      context - The Context map to send with the invocation.
      Throws:
      NoSuchLink - Raised if a link to the topic does not exist.

    • unlinkAsync

      default CompletableFuture<Void> unlinkAsync(TopicPrx linkTo)
      Destroy the link from this topic to the given topic linkTo.
      Parameters:
      linkTo - The topic to destroy the link to.
      Returns:
      A future that will be completed when the invocation completes.

    • unlinkAsync

      default CompletableFuture<Void> unlinkAsync(TopicPrx linkTo, Map<String,String> context)
      Destroy the link from this topic to the given topic linkTo.
      Parameters:
      linkTo - The topic to destroy the link to.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getLinkInfoSeq

      default LinkInfo[] getLinkInfoSeq()
      Retrieve information on the current links.
      Returns:
      A sequence of LinkInfo objects.

    • getLinkInfoSeq

      default LinkInfo[] getLinkInfoSeq(Map<String,String> context)
      Retrieve information on the current links.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A sequence of LinkInfo objects.

    • getLinkInfoSeqAsync

      default CompletableFuture<LinkInfo[]> getLinkInfoSeqAsync()
      Retrieve information on the current links.
      Returns:
      A sequence of LinkInfo objects.

    • getLinkInfoSeqAsync

      default CompletableFuture<LinkInfo[]> getLinkInfoSeqAsync(Map<String,String> context)
      Retrieve information on the current links.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A sequence of LinkInfo objects.

    • getSubscribers

      default Identity[] getSubscribers()
      Retrieve the list of subscribers for this topic.
      Returns:
      The sequence of Ice identities for the subscriber objects.

    • getSubscribers

      default Identity[] getSubscribers(Map<String,String> context)
      Retrieve the list of subscribers for this topic.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The sequence of Ice identities for the subscriber objects.

    • getSubscribersAsync

      default CompletableFuture<Identity[]> getSubscribersAsync()
      Retrieve the list of subscribers for this topic.
      Returns:
      The sequence of Ice identities for the subscriber objects.

    • getSubscribersAsync

      default CompletableFuture<Identity[]> getSubscribersAsync(Map<String,String> context)
      Retrieve the list of subscribers for this topic.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The sequence of Ice identities for the subscriber objects.

    • destroy

      default void destroy()
      Destroy the topic.

    • destroy

      default void destroy(Map<String,String> context)
      Destroy the topic.
      Parameters:
      context - The Context map to send with the invocation.

    • destroyAsync

      default CompletableFuture<Void> destroyAsync()
      Destroy the topic.
      Returns:
      A future that will be completed when the invocation completes.

    • destroyAsync

      default CompletableFuture<Void> destroyAsync(Map<String,String> context)
      Destroy the topic.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • checkedCast

      static TopicPrx checkedCast(ObjectPrx obj)
      Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static TopicPrx checkedCast(ObjectPrx obj, Map<String,String> context)
      Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      context - The Context map to send with the invocation.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static TopicPrx checkedCast(ObjectPrx obj, String facet)
      Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static TopicPrx checkedCast(ObjectPrx obj, String facet, Map<String,String> context)
      Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      context - The Context map to send with the invocation.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • uncheckedCast

      static TopicPrx uncheckedCast(ObjectPrx obj)
      Downcasts the given proxy to this type without contacting the remote server.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A proxy for this type.

    • uncheckedCast

      static TopicPrx uncheckedCast(ObjectPrx obj, String facet)
      Downcasts the given proxy to this type without contacting the remote server.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A proxy for this type.

    • ice_context

      default TopicPrx ice_context(Map<String,String> newContext)
      Returns a proxy that is identical to this proxy, except for the per-proxy context.
      Specified by:
      ice_context in interface ObjectPrx
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      A proxy with the specified per-proxy context.

    • ice_adapterId

      default TopicPrx ice_adapterId(String newAdapterId)
      Returns a proxy that is identical to this proxy, except for the adapter ID.
      Specified by:
      ice_adapterId in interface ObjectPrx
      Parameters:
      newAdapterId - The adapter ID for the new proxy.
      Returns:
      A proxy with the specified adapter ID.

    • ice_endpoints

      default TopicPrx ice_endpoints(Endpoint[] newEndpoints)
      Returns a proxy that is identical to this proxy, except for the endpoints.
      Specified by:
      ice_endpoints in interface ObjectPrx
      Parameters:
      newEndpoints - The endpoints for the new proxy.
      Returns:
      A proxy with the specified endpoints.

    • ice_locatorCacheTimeout

      default TopicPrx ice_locatorCacheTimeout(int newTimeout)
      Returns a proxy that is identical to this proxy, except for the locator cache timeout.
      Specified by:
      ice_locatorCacheTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new locator cache timeout (in seconds).
      Returns:
      A proxy with the specified locator cache timeout.
      See Also:

    • ice_invocationTimeout

      default TopicPrx ice_invocationTimeout(int newTimeout)
      Returns a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new invocation timeout (in seconds).
      Returns:
      A proxy with the specified invocation timeout.

    • ice_connectionCached

      default TopicPrx ice_connectionCached(boolean newCache)
      Returns a proxy that is identical to this proxy, except for connection caching.
      Specified by:
      ice_connectionCached in interface ObjectPrx
      Parameters:
      newCache - true if the new proxy should cache connections; false otherwise.
      Returns:
      A proxy with the specified caching policy.

    • ice_endpointSelection

      default TopicPrx ice_endpointSelection(EndpointSelectionType newType)
      Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
      Specified by:
      ice_endpointSelection in interface ObjectPrx
      Parameters:
      newType - The new endpoint selection policy.
      Returns:
      A proxy with the specified endpoint selection policy.
      See Also:

    • ice_secure

      default TopicPrx ice_secure(boolean b)
      Returns a proxy that is identical to this proxy, except for how it selects endpoints.
      Specified by:
      ice_secure in interface ObjectPrx
      Parameters:
      b - If b is true, only endpoints that use a secure transport are used by the new proxy. If b is false, the returned proxy uses both secure and insecure endpoints.
      Returns:
      A proxy with the specified selection policy.

    • ice_encodingVersion

      default TopicPrx ice_encodingVersion(EncodingVersion e)
      Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
      Specified by:
      ice_encodingVersion in interface ObjectPrx
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      A proxy with the specified encoding version.

    • ice_preferSecure

      default TopicPrx ice_preferSecure(boolean b)
      Returns a proxy that is identical to this proxy, except for its endpoint selection policy.
      Specified by:
      ice_preferSecure in interface ObjectPrx
      Parameters:
      b - If b is true, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is false, the proxy prefers insecure endpoints to secure ones.
      Returns:
      A proxy with the specified selection policy.

    • ice_router

      default TopicPrx ice_router(RouterPrx router)
      Returns a proxy that is identical to this proxy, except for the router.
      Specified by:
      ice_router in interface ObjectPrx
      Parameters:
      router - The router for the new proxy.
      Returns:
      A proxy with the specified router.

    • ice_locator

      default TopicPrx ice_locator(LocatorPrx locator)
      Returns a proxy that is identical to this proxy, except for the locator.
      Specified by:
      ice_locator in interface ObjectPrx
      Parameters:
      locator - The locator for the new proxy.
      Returns:
      A proxy with the specified locator.

    • ice_collocationOptimized

      default TopicPrx ice_collocationOptimized(boolean b)
      Returns a proxy that is identical to this proxy, except for collocation optimization.
      Specified by:
      ice_collocationOptimized in interface ObjectPrx
      Parameters:
      b - true if the new proxy enables collocation optimization; false otherwise.
      Returns:
      A proxy with the specified collocation optimization.

    • ice_twoway

      default TopicPrx ice_twoway()
      Returns a proxy that is identical to this proxy, but uses twoway invocations.
      Specified by:
      ice_twoway in interface ObjectPrx
      Returns:
      A proxy that uses twoway invocations.

    • ice_oneway

      default TopicPrx ice_oneway()
      Returns a proxy that is identical to this proxy, but uses oneway invocations.
      Specified by:
      ice_oneway in interface ObjectPrx
      Returns:
      A proxy that uses oneway invocations.

    • ice_batchOneway

      default TopicPrx ice_batchOneway()
      Returns a proxy that is identical to this proxy, but uses batch oneway invocations.
      Specified by:
      ice_batchOneway in interface ObjectPrx
      Returns:
      A proxy that uses batch oneway invocations.

    • ice_datagram

      default TopicPrx ice_datagram()
      Returns a proxy that is identical to this proxy, but uses datagram invocations.
      Specified by:
      ice_datagram in interface ObjectPrx
      Returns:
      A proxy that uses datagram invocations.

    • ice_batchDatagram

      default TopicPrx ice_batchDatagram()
      Returns a proxy that is identical to this proxy, but uses batch datagram invocations.
      Specified by:
      ice_batchDatagram in interface ObjectPrx
      Returns:
      A proxy that uses batch datagram invocations.

    • ice_compress

      default TopicPrx ice_compress(boolean co)
      Returns a proxy that is identical to this proxy, except for compression.
      Specified by:
      ice_compress in interface ObjectPrx
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.

    • ice_timeout

      default TopicPrx ice_timeout(int t)
      Returns a proxy that is identical to this proxy, except for its connection timeout setting.
      Specified by:
      ice_timeout in interface ObjectPrx
      Parameters:
      t - The connection timeout for the proxy in milliseconds.
      Returns:
      A proxy with the specified timeout.

    • ice_connectionId

      default TopicPrx ice_connectionId(String connectionId)
      Returns a proxy that is identical to this proxy, except for its connection ID.
      Specified by:
      ice_connectionId in interface ObjectPrx
      Parameters:
      connectionId - The connection ID for the new proxy. An empty string removes the connection ID.
      Returns:
      A proxy with the specified connection ID.

    • ice_fixed

      default TopicPrx ice_fixed(Connection connection)
      Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection.
      Specified by:
      ice_fixed in interface ObjectPrx
      Parameters:
      connection - The fixed proxy connection.
      Returns:
      A fixed proxy bound to the given connection.

    • ice_staticId

      static String ice_staticId()
      Description copied from interface: ObjectPrx
      Returns the Slice type ID associated with this type.
      Returns:
      The Slice type ID.