RemoteAPI (universAAL Super POM 3.4.2-SNAPSHOT API)

All Known Implementing Classes:

RemoteAPIImpl
```
public interface RemoteAPI
```
Interface that defines the methods of the Remote API, that will be available through the server HTTP endpoint, according to the R-API documentation.

Author:

alfiva

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FLAG_TURTLE` Delimiter in a HTTP response to indicate the serialized ontological result in turtle starts in the next line
`static String`	`KEY_AUTH` Parameter in the HTTP request for the authorization identification
`static String`	`KEY_CALL` Parameter in a HTTP response for a ServiceCall URI
`static String`	`KEY_METHOD` Parameter in the HTTP request for the method identification
`static String`	`KEY_PARAM` Parameter in the HTTP request for the main parameter of the method
`static String`	`KEY_STATUS` Parameter in a HTTP response for a ServiceCall status
`static String`	`KEY_TO` Parameter in the HTTP request for the identification of the addressee
`static String`	`KEY_VERSION` Parameter in the HTTP request (optional) for the version of the client
`static String`	`METHOD_CALLS` Value for CALLS method parameter in the HTTP request
`static String`	`METHOD_PROVIDES` Value for PROVIDES method parameter in the HTTP request
`static String`	`METHOD_REGISTER` Value for REGISTER method parameter in the HTTP request
`static String`	`METHOD_RESPONSES` Value for RESPONSE method parameter in the HTTP request
`static String`	`METHOD_SENDC` Value for SENDC method parameter in the HTTP request
`static String`	`METHOD_SUBSCRIBEC` Value for SUBSCRIBEC method parameter in the HTTP request
`static String`	`METHOD_UNREGISTER` Value for UNREGISTER method parameter in the HTTP request
`static int`	`REMOTE_GCM` Identifier for remote endpoints using Google Cloud Messaging
`static int`	`REMOTE_POST` Identifier for remote endpoints using HTTP POST
`static int`	`REMOTE_UNKNOWN` Identifier for remote endpoints using unknown protocols

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`callS(String id, String srequest)` Calls a Service with a Service Request.
`String`	`getCryptKey(String id)` Get the encryption key to use to encrypt messages via GCM if proceeds.
`void`	`provideS(String id, String sprofile)` Registers a Service Profile.
`String`	`register(String id, String remote)` Register a client remote node in the server.
`void`	`sendC(String id, String cevent)` Sends a Context Event.
`void`	`subscribeC(String id, String cpattern)` Subscribes for Context Events.
`void`	`unregister(String id)` Unregister a client remote node in the server.
`void`	`unregisterAll()` Unregister all the client remote node in the server.

- Field Detail
  - METHOD_REGISTER
```
static final String METHOD_REGISTER
```
    Value for REGISTER method parameter in the HTTP request
    
    See Also:
    
    Constant Field Values
  - METHOD_SENDC
```
static final String METHOD_SENDC
```
    Value for SENDC method parameter in the HTTP request
    
    See Also:
    
    Constant Field Values
  - METHOD_SUBSCRIBEC
```
static final String METHOD_SUBSCRIBEC
```
    Value for SUBSCRIBEC method parameter in the HTTP request
    
    See Also:
    
    Constant Field Values
  - METHOD_CALLS
```
static final String METHOD_CALLS
```
    Value for CALLS method parameter in the HTTP request
    
    See Also:
    
    Constant Field Values
  - METHOD_PROVIDES
```
static final String METHOD_PROVIDES
```
    Value for PROVIDES method parameter in the HTTP request
    
    See Also:
    
    Constant Field Values
  - METHOD_UNREGISTER
```
static final String METHOD_UNREGISTER
```
    Value for UNREGISTER method parameter in the HTTP request
    
    See Also:
    
    Constant Field Values
  - METHOD_RESPONSES
```
static final String METHOD_RESPONSES
```
    Value for RESPONSE method parameter in the HTTP request
    
    See Also:
    
    Constant Field Values
  - KEY_AUTH
```
static final String KEY_AUTH
```
    Parameter in the HTTP request for the authorization identification
    
    See Also:
    
    Constant Field Values
  - KEY_METHOD
```
static final String KEY_METHOD
```
    Parameter in the HTTP request for the method identification
    
    See Also:
    
    Constant Field Values
  - KEY_PARAM
```
static final String KEY_PARAM
```
    Parameter in the HTTP request for the main parameter of the method
    
    See Also:
    
    Constant Field Values
  - KEY_VERSION
```
static final String KEY_VERSION
```
    Parameter in the HTTP request (optional) for the version of the client
    
    See Also:
    
    Constant Field Values
  - KEY_TO
```
static final String KEY_TO
```
    Parameter in the HTTP request for the identification of the addressee
    
    See Also:
    
    Constant Field Values
  - KEY_STATUS
```
static final String KEY_STATUS
```
    Parameter in a HTTP response for a ServiceCall status
    
    See Also:
    
    Constant Field Values
  - KEY_CALL
```
static final String KEY_CALL
```
    Parameter in a HTTP response for a ServiceCall URI
    
    See Also:
    
    Constant Field Values
  - FLAG_TURTLE
```
static final String FLAG_TURTLE
```
    Delimiter in a HTTP response to indicate the serialized ontological result in turtle starts in the next line
    
    See Also:
    
    Constant Field Values
  - REMOTE_POST
```
static final int REMOTE_POST
```
    Identifier for remote endpoints using HTTP POST
    
    See Also:
    
    Constant Field Values
  - REMOTE_GCM
```
static final int REMOTE_GCM
```
    Identifier for remote endpoints using Google Cloud Messaging
    
    See Also:
    
    Constant Field Values
  - REMOTE_UNKNOWN
```
static final int REMOTE_UNKNOWN
```
    Identifier for remote endpoints using unknown protocols
    
    See Also:
    
    Constant Field Values
- Method Detail
  - register
```
String register(String id,
                String remote)
         throws Exception
```
    Register a client remote node in the server.
    This method must be called once before any other method. Subsequent calls will only update the remote endpoint reference, not restart the registration.
    
    Parameters:
    
    id - The token that uniquely identifies the client remote node
    
    remote - Identifies the client endpoint where the push responses and callbacks will be sent by the server
    
    Returns:
    
    The encryption key used to encrypt GCM messages, or null if this does not apply
    
    Throws:
    
    Exception - If any problem arose during the registration and it was not successful
  - sendC
```
void sendC(String id,
           String cevent)
    throws Exception
```
    Sends a Context Event.
    The server will automatically create a Context Publisher if this is the first time the method is called. If the passed event contains ContextProvider information, it is used to instantiate the Publisher. Otherwise the missing information is automatically generated: The Publisher is described as either a Gauge or a Controller depending on if you are providing Services (you called method PROVIDES before). The URI of the Provider is then set to http://ontology.universAAL.org/SimpleUAAL .owl#ContextEventsProvider and it cannot be changed. The pattern that describes the provided events of this provider is empty, which means it can publish any type of event. Notice this Provider info is set ONLY THE FIRST TIME and cannot be changed by later calls.
    
    Parameters:
    
    id - The token that uniquely identifies the client remote node
    
    cevent - The serialized ContextEvent
    
    Throws:
    
    Exception - If it was not possible to send the event
  - subscribeC
```
void subscribeC(String id,
                String cpattern)
         throws Exception
```
    Subscribes for Context Events.
    The server will automatically create a new Context Subscriber each time this method is called. All Context Events that match the pattern will be sent back to the client endpoint. 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 subscriber.
    
    Parameters:
    
    id - The token that uniquely identifies the client remote node
    
    cpattern - The serialized ContextEventPattern
    
    Throws:
    
    Exception - If it was not possible to subscribe to the events
  - callS
```
String callS(String id,
             String srequest)
      throws Exception
```
    Calls a Service with a Service Request.
    The server will automatically create an internal Default Service Caller if this is the first time the method is called. The call to the service is synchronous: this method returns the response of the call straight from Service Bus.
    
    Parameters:
    
    id - The token that uniquely identifies the client remote node
    
    srequest - The serialized ServiceRequest
    
    Returns:
    
    The serialized ServiceResponse
    
    Throws:
    
    Exception - If it was not possible to issue the request
  - provideS
```
void provideS(String id,
              String sprofile)
       throws Exception
```
    Registers a Service Profile.
    The server will automatically create a new Service Callee each time this method is called. All ServiceCalls addressed to this profile will be sent back to the client endpoint. 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.
    
    Parameters:
    
    id - The token that uniquely identifies the client remote node
    
    sprofile - The serialized ServiceProfile
    
    Throws:
    
    Exception - If it was not possible to register the profile
  - unregister
```
void unregister(String id)
         throws Exception
```
    Unregister a client remote node in the server.
    It frees all associated resources allocated to the client by previous calls. No callbacks will be sent to the client endpoint after this, and no further method calls will be allowed.
    
    Parameters:
    
    id - The token that uniquely identifies the client remote node
    
    Throws:
    
    Exception - If it was not possible to unregister the client
  - unregisterAll
```
void unregisterAll()
```
    Unregister all the client remote node in the server.
    This is only for use when the Remote API module is shutting down. It frees all associated resources allocated to the all client by previous calls. No callbacks will be sent to the client endpoint after this, and no further method calls will be allowed. This avoids universAAL wrappers being kept running in the MW when there is no one to answer to them. Unlike unregister(), it does not throw Exception: if a node fails to be unregistered, an error is logged and it continues with the rest.
  - getCryptKey
```
String getCryptKey(String id)
```
    Get the encryption key to use to encrypt messages via GCM if proceeds.
    
    Parameters:
    
    id - The token that uniquely identifies the client remote node
    
    Returns:
    
    The encryption key or null if it does not apply.

Interface RemoteAPI

Field Summary

Method Summary

Field Detail

METHOD_REGISTER

METHOD_SENDC

METHOD_SUBSCRIBEC

METHOD_CALLS

METHOD_PROVIDES

METHOD_UNREGISTER

METHOD_RESPONSES

KEY_AUTH

KEY_METHOD

KEY_PARAM

KEY_VERSION

KEY_TO

KEY_STATUS

KEY_CALL

FLAG_TURTLE

REMOTE_POST

REMOTE_GCM

REMOTE_UNKNOWN

Method Detail

register

sendC

subscribeC

callS

provideS

unregister

unregisterAll

getCryptKey