org.ws4d.java.eventing

Class DefaultEventSink

java.lang.Object

org.ws4d.java.eventing.DefaultEventSink

All Implemented Interfaces:

Bindable, EventSink

public class DefaultEventSink
extends java.lang.Object
implements EventSink

Class represents an endpoint to receive notifications.

Constructor Summary

Constructors

Constructor and Description
DefaultEventSink(EventListener eventListener, DataStructure bindings) Constructor.
DefaultEventSink(EventListener eventListener, int configurationId) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addBinding(CommunicationAutoBinding autoBinding) Adds the given autoBinding to this Bindable.
void	addBinding(CommunicationBinding binding) Adds the given binding to this Bindable.
void	addSubscription(java.lang.String clientSubId, ClientSubscription subscription) Internal method used within the subscription process. Subscribing to an event is done by Service.subscribe(EventSink, String, org.ws4d.java.types.URISet, long, CredentialInfo) .
URI	chooseNotifyToAddress(ConnectionInfo connectionInfo, Delivery delivery, boolean useReferenceParameterMode)
void	clearBindings() Removes all bindings from this Bindable instance.
void	close() Closes event receiving for this event endpoint.
Iterator	getCommunicationAutoBindings() Returns an iterator over all autoBindings assigned to this Bindable instance.
Iterator	getCommunicationBindings() Returns an iterator over all bindings assigned to this Bindable instance.
CommunicationStructureListener	getCommunicationStructureListener()
EventListener	getEventListener() Get associated event listener of this event sink.
ClientSubscription	getSubscription(java.lang.String clientSubId)
boolean	hasCommunicationAutoBindings() Returns true only if this instance has at least one binding assigned.
boolean	hasCommunicationBindings() Returns true only if this Bindable instance has at least one binding assigned.
boolean	isOpen() Returns if event sink is open to receive notifications/ solicit responses.
void	open(CredentialInfo credentialInfo) Opens event receiving for this event endpoint.
ParameterValue	receiveLocalEvent(java.lang.String clientSubscriptionId, URI actionUri, ParameterValue outputParameter, CredentialInfo credentialInfo) Callback method for receiving local notifications/ solicit responses.
boolean	removeBinding(CommunicationAutoBinding autoBinding)
boolean	removeBinding(CommunicationBinding binding) Removes the specified binding from this Bindable instance.
ClientSubscription	removeSubscription(java.lang.String clientSubId)
boolean	supportsBindingChanges()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEventSink

public DefaultEventSink(EventListener eventListener,
                        DataStructure bindings)

Constructor.

Parameters:

eventListener - Client with which this event sink should be associated. Received events will be transmitted to the eventListener.

bindings - a data structure of CommunicationBinding instances over which to expose this event sink

DefaultEventSink

public DefaultEventSink(EventListener eventListener,
                        int configurationId)

Constructor.

Parameters:

eventListener - Client with which this event sink should be associated. Received events will be transmitted to the eventListener.

configurationId - id for properties

Method Detail

hasCommunicationBindings

public boolean hasCommunicationBindings()

Description copied from interface: Bindable

Returns true only if this Bindable instance has at least one binding assigned. Returns false, if it doesn't have any bindings.

Specified by:

hasCommunicationBindings in interface Bindable

Returns:

whether there are any bindings assigned to that Bindable instance or not

hasCommunicationAutoBindings

public boolean hasCommunicationAutoBindings()

Description copied from interface: Bindable

Returns true only if this instance has at least one binding assigned. Returns false, if it doesn't have any autoBindings.

Specified by:

hasCommunicationAutoBindings in interface Bindable

Returns:

whether there are any autoBindings assigned to that Bindable instance or not

getCommunicationBindings

public Iterator getCommunicationBindings()

Description copied from interface: Bindable

Returns an iterator over all bindings assigned to this Bindable instance. This iterator will have no next elements (rather than being ), if the Bindable doesn't have any bindings.

Specified by:

getCommunicationBindings in interface Bindable

Returns:

an iterator over all available bindings

getCommunicationAutoBindings

public Iterator getCommunicationAutoBindings()

Description copied from interface: Bindable

Returns an iterator over all autoBindings assigned to this Bindable instance. This iterator will have no next elements (rather than being ), if the Bindable doesn't have any bindings.

Specified by:

getCommunicationAutoBindings in interface Bindable

Returns:

an iterator over all available bindings

supportsBindingChanges

public boolean supportsBindingChanges()

chooseNotifyToAddress

public URI chooseNotifyToAddress(ConnectionInfo connectionInfo,
                                 Delivery delivery,
                                 boolean useReferenceParameterMode)

Specified by:

chooseNotifyToAddress in interface EventSink

Returns:

addBinding

public void addBinding(CommunicationAutoBinding autoBinding)
                throws java.io.IOException

Description copied from interface: Bindable

Adds the given autoBinding to this Bindable. Does nothing if the Bindable already contains the binding.

Specified by:

addBinding in interface Bindable

Throws:

java.io.IOException

addBinding

public void addBinding(CommunicationBinding binding)
                throws java.io.IOException

Description copied from interface: Bindable

Adds the given binding to this Bindable. Does nothing if the Bindable already contains the binding.

Specified by:

addBinding in interface Bindable

Parameters:

binding - the binding to add

Throws:

java.io.IOException

removeBinding

public boolean removeBinding(CommunicationBinding binding)
                      throws java.io.IOException

Description copied from interface: Bindable

Removes the specified binding from this Bindable instance. Does nothing, if the Bindable doesn't contain the given binding. Returns true if the binding was removed and false if it didn't exist.

Specified by:

removeBinding in interface Bindable

Parameters:

binding - the binding to remove

Returns:

true if this Bindable instance had the given binding assigned and it was removed successfully, false otherwise

Throws:

java.io.IOException

removeBinding

public boolean removeBinding(CommunicationAutoBinding autoBinding)
                      throws java.io.IOException

Specified by:

removeBinding in interface Bindable

Throws:

java.io.IOException

clearBindings

public void clearBindings()
                   throws WS4DIllegalStateException

Description copied from interface: Bindable

Removes all bindings from this Bindable instance. Does nothing if there are no bindings assigned.

Specified by:

clearBindings in interface Bindable

Throws:

WS4DIllegalStateException - in case this Bindable doesn't support modifications at the current time (see #supportsBindingChanges())

open

public void open(CredentialInfo credentialInfo)
          throws java.io.IOException

Description copied from interface: EventSink

Opens event receiving for this event endpoint. All contained bindings will be bound to their communication managers and start listening to incoming event/ solicit response messages.

Specified by:

open in interface EventSink

Throws:

java.io.IOException

close

public void close()

Description copied from interface: EventSink

Closes event receiving for this event endpoint. All bindings of the event sink will be unbound.

Specified by:

close in interface EventSink

getEventListener

public EventListener getEventListener()

Description copied from interface: EventSink

Get associated event listener of this event sink.

Specified by:

getEventListener in interface EventSink

Returns:

EventListener associated with this event sink.

isOpen

public boolean isOpen()

Description copied from interface: EventSink

Returns if event sink is open to receive notifications/ solicit responses.

Specified by:

isOpen in interface EventSink

Returns:

true - if event sink is open to receive events/ solicit responses, else false.

getCommunicationStructureListener

public CommunicationStructureListener getCommunicationStructureListener()

Specified by:

getCommunicationStructureListener in interface EventSink

getSubscription

public ClientSubscription getSubscription(java.lang.String clientSubId)

Specified by:

getSubscription in interface EventSink

Returns:

the client subscription with the given ID

removeSubscription

public ClientSubscription removeSubscription(java.lang.String clientSubId)

Specified by:

removeSubscription in interface EventSink

Parameters:

clientSubId -

Returns:

the removed client subscription

addSubscription

public void addSubscription(java.lang.String clientSubId,
                            ClientSubscription subscription)

Description copied from interface: EventSink

Internal method used within the subscription process.
Subscribing to an event is done by Service.subscribe(EventSink, String, org.ws4d.java.types.URISet, long, CredentialInfo) .

Specified by:

addSubscription in interface EventSink

Parameters:

clientSubId - client subscription id

subscription - client subscription

receiveLocalEvent

public ParameterValue receiveLocalEvent(java.lang.String clientSubscriptionId,
                                        URI actionUri,
                                        ParameterValue outputParameter,
                                        CredentialInfo credentialInfo)
                                 throws AuthorizationException

Description copied from interface: EventSink

Callback method for receiving local notifications/ solicit responses.

Specified by:

receiveLocalEvent in interface EventSink

Parameters:

clientSubscriptionId - Subscription id the client sent to the service for subscription.

actionUri - Action of event fired.

outputParameter - The parameter value the service transmitted with the event message.

Returns:

Case event message: null
Case solicit response message: parameter value to be transmitted with the response message.

Throws:

AuthorizationException