org.ws4d.java.service

Class DefaultSubscriptionManager

java.lang.Object

org.ws4d.java.service.DefaultSubscriptionManager

All Implemented Interfaces:

SubscriptionManager

public class DefaultSubscriptionManager
extends java.lang.Object
implements SubscriptionManager

Constructor Summary

Constructors

Constructor and Description
DefaultSubscriptionManager(LocalService service, OutgoingDiscoveryInfosProvider provider)

Method Summary

Modifier and Type	Method and Description
long	getStatus(ClientSubscription subscription) This method should be called each time a service receives a request to obtain the status of a subscription from a client.
GetStatusResponseMessage	getStatus(GetStatusMessage msg, ConnectionInfo connectionInfo) This method should be called each time a local service receives a request to obtain the status of a subscription from a client.
boolean	isRemote()
long	renew(ClientSubscription subscription, long duration) Renews an existing subscription with new duration.
RenewResponseMessage	renew(RenewMessage msg, ConnectionInfo connectionInfo) This method should be called each time a local service receives a request to renew a subscription from a client.
void	sendSubscriptionEnd() Notifies each subscribed event sink / event listener that the service has terminated the subscription.
ClientSubscription	subscribe(EventSink sink, java.lang.String clientSubscriptionId, URISet eventActionURIs, long duration, CredentialInfo credentialInfo, java.lang.String comManId) Subscribe to subscription for local client.
SubscribeResponseMessage	subscribe(SubscribeMessage msg, boolean useReferenceParameterMode, ConnectionInfo connectionInfo) This method should be called each time a local service receives a subscription request from a remote client.
void	unsubscribe(ClientSubscription subscription) This method should be called each time a service receives a request to cancel a subscription from a local client.
UnsubscribeResponseMessage	unsubscribe(UnsubscribeMessage msg, ConnectionInfo connectionInfo) This method should be called each time a local service receives a request to cancel a subscription from a remote client.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSubscriptionManager

public DefaultSubscriptionManager(LocalService service,
                                  OutgoingDiscoveryInfosProvider provider)

Method Detail

subscribe

public SubscribeResponseMessage subscribe(SubscribeMessage msg,
                                          boolean useReferenceParameterMode,
                                          ConnectionInfo connectionInfo)
                                   throws SOAPException

Description copied from interface: SubscriptionManager

This method should be called each time a local service receives a subscription request from a remote client.

Specified by:

subscribe in interface SubscriptionManager

Parameters:

msg - the subscribe message describing the request

Returns:

a corresponding subscribe response message suitable to confirm the subscription

Throws:

SOAPException - in case the subscription failed for any reason, a fault message with further details can be obtained from this SOAPException (see SOAPException.getFault())

subscribe

public ClientSubscription subscribe(EventSink sink,
                                    java.lang.String clientSubscriptionId,
                                    URISet eventActionURIs,
                                    long duration,
                                    CredentialInfo credentialInfo,
                                    java.lang.String comManId)
                             throws EventingException

Description copied from interface: SubscriptionManager

Subscribe to subscription for local client.

Specified by:

subscribe in interface SubscriptionManager

Returns:

a client subscription instance describing the status and allowing management of the subscription

Throws:

EventingException

unsubscribe

public UnsubscribeResponseMessage unsubscribe(UnsubscribeMessage msg,
                                              ConnectionInfo connectionInfo)
                                       throws SOAPException

Description copied from interface: SubscriptionManager

This method should be called each time a local service receives a request to cancel a subscription from a remote client.

Specified by:

unsubscribe in interface SubscriptionManager

Parameters:

msg - the unsubscribe message describing the request

Returns:

a corresponding unsubscribe response message suitable to confirm the subscription cancellation

Throws:

SOAPException - in case the cancellation failed for any reason, a fault message with further details can be obtained from this SOAPException (see SOAPException.getFault())

unsubscribe

public void unsubscribe(ClientSubscription subscription)
                 throws EventingException

Description copied from interface: SubscriptionManager

This method should be called each time a service receives a request to cancel a subscription from a local client.

Specified by:

unsubscribe in interface SubscriptionManager

Parameters:

subscription - Client subscription.

Throws:

EventingException

renew

public RenewResponseMessage renew(RenewMessage msg,
                                  ConnectionInfo connectionInfo)
                           throws SOAPException

Description copied from interface: SubscriptionManager

This method should be called each time a local service receives a request to renew a subscription from a client.

Specified by:

renew in interface SubscriptionManager

Parameters:

msg - the renew message describing the request

Returns:

a corresponding renew response message suitable to confirm the subscription renewal

Throws:

SOAPException - in case the renewal failed for any reason, a fault message with further details can be obtained from this SOAPException (see SOAPException.getFault())

renew

public long renew(ClientSubscription subscription,
                  long duration)
           throws EventingException

Description copied from interface: SubscriptionManager

Renews an existing subscription with new duration. If duration is "0", subscription never terminates. This method should be called each time a service receives a request to renew a subscription from a client.

Specified by:

renew in interface SubscriptionManager

Throws:

EventingException

getStatus

public GetStatusResponseMessage getStatus(GetStatusMessage msg,
                                          ConnectionInfo connectionInfo)
                                   throws SOAPException

Description copied from interface: SubscriptionManager

This method should be called each time a local service receives a request to obtain the status of a subscription from a client.

Specified by:

getStatus in interface SubscriptionManager

Parameters:

msg - the get status message describing the request

Returns:

a corresponding get status response message suitable to confirm the subscription status query

Throws:

SOAPException - in case the status query failed for any reason, a fault message with further details can be obtained from this SOAPException (see SOAPException.getFault())

getStatus

public long getStatus(ClientSubscription subscription)
               throws EventingException,
                      CommunicationException

Description copied from interface: SubscriptionManager

This method should be called each time a service receives a request to obtain the status of a subscription from a client.

Specified by:

getStatus in interface SubscriptionManager

Returns:

the current status of the subscription in terms of milliseconds until its expiration

Throws:

EventingException

CommunicationException

sendSubscriptionEnd

public void sendSubscriptionEnd()

Description copied from interface: SubscriptionManager

Notifies each subscribed event sink / event listener that the service has terminated the subscription.

Specified by:

sendSubscriptionEnd in interface SubscriptionManager

isRemote

public boolean isRemote()

Specified by:

isRemote in interface SubscriptionManager