Package org.somda.sdc.dpws.service

Interface EventSinkAccess

All Known Implementing Classes:

HostedServiceProxyImpl

public interface EventSinkAccess

Offers access to event sink functionality in accordance with WS-Eventing.

Method Summary

Modifier and Type	Method	Description
com.google.common.util.concurrent.ListenableFuture<Duration>	getStatus(String subscriptionId)	Gets the status of a subscription.
com.google.common.util.concurrent.ListenableFuture<Duration>	renew(String subscriptionId, Duration expires)	Renews a subscription.
com.google.common.util.concurrent.ListenableFuture<SubscribeResult>	subscribe(String filterDialect, List<Object> filters, Duration expires, Interceptor notificationSink)	Generically subscribes to an event source.
com.google.common.util.concurrent.ListenableFuture<SubscribeResult>	subscribe(List<String> actions, Duration expires, Interceptor notificationSink)	Subscribes to a set of actions using an action-based filter.
com.google.common.util.concurrent.ListenableFuture	unsubscribe(String subscriptionId)	Unsubscribes from a subscription.
void	unsubscribeAll()	Synchronously unsubscribes all subscriptions.

Method Details

subscribe

com.google.common.util.concurrent.ListenableFuture<SubscribeResult> subscribe(List<String> actions,
 @Nullable
 Duration expires,
 Interceptor notificationSink)

Subscribes to a set of actions using an action-based filter. This is a convenience function to subscribe for action-based filters, which is required to be supported by DPWS.

Parameters:

actions - a list of operation actions to subscribe for.

expires - the desired expiration time (the hosted service may decide to grant less than this). If none is given, the hosting service will take decision.

notificationSink - the sink where to deliver notifications.

Returns:

a future object that either includes subscription information or throws

• SoapFaultException
• MarshallingException
• TransportException
• InterceptorException

subscribe

com.google.common.util.concurrent.ListenableFuture<SubscribeResult> subscribe(String filterDialect,
 List<Object> filters,
 @Nullable
 Duration expires,
 Interceptor notificationSink)

Generically subscribes to an event source. Use subscribe(List, Duration, Interceptor) if action-based filtering is used.

Parameters:

filterDialect - the filter dialect URI.

filters - a list of filter objects towards the subscription.

expires - the desired expiration time (the hosted service may decide to grant less or more than this). If none is given, the hosting service will take decision.

notificationSink - the sink where to deliver notifications.

Returns:

a future object that either includes subscription information or throws

• SoapFaultException
• MarshallingException
• TransportException
• InterceptorException

renew

com.google.common.util.concurrent.ListenableFuture<Duration> renew(String subscriptionId,
 Duration expires)

Renews a subscription.

Parameters:

subscriptionId - the subscription id obtained in the SubscribeResult of subscribe(List, Duration, Interceptor).

expires - the desired new expiration duration.

Returns:

a future object that either includes a granted expires duration or throws

• SoapFaultException
• MarshallingException
• TransportException
• InterceptorException

getStatus

com.google.common.util.concurrent.ListenableFuture<Duration> getStatus(String subscriptionId)

Gets the status of a subscription.

Parameters:

subscriptionId - the subscription id obtained in the SubscribeResult of subscribe(List, Duration, Interceptor).

Returns:

a future object that either includes the remaining subscription time or throws

• SoapFaultException
• MarshallingException
• TransportException
• InterceptorException

unsubscribe

com.google.common.util.concurrent.ListenableFuture unsubscribe(String subscriptionId)

Unsubscribes from a subscription.

Parameters:

subscriptionId - the subscription id obtained in the SubscribeResult of subscribe(List, Duration, Interceptor).

Returns:

a future object that either delivers an empty object in case of successful unsubscribe or throws

• SoapFaultException
• MarshallingException
• TransportException
• InterceptorException

unsubscribeAll

void unsubscribeAll()

Synchronously unsubscribes all subscriptions.

See Also:

• EventSink.unsubscribeAll()