org.openbase.bco.authentication.lib

Class AuthenticatedServiceProcessor

java.lang.Object

org.openbase.bco.authentication.lib.AuthenticatedServiceProcessor

public class AuthenticatedServiceProcessor
extends Object

Helper class which should be used to implement an authenticated service.

Author:

Tamino Huxohl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthenticatedServiceProcessor.ConfigRetrieval<M extends com.google.protobuf.GeneratedMessage>
static interface	AuthenticatedServiceProcessor.InternalProcessable<RECEIVE extends com.google.protobuf.GeneratedMessage,RETURN extends com.google.protobuf.GeneratedMessage>
static interface	AuthenticatedServiceProcessor.InternalRequestable

Constructor Summary

Constructors

Constructor and Description
AuthenticatedServiceProcessor()

Method Summary

Modifier and Type	Method and Description
static <RECEIVE extends com.google.protobuf.GeneratedMessage,RETURN extends com.google.protobuf.GeneratedMessage> rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue	authenticatedAction(rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue authenticatedValue, Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> authorizationGroupMap, Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> locationMap, Class<RECEIVE> internalClass, AuthenticatedServiceProcessor.InternalProcessable<RECEIVE,RETURN> executable, AuthenticatedServiceProcessor.ConfigRetrieval<RECEIVE> configRetrieval) Method used by the server which performs an authenticated action which needs write permissions.
static <SEND extends com.google.protobuf.GeneratedMessage,RESPONSE extends com.google.protobuf.GeneratedMessage> Future<RESPONSE>	requestAuthenticatedAction(SEND message, Class<RESPONSE> responseClass, SessionManager sessionManager, AuthenticatedServiceProcessor.InternalRequestable internalRequestable) Method used by the remote to request an authenticated action from a server.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatedServiceProcessor

public AuthenticatedServiceProcessor()

Method Detail

authenticatedAction

public static <RECEIVE extends com.google.protobuf.GeneratedMessage,RETURN extends com.google.protobuf.GeneratedMessage> rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue authenticatedAction(rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue authenticatedValue,
                                                                                                                                                                                                                  Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> authorizationGroupMap,
                                                                                                                                                                                                                  Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> locationMap,
                                                                                                                                                                                                                  Class<RECEIVE> internalClass,
                                                                                                                                                                                                                  AuthenticatedServiceProcessor.InternalProcessable<RECEIVE,RETURN> executable,
                                                                                                                                                                                                                  AuthenticatedServiceProcessor.ConfigRetrieval<RECEIVE> configRetrieval)
                                                                                                                                                                                                           throws org.openbase.jul.exception.CouldNotPerformException,
                                                                                                                                                                                                                  InterruptedException

Method used by the server which performs an authenticated action which needs write permissions.

Type Parameters:

RECEIVE - The type of value that the server receives to perform its action,

RETURN - The type of value that the server responds with.

Parameters:

authenticatedValue - The authenticatedValue which is send with the request.

authorizationGroupMap - Map of authorization groups to verify if this action can be performed.

locationMap - Map of locations to verify if this action can be performed.

internalClass - Class of type RECEIVE needed to decrypt the received type.

executable - Interface defining the cation that the server performs.

configRetrieval - Interface defining which unitConfig should be used to verify the execution of the action.

Returns:

An AuthenticatedValue which should be send as a response.

Throws:

org.openbase.jul.exception.CouldNotPerformException - If one step can not be done, e.g. ticket invalid or encryption failed.

InterruptedException - It interrupted while checking permissions.

requestAuthenticatedAction

public static <SEND extends com.google.protobuf.GeneratedMessage,RESPONSE extends com.google.protobuf.GeneratedMessage> Future<RESPONSE> requestAuthenticatedAction(SEND message,
                                                                                                                                                                    Class<RESPONSE> responseClass,
                                                                                                                                                                    SessionManager sessionManager,
                                                                                                                                                                    AuthenticatedServiceProcessor.InternalRequestable internalRequestable)
                                                                                                                                                             throws org.openbase.jul.exception.CouldNotPerformException

Method used by the remote to request an authenticated action from a server.

Type Parameters:

SEND - The type which is send to server for this request.

RESPONSE - The type with which the server should respond.

Parameters:

message - The message which is encrypted and send to the server.

responseClass - Class of type RESPONSE to resolve internal types.

sessionManager - The session manager from which the ticket is used if a user it logged in.

internalRequestable - Interface for the internal authenticated request which is called.

Returns:

A future containing the response.

Throws:

org.openbase.jul.exception.CouldNotPerformException - If a user is logged and a ticket for the request cannot be initialized or encryption of the send message fails.