org.ws4d.java.service

Class DefaultClientSubscription

java.lang.Object

org.ws4d.java.util.TimedEntry

org.ws4d.java.service.DefaultClientSubscription

All Implemented Interfaces:

EprInfoHandler.EprInfoProvider, ClientSubscription, ClientSubscriptionInternal

public final class DefaultClientSubscription
extends TimedEntry
implements ClientSubscriptionInternal, EprInfoHandler.EprInfoProvider

Subscription class, manages a client-side subscription.

Field Summary

Fields

Modifier and Type	Field and Description
EprInfoSet	subscriptionManagerEprInfos

Constructor Summary

Constructors

Constructor and Description
DefaultClientSubscription(EventSink sink, java.lang.String clientSubscriptionId, EndpointReference subscriptionManagerEpr, java.lang.String comManId, long duration, Service service, CredentialInfo credentialInfo) Constructor.
DefaultClientSubscription(EventSink sink, java.lang.String clientSubscriptionId, EprInfoHandler.EprInfoProvider eprInfoProvider, Service service, CredentialInfo credentialInfo)

Method Summary

Modifier and Type	Method and Description
void	dispose() Performs final clean-up on this client subscription instance.
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.
java.lang.String	getDebugString()
Iterator	getEprInfos()
EventSink	getEventSink() Returns the event sink, which receives subscribed messages.
XAddressInfo	getNextXAddressInfoAfterFailureForSubscriptionManager(URI transportAddress, int syncHostedBlockVersion)
DataStructure	getOutgoingDiscoveryInfos()
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	renewInternal(long newDuration) Called after a renew on this client subscription.
protected void	timedOut() Runs what should be done at time out.
void	unsubscribe() Terminates this subscription.

Methods inherited from class org.ws4d.java.util.TimedEntry

isDisabled, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

subscriptionManagerEprInfos

public EprInfoSet subscriptionManagerEprInfos

Constructor Detail

DefaultClientSubscription

public DefaultClientSubscription(EventSink sink,
                                 java.lang.String clientSubscriptionId,
                                 EndpointReference subscriptionManagerEpr,
                                 java.lang.String comManId,
                                 long duration,
                                 Service service,
                                 CredentialInfo credentialInfo)

Constructor.

Parameters:

sink -

clientSubscriptionId -

serviceSubscriptionId -

duration -

servRef -

DefaultClientSubscription

public DefaultClientSubscription(EventSink sink,
                                 java.lang.String clientSubscriptionId,
                                 EprInfoHandler.EprInfoProvider eprInfoProvider,
                                 Service service,
                                 CredentialInfo credentialInfo)

Method Detail

register

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

Description copied from interface: ClientSubscription

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

Specified by:

register in interface ClientSubscription

getOutgoingDiscoveryInfos

public DataStructure getOutgoingDiscoveryInfos()

Specified by:

getOutgoingDiscoveryInfos in interface EprInfoHandler.EprInfoProvider

getEprInfos

public Iterator getEprInfos()

Specified by:

getEprInfos in interface EprInfoHandler.EprInfoProvider

getDebugString

public java.lang.String getDebugString()

Specified by:

getDebugString in interface EprInfoHandler.EprInfoProvider

getClientSubscriptionId

public java.lang.String getClientSubscriptionId()

Specified by:

getClientSubscriptionId in interface ClientSubscription

Returns:

this subscription's ID

getTimeoutTime

public long getTimeoutTime()

Description copied from interface: ClientSubscription

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

Specified by:

getTimeoutTime in interface ClientSubscription

Returns:

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

getSubscriptionManagerAddressInfo

public EprInfo getSubscriptionManagerAddressInfo()

Description copied from interface: ClientSubscription

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

Specified by:

getSubscriptionManagerAddressInfo in interface ClientSubscription

Returns:

the EprInfo of this subscription's subscription manager

getNextXAddressInfoAfterFailureForSubscriptionManager

public XAddressInfo getNextXAddressInfoAfterFailureForSubscriptionManager(URI transportAddress,
                                                                          int syncHostedBlockVersion)
                                                                   throws CommunicationException

Specified by:

getNextXAddressInfoAfterFailureForSubscriptionManager in interface ClientSubscription

Throws:

CommunicationException

getServiceSubscriptionId

public java.lang.String getServiceSubscriptionId()

Description copied from interface: ClientSubscription

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

Specified by:

getServiceSubscriptionId in interface ClientSubscription

Returns:

the server-side subscription ID

getCommunicationManagerId

public java.lang.String getCommunicationManagerId()

Description copied from interface: ClientSubscription

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

Specified by:

getCommunicationManagerId in interface ClientSubscription

Returns:

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

getEventSink

public EventSink getEventSink()

Description copied from interface: ClientSubscription

Returns the event sink, which receives subscribed messages.

Specified by:

getEventSink in interface ClientSubscription

Returns:

the event sink behind this subscription

getService

public Service getService()

Description copied from interface: ClientSubscription

Returns the subscribed service.

Specified by:

getService in interface ClientSubscription

Returns:

the service this subscription refers to

renew

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

Description copied from interface: ClientSubscription

Renews subscription.

Specified by:

renew in interface ClientSubscription

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

unsubscribe

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

Description copied from interface: ClientSubscription

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

Specified by:

unsubscribe in interface ClientSubscription

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

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

Description copied from interface: ClientSubscription

Get the duration until expiration of this subscription.

Specified by:

getStatus in interface ClientSubscription

Returns:

the duration until expiration in milliseconds

Throws:

EventingException - if the subscription already expired

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

java.io.IOException

renewInternal

public void renewInternal(long newDuration)

Description copied from interface: ClientSubscriptionInternal

Called after a renew on this client subscription.

Specified by:

renewInternal in interface ClientSubscriptionInternal

Parameters:

newDuration - the new duration

dispose

public void dispose()

Description copied from interface: ClientSubscriptionInternal

Performs final clean-up on this client subscription instance. After a call to this method, the subscription will be invalid.

Warning! This method is not intended to be called from application code! It is used internally when a subscription instance is not needed anymore.

Specified by:

dispose in interface ClientSubscriptionInternal

timedOut

protected void timedOut()

Description copied from class: TimedEntry

Runs what should be done at time out. Will be called by the Watchdog at time out.

Specified by:

timedOut in class TimedEntry