org.ws4d.java.eventing

Interface ClientSubscription

All Known Subinterfaces:

ClientSubscriptionInternal

All Known Implementing Classes:

DefaultClientSubscription

public interface ClientSubscription

Subscription interface, allows client-side management of a subscription, such as renewing, unsubscribing, obtaining the current status, etc.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientSubscriptionId()
java.lang.String	getCommunicationManagerId() returns the ID of the communication manager used to communicate with the subscription manager corresponding to this client subscription instance.
EventSink	getEventSink() Returns the event sink, which receives subscribed messages.
XAddressInfo	getNextXAddressInfoAfterFailureForSubscriptionManager(URI transportAddress, int syncHostedBlockVersion)
Service	getService() Returns the subscribed service.
java.lang.String	getServiceSubscriptionId() Returns the server-side subscription identifier for this subscription (in terms of WS-Eventing, this is the wse:Identifier URI).
long	getStatus() Get the duration until expiration of this subscription.
EprInfo	getSubscriptionManagerAddressInfo() Returns the EprInfo of the server-side subscription manager for this subscription.
long	getTimeoutTime() Get system time in millis from the epoch when subscription will terminate.
void	register(long duration, EndpointReference subscriptionManagerEpr, java.lang.String comMgr) Only for initial registration, if the subscriptionManager is not known add creation of the ClientSubscription.
long	renew(long duration) Renews subscription.
void	unsubscribe() Terminates this subscription.

Method Detail

getTimeoutTime

long getTimeoutTime()

Get system time in millis from the epoch when subscription will terminate. If "0", subscription will never terminate.

Returns:

the time in terms of millis from the epoch when this subscription will expire

getSubscriptionManagerAddressInfo

EprInfo getSubscriptionManagerAddressInfo()

Returns the EprInfo of the server-side subscription manager for this subscription.

Be aware that the xAddress of the returned EprInfo may be null if the endpoint reference is not a transport address

Returns:

the EprInfo of this subscription's subscription manager

getNextXAddressInfoAfterFailureForSubscriptionManager

XAddressInfo getNextXAddressInfoAfterFailureForSubscriptionManager(URI transportAddress,
                                                                   int syncHostedBlockVersion)
                                                            throws CommunicationException

Throws:

CommunicationException

getCommunicationManagerId

java.lang.String getCommunicationManagerId()

returns the ID of the communication manager used to communicate with the subscription manager corresponding to this client subscription instance.

Returns:

the communication manager ID of this client subscription's subscription manager

getServiceSubscriptionId

java.lang.String getServiceSubscriptionId()

Returns the server-side subscription identifier for this subscription (in terms of WS-Eventing, this is the wse:Identifier URI).

Returns:

the server-side subscription ID

getClientSubscriptionId

java.lang.String getClientSubscriptionId()

Returns:

this subscription's ID

getEventSink

EventSink getEventSink()

Returns the event sink, which receives subscribed messages.

Returns:

the event sink behind this subscription

getService

Service getService()

Returns the subscribed service.

Returns:

the service this subscription refers to

renew

long renew(long duration)
    throws EventingException,
           java.io.IOException,
           CommunicationException

Renews subscription.

Parameters:

duration - new duration of subscription

Returns:

the new expiration duration or 0 in case the subscription doesn't expire at all

Throws:

EventingException - in case this subscription has already expired or an invalid duration was specified

CommunicationException - if this subscription refers to a remote service and contacting it timed out

java.io.IOException

register

void register(long duration,
              EndpointReference subscriptionManagerEpr,
              java.lang.String comMgr)

Only for initial registration, if the subscriptionManager is not known add creation of the ClientSubscription.

Parameters:

duration -

subscriptionManagerEpr -

unsubscribe

void unsubscribe()
          throws EventingException,
                 java.io.IOException,
                 CommunicationException

Terminates this subscription. If terminated renew or status requests can't be fulfilled.

Throws:

EventingException - if the subscription has already expired

CommunicationException - if this subscription refers to a remote service and contacting it timed out

java.io.IOException

getStatus

long getStatus()
        throws EventingException,
               java.io.IOException,
               CommunicationException

Get the duration until expiration of this subscription.

Returns:

the duration until expiration in milliseconds

Throws:

CommunicationException - if this subscription refers to a remote service and contacting it timed out

EventingException - if the subscription already expired

java.io.IOException