org.universAAL.ri.gateway.proxies.importing

Class ProxyContextSubscriber

java.lang.Object

org.universAAL.middleware.bus.member.BusMember

org.universAAL.middleware.bus.member.Subscriber

org.universAAL.middleware.context.ContextSubscriber

org.universAAL.ri.gateway.proxies.importing.ProxyContextSubscriber

All Implemented Interfaces:

ProxyBusMember

public class ProxyContextSubscriber
extends ContextSubscriber
implements ProxyBusMember

Receives the events the remote BusMember is interested in, and sends the ContextEvents to its representative so it can deliver it to the remote BusMember.

Author:

amedrano

Field Summary

Fields inherited from class org.universAAL.middleware.bus.member.BusMember

busResourceURI, owner, theBus

Constructor Summary

Constructors

Constructor and Description
ProxyContextSubscriber(ModuleContext connectingModule, ContextEventPattern[] initialSubscriptions)

Method Summary

Modifier and Type	Method and Description
void	addRemoteProxyReference(BusMemberReference remoteReference) Add a BusMemberReference to the proxy.
void	addSubscriptionParameters(Resource[] newParams) When a update of registration parameters is required.
void	communicationChannelBroken() Method to be called when the communication of the Subsccriber with the Context Bus is lost.
String	getBusMemberId() Get the busmemberId.
Collection<BusMemberReference>	getRemoteProxiesReferences() List all current references for this proxy.
Resource[]	getSubscriptionParameters() Get the subscription parameters of the BusMember being proxied by this proxy.
void	handleContextEvent(ContextEvent event) Method to be called when an Event forwarded in the Context Bus matches one of the Patterns registered by this Subscriber.
void	handleMessage(Session session, WrappedBusMessage busMessage) When a session receives a WrappedBusMessage, it delivers it to the ProxyBusMember which its busMemberId matches the WrappedBusMessage's destination.
boolean	isCompatible(Resource[] registrationParameters) Used to check if a ProxyBusMember is capable of assuming the proxy duties of a requested proxy with the given parameters.
void	removeRemoteProxyReference(BusMemberReference remoteReference) Remove a concrete remote proxy.
void	removeRemoteProxyReferences(Session session) Disconnect from all references that use the same session.Does not send Remove message
void	removeSubscriptionParameters(Resource[] newParams) When a update of registration parameters is required.

Methods inherited from class org.universAAL.middleware.context.ContextSubscriber

addNewRegParams, busDyingOut, getAllProvisions, getMyID, handleEvent, removeMatchingRegParams

Methods inherited from class org.universAAL.middleware.bus.member.BusMember

close, getComment, getLabel, getType, getURI, setComment, setLabel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.universAAL.ri.gateway.proxies.ProxyBusMember

close

Constructor Detail

ProxyContextSubscriber

public ProxyContextSubscriber(ModuleContext connectingModule,
                              ContextEventPattern[] initialSubscriptions)

Parameters:

connectingModule -

initialSubscriptions -

Method Detail

getBusMemberId

public String getBusMemberId()

Get the busmemberId.
For imported proxies this ID of the internal busMember of the proxy.
For exported proxies this ID is of the represented BusMember.

Specified by:

getBusMemberId in interface ProxyBusMember

Returns:

addRemoteProxyReference

public void addRemoteProxyReference(BusMemberReference remoteReference)

Add a BusMemberReference to the proxy. This means that from this moment on the remote proxy and the local proxy can (and should) communicate with each other.
A proxy may have more than one remote reference, each time the local proxy is to send a message it should send it to the whole list of remote proxies (list of references), provided for each the outgoing security checks per message is passed.

Specified by:

addRemoteProxyReference in interface ProxyBusMember

Parameters:

remoteReference - The reference to a remote proxy, its busmemberid and the session through which to find it.

removeRemoteProxyReference

public void removeRemoteProxyReference(BusMemberReference remoteReference)

Remove a concrete remote proxy. Does not send Remove message

Specified by:

removeRemoteProxyReference in interface ProxyBusMember

Parameters:

remoteReference - the remote's proxy reference to stop communicating with.

removeRemoteProxyReferences

public void removeRemoteProxyReferences(Session session)

Disconnect from all references that use the same session.Does not send Remove message

Specified by:

removeRemoteProxyReferences in interface ProxyBusMember

Parameters:

session - the session that is to be disconnected.

getRemoteProxiesReferences

public Collection<BusMemberReference> getRemoteProxiesReferences()

List all current references for this proxy.
usually used to check the size, when the size of the set of references is 0 it means that the proxy should be closed and all Java-references so the object can be collected.

Specified by:

getRemoteProxiesReferences in interface ProxyBusMember

Returns:

the set of referneces.

getSubscriptionParameters

public Resource[] getSubscriptionParameters()

Get the subscription parameters of the BusMember being proxied by this proxy.

Specified by:

getSubscriptionParameters in interface ProxyBusMember

Returns:

handleMessage

public void handleMessage(Session session,
                          WrappedBusMessage busMessage)

When a session receives a WrappedBusMessage, it delivers it to the ProxyBusMember which its busMemberId matches the WrappedBusMessage's destination. The delivery is received through this method.

Specified by:

handleMessage in interface ProxyBusMember

Parameters:

session - the session through which the message was received.

busMessage - the actual message received.

isCompatible

public boolean isCompatible(Resource[] registrationParameters)

Used to check if a ProxyBusMember is capable of assuming the proxy duties of a requested proxy with the given parameters.
Usually this is just the comparison of arrays of registration parameters

Specified by:

isCompatible in interface ProxyBusMember

Returns:

true if the proxy is compatible with the parameters.

addSubscriptionParameters

public void addSubscriptionParameters(Resource[] newParams)

When a update of registration parameters is required.

Specified by:

addSubscriptionParameters in interface ProxyBusMember

Parameters:

newParams - the new parameters to use.

removeSubscriptionParameters

public void removeSubscriptionParameters(Resource[] newParams)

When a update of registration parameters is required.

Specified by:

removeSubscriptionParameters in interface ProxyBusMember

Parameters:

newParams - the new parameters to use.

communicationChannelBroken

public void communicationChannelBroken()

Method to be called when the communication of the Subsccriber with the Context Bus is lost.

Specified by:

communicationChannelBroken in class ContextSubscriber

handleContextEvent

public void handleContextEvent(ContextEvent event)

Method to be called when an Event forwarded in the Context Bus matches one of the Patterns registered by this Subscriber.

Specified by:

handleContextEvent in class ContextSubscriber

Parameters:

event - The Context Event that matched the registered Patterns