org.universAAL.ri.api.manager

Class RemoteUAAL

java.lang.Object

org.universAAL.utilities.api.UAAL

org.universAAL.ri.api.manager.RemoteUAAL

public class RemoteUAAL
extends UAAL

Extension of the Utility API UAAL helper class that adds a few small tweaks to acomodate remote node information.

Author:

alfiva

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RemoteUAAL.CListener Custom ICListener to be used in the sendC() method of the Utility API.
class	RemoteUAAL.SListener Custom ISListener to be used in the callS() method of the Utility API.

Constructor Summary

Constructors

Constructor and Description
RemoteUAAL(ModuleContext context, String node, String remote, String key) Basic constructor.

Method Summary

Modifier and Type	Method and Description
ICListener	createCListener(String uri) Use this method to create a Listener to be used in the sendC() method of the Utility API, instead of creating it ex profeso.
ISListener	createSListener(String uri) Use this method to create a Listener to be used in the callS() method of the Utility API, instead of creating it ex profeso.
List<String>	getCEPsList() Get the list of context event patterns of subscribers registered so far.
String	getKey() Get the client remote node encryption key to use for GCM
String	getRemoteID() Get the client remote node endpoint information.
List<String>	getSProfilesList() Get the list of service profiles of callees registered so far.
boolean	isPatternAdded(String uri)
boolean	isProfileAdded(String uri)
void	provideS(ServiceProfile[] p, ISListener l) Registers Service Profiles and specifies how the calls to these profiles would be handled.
void	setRemoteID(String remote, String key) Set the client remote node endpoint information.
void	subscribeC(ContextEventPattern[] p, ICListener l) Subscribes for Context Events and specifies how the events would be handled.
void	terminate() Closes all universAAL wrapper classes created by this universAAL helper until now (by calling their .close() method) and eliminates them.

Methods inherited from class org.universAAL.utilities.api.UAAL

callS, requestUI, sendC

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteUAAL

public RemoteUAAL(ModuleContext context,
                  String node,
                  String remote,
                  String key)

Basic constructor. Use this one instead of the UAAL one.

Parameters:

context - The universAAL context

node - The client remote node unique identifier

remote - The client remote node endpoint information.

key - encryption key to use for GCM, or null if it does not apply

Method Detail

getCEPsList

public List<String> getCEPsList()

Get the list of context event patterns of subscribers registered so far.

Returns:

The list of URIs of context event patterns of subscribers

getSProfilesList

public List<String> getSProfilesList()

Get the list of service profiles of callees registered so far.

Returns:

The list of URIs of service profiles of callees

subscribeC

public void subscribeC(ContextEventPattern[] p,
                       ICListener l)

Description copied from class: UAAL

Subscribes for Context Events and specifies how the events would be handled.

universAAL helper automatically creates a new own internal Context Subscriber each time this method is called. An implementation of ICListener must be passed that will handle the reception of an event that matches the passed patterns. The listener is associated to the patterns: All events that match the patterns are received by the listener (regardless of any other calls to this method). The listener remains active and associated to the patterns until terminate() is called. Since every call to this method creates a new subscriber, you should be careful with how many times you call this method. Usually, a limited number of subscriptions is needed. Remember that you can combine different patterns to be handled by a single listener.

Remember that the simplified API in this library ( org.universAAL.utilities.api.context packages) can assist you in creating Context Event Patterns.

Overrides:

subscribeC in class UAAL

Parameters:

p - An array of Context Event Patterns describing the Context Events that will be handled by the listener.

l - The listener that will handle the received event that matches the patterns.

See Also:

Pattern

isPatternAdded

public boolean isPatternAdded(String uri)

provideS

public void provideS(ServiceProfile[] p,
                     ISListener l)

Description copied from class: UAAL

Registers Service Profiles and specifies how the calls to these profiles would be handled.

universAAL helper automatically creates a new own internal Service Callee each time this method is called. An implementation of ISListener must be passed that will handle the call request that matches the provided profiles. The listener is associated to the profiles: All call requests that match the profiles are received by the listener (regardless of any other calls to this method). The listener remains active and associated to the profiles until terminate() is called. Since every call to this method creates a new callee, you should be careful with how many times you call this method. Usually, a limited number of callees is needed.

Remember that the simplified API in this library ( org.universAAL.utilities.api.service packages) can assist you in creating Service Profiles.

Overrides:

provideS in class UAAL

Parameters:

p - An array of Service Profiles describing the provided services that will be handled by the listener.

l - The listener that will handle the received call request that matches the provided service profiles.

See Also:

Profile

isProfileAdded

public boolean isProfileAdded(String uri)

terminate

public void terminate()

Description copied from class: UAAL

Closes all universAAL wrapper classes created by this universAAL helper until now (by calling their .close() method) and eliminates them. The reference to the Module Context is maintained, however. This allows to perform new calls to the universAAL features methods, which will create new universAAL wrappers in the helper.

Overrides:

terminate in class UAAL

getRemoteID

public String getRemoteID()

Get the client remote node endpoint information.

Returns:

remote endpoint.

getKey

public String getKey()

Get the client remote node encryption key to use for GCM

Returns:

encryption key to use for GCM, or null if it does not apply

setRemoteID

public void setRemoteID(String remote,
                        String key)

Set the client remote node endpoint information.

Parameters:

remote - endpoint.

key - encryption key to use for GCM, or null if it does not apply

createCListener

public ICListener createCListener(String uri)

Use this method to create a Listener to be used in the sendC() method of the Utility API, instead of creating it ex profeso.

Parameters:

uri - The URI of the context event pattern being used for this listener

Returns:

A ICListener

createSListener

public ISListener createSListener(String uri)

Use this method to create a Listener to be used in the callS() method of the Utility API, instead of creating it ex profeso.

Parameters:

uri - The URI of the service profile being used for this listener

Returns:

A ISListener