Package org.somda.sdc.dpws.service

Class HostedServiceProxyImpl

java.lang.Object

org.somda.sdc.dpws.service.HostedServiceProxyImpl

All Implemented Interfaces:

EventSinkAccess, HostedServiceProxy, InterceptorHandler, RequestResponseClient

public class HostedServiceProxyImpl
extends Object
implements HostedServiceProxy, EventSinkAccess

Default implementation of HostedServiceProxy.

Method Summary

Modifier and Type	Method	Description
String	getActiveEprAddress()	Gets the physical address that is actively being used to send requests.
EventSinkAccess	getEventSinkAccess()	Gets the event sink that can be used to subscribe and manage subscriptions of the hosted service.
RequestResponseClient	getRequestResponseClient()	Gets the request-response client used to send request messages and receive their response.
com.google.common.util.concurrent.ListenableFuture<Duration>	getStatus(String subscriptionId)	Gets the status of a subscription.
org.somda.sdc.dpws.model.HostedServiceType	getType()	Gets the hosted service metadata requestable via WS-TransferGet.
void	register(Interceptor interceptor)	Registers a callback object.
com.google.common.util.concurrent.ListenableFuture<Duration>	renew(String subscriptionId, Duration expires)	Renews a subscription.
SoapMessage	sendRequestResponse(SoapMessage request)	Sends a SOAP request message and waits for the response to be received from the recipient.
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.

Methods inherited from class java.lang.Object

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

Method Details

getType

public org.somda.sdc.dpws.model.HostedServiceType getType()

Description copied from interface: HostedServiceProxy

Gets the hosted service metadata requestable via WS-TransferGet.

Specified by:

getType in interface HostedServiceProxy

Returns:

a copy of the hosted service metadata received from the network.

getRequestResponseClient

public RequestResponseClient getRequestResponseClient()

Description copied from interface: HostedServiceProxy

Gets the request-response client used to send request messages and receive their response.

Hint: the HostingServiceProxy itself implements RequestResponseClient, which is the same as using the return value of this function.

Specified by:

getRequestResponseClient in interface HostedServiceProxy

Returns:

the RequestResponseClient instance capable of requesting this hosted service.

getEventSinkAccess

public EventSinkAccess getEventSinkAccess()

Description copied from interface: HostedServiceProxy

Gets the event sink that can be used to subscribe and manage subscriptions of the hosted service.

Attention: the event sink only works if the underlying hosted service acts as an event source. It is up to the user check the availability in advance, otherwise calls will end up in SOAP faults.

Specified by:

getEventSinkAccess in interface HostedServiceProxy

Returns:

the EventSinkAccess instance.

getActiveEprAddress

public String getActiveEprAddress()

Description copied from interface: HostedServiceProxy

Gets the physical address that is actively being used to send requests.

A hosted service can have different physical addresses in order to be accessible. The one that is returned with this function is the one that was used to initially resolve metadata (GetMetadata request).

Specified by:

getActiveEprAddress in interface HostedServiceProxy

Returns:

the currently active EPR address.

register

public void register(Interceptor interceptor)

Description copied from interface: InterceptorHandler

Registers a callback object.

Specified by:

register in interface InterceptorHandler

Parameters:

interceptor - an object that possesses MessageInterceptor annotated methods.

See Also:

• MessageInterceptor

sendRequestResponse

public SoapMessage sendRequestResponse(SoapMessage request)
                                throws SoapFaultException,
MarshallingException,
TransportException,
InterceptorException

Description copied from interface: RequestResponseClient

Sends a SOAP request message and waits for the response to be received from the recipient.

Specified by:

sendRequestResponse in interface RequestResponseClient

Parameters:

request - outgoing request message.

Returns:

incoming response message.

Throws:

SoapFaultException - if a SOAP fault comes up during processing.

MarshallingException - if any exception occurs during marshalling or unmarshalling of SOAP messages.

TransportException - if transport-related exceptions come up during processing. This will hinder the response from being sent.

InterceptorException - if one of the interceptors pops up with an error.

subscribe

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

Description copied from interface: EventSinkAccess

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.

Specified by:

subscribe in interface EventSinkAccess

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

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

Description copied from interface: EventSinkAccess

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

Specified by:

subscribe in interface EventSinkAccess

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

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

Description copied from interface: EventSinkAccess

Renews a subscription.

Specified by:

renew in interface EventSinkAccess

Parameters:

subscriptionId - the subscription id obtained in the SubscribeResult of EventSinkAccess.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

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

Description copied from interface: EventSinkAccess

Gets the status of a subscription.

Specified by:

getStatus in interface EventSinkAccess

Parameters:

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

Returns:

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

• SoapFaultException
• MarshallingException
• TransportException
• InterceptorException

unsubscribe

public com.google.common.util.concurrent.ListenableFuture<?> unsubscribe(String subscriptionId)

Description copied from interface: EventSinkAccess

Unsubscribes from a subscription.

Specified by:

unsubscribe in interface EventSinkAccess

Parameters:

subscriptionId - the subscription id obtained in the SubscribeResult of EventSinkAccess.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

public void unsubscribeAll()

Description copied from interface: EventSinkAccess

Synchronously unsubscribes all subscriptions.

Specified by:

unsubscribeAll in interface EventSinkAccess

See Also:

• EventSink.unsubscribeAll()