org.universAAL.ri.gateway.proxies

Interface ProxyBusMember

All Known Implementing Classes:

ProxyContextPublisher, ProxyContextSubscriber, ProxySCallee, ProxySCaller

public interface ProxyBusMember

Generic interface for any proxy representing any imported or exported BusMember, independently of the bus they associate to.

Author:

amedrano

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	close() Called when the proxy has to disconnect from the bus.
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	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.

Method Detail

getBusMemberId

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.

Returns:

addRemoteProxyReference

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.

Parameters:

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

removeRemoteProxyReference

void removeRemoteProxyReference(BusMemberReference remoteReference)

Remove a concrete remote proxy. Does not send Remove message

Parameters:

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

removeRemoteProxyReferences

void removeRemoteProxyReferences(Session session)

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

Parameters:

session - the session that is to be disconnected.

getRemoteProxiesReferences

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.

Returns:

the set of referneces.

getSubscriptionParameters

Resource[] getSubscriptionParameters()

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

Returns:

handleMessage

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.

Parameters:

session - the session through which the message was received.

busMessage - the actual message received.

isCompatible

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

Parameters:

registrationParameters -

Returns:

true if the proxy is compatible with the parameters.

close

void close()

Called when the proxy has to disconnect from the bus.

addSubscriptionParameters

void addSubscriptionParameters(Resource[] newParams)

When a update of registration parameters is required.

Parameters:

newParams - the new parameters to use.

removeSubscriptionParameters

void removeSubscriptionParameters(Resource[] newParams)

When a update of registration parameters is required.

Parameters:

newParams - the new parameters to use.