org.universAAL.ri.gateway.proxies.exporting

Class ProxySCaller

java.lang.Object

org.universAAL.middleware.bus.member.BusMember

org.universAAL.middleware.bus.member.Caller

org.universAAL.middleware.service.ServiceCaller

org.universAAL.ri.gateway.proxies.exporting.ProxySCaller

All Implemented Interfaces:

ProxyBusMember

public class ProxySCaller
extends ServiceCaller
implements ProxyBusMember

Proxy that receives ServiceCalls and injects them to the bus in other to get a ServiceResponse from the represented ServiceCallee.
An instance of this proxy is used per each exported ServiceCallee.
Important: this class is not a BusMember, like the other proxies; thus it does not register to buses.

Author:

amedrano

Field Summary

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

busResourceURI, owner, theBus

Constructor Summary

Constructors

Constructor and Description
ProxySCaller(ModuleContext context, ServiceProfile[] profiles, String proxiedBusMember) Constructor.

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() Unregisters the Subscriber from the bus.
void	communicationChannelBroken() This abstract method is called for each member of the bus when the bus is being stopped.
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.
void	handleResponse(String reqID, ServiceResponse response) Will be called automatically in a new thread whenever the response corresponding to a previous call to ServiceCaller.sendRequest(ServiceRequest) is ready.
boolean	isCompatible(Resource[] registrationParameters) A single ProxySCaller is able to manage all ProxySCallees; thus the first registered ProxySCaller is the one that is compatible, and represents all ServiceCallers.
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.service.ServiceCaller

addAvailabilitySubscription, busDyingOut, call, call, getAllServices, getMatchingService, getMatchingService, getMatchingService, getMyID, handleReply, inject, inject, removeAvailabilitySubscription, sendCall, sendCall, sendRequest

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

getComment, getLabel, getType, getURI, setComment, setLabel

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxySCaller

public ProxySCaller(ModuleContext context,
                    ServiceProfile[] profiles,
                    String proxiedBusMember)

Constructor.

Parameters:

context -

profiles -

proxiedBusMember -

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)

A single ProxySCaller is able to manage all ProxySCallees; thus the first registered ProxySCaller is the one that is compatible, and represents all ServiceCallers.

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.

close

public void close()

Unregisters the Subscriber from the bus.

Specified by:

close in interface ProxyBusMember

Overrides:

close in class BusMember

communicationChannelBroken

public void communicationChannelBroken()

Description copied from class: ServiceCaller

This abstract method is called for each member of the bus when the bus is being stopped.

Specified by:

communicationChannelBroken in class ServiceCaller

handleResponse

public void handleResponse(String reqID,
                           ServiceResponse response)

Description copied from class: ServiceCaller

Will be called automatically in a new thread whenever the response corresponding to a previous call to ServiceCaller.sendRequest(ServiceRequest) is ready.

Specified by:

handleResponse in class ServiceCaller

Parameters:

reqID - the ID returned by the previous call to ServiceCaller.sendRequest(ServiceRequest).

response - the expected response.