org.universAAL.ri.api.manager.server.persistence

Interface Persistence

All Known Implementing Classes:

PersistenceDerby, PersistenceMySQL

public interface Persistence

Database interface for persisting the calls from clients. This allows clients not having to re-send their subscriptions or registers when the server goes down. The persistence operates only at the level of the requests by the clients, not the actual nodes and wrappers in MW. These will go up and down together with the manager bundle. It is better to see this as a persistence for when the bundle is down, rather than the whole server. Only information about registration, context subscribers and service callees is persisted for the remote nodes. Context events and service calls are not persisted since they are "consumed" as they come.

Author:

alfiva

Method Summary

Modifier and Type	Method and Description
boolean	checkUser(String user) Check if a user is already persisted with an associated password pair.
boolean	checkUserPWD(String user, String pwd) Method that checks the proper authentication of a persisted user-password pair.
void	init(RemoteAPI remoteAPI, ModuleContext context) Sets up the underlying database, creating any tables if not present before, and performing any mainenance operations.
void	removeRegister(String id) Eliminate all persisted info (node registration, subscribers and callees) of a remote node
void	restore() Restore in the R-API implementation (and consequently in the MW) all the persisted information (registration, subscribers and callees) for all nodes.
void	storeCallee(String id, String profile) Persist a request to have a service callee for a node
void	storeRegister(String id, String remote, String v) Persist a request to have a registration of a remote node
void	storeSubscriber(String id, String pattern) Persist a request to have a context subscriber for a node
void	storeUserPWD(String user, String pwd) Store a new user-password pair for later authentication.

Method Detail

init

void init(RemoteAPI remoteAPI,
          ModuleContext context)

Sets up the underlying database, creating any tables if not present before, and performing any mainenance operations.

Parameters:

remoteAPI - The Remote API instance being used in the manager

context - Module Context of universAAL

storeRegister

void storeRegister(String id,
                   String remote,
                   String v)

Persist a request to have a registration of a remote node

Parameters:

id - The id used to uniquely identify the remote node

remote - The remote access information for a remote node

v - The version of client invoking the API. Descriptive only. Can be null.

removeRegister

void removeRegister(String id)

Eliminate all persisted info (node registration, subscribers and callees) of a remote node

Parameters:

id - The id used to uniquely identify the remote node

storeSubscriber

void storeSubscriber(String id,
                     String pattern)

Persist a request to have a context subscriber for a node

Parameters:

id - The id used to uniquely identify the remote node

pattern - The serialized ContextEventPattern sent by the remote node in the request

storeCallee

void storeCallee(String id,
                 String profile)

Persist a request to have a service callee for a node

Parameters:

id - The id used to uniquely identify the remote node

profile - The serialized ServiceProfile sent by the remote node in the request

restore

void restore()

Restore in the R-API implementation (and consequently in the MW) all the persisted information (registration, subscribers and callees) for all nodes.

storeUserPWD

void storeUserPWD(String user,
                  String pwd)

Store a new user-password pair for later authentication. There is no "change" method for this, so any change will require manual modification of the persistence.

Parameters:

user - User

pwd - Password

checkUserPWD

boolean checkUserPWD(String user,
                     String pwd)

Method that checks the proper authentication of a persisted user-password pair.

Parameters:

user - User

pwd - Password

Returns:

true if pwd matches the initially stored value and no errors occured

checkUser

boolean checkUser(String user)

Check if a user is already persisted with an associated password pair.

Parameters:

user - to check

Returns:

true if there is already a user-password pair persisted.