org.openbase.bco.authentication.lib.future

Class AuthenticatedActionFuture

java.lang.Object

org.openbase.bco.authentication.lib.future.AuthenticatedFuture<rst.domotic.action.ActionFutureType.ActionFuture,rst.domotic.action.ActionFutureType.ActionFuture>

org.openbase.bco.authentication.lib.future.AuthenticatedActionFuture

All Implemented Interfaces:

Future<rst.domotic.action.ActionFutureType.ActionFuture>

public class AuthenticatedActionFuture
extends AuthenticatedFuture<rst.domotic.action.ActionFutureType.ActionFuture,rst.domotic.action.ActionFutureType.ActionFuture>

AuthenticatedFuture which returns an ActionFuture and its internal Future also is of type ActionFuture.

Author:

Tamino Huxohl

Constructor Summary

Constructors

Constructor and Description
AuthenticatedActionFuture(Future<rst.domotic.action.ActionFutureType.ActionFuture> applyActionFuture, rst.domotic.authentication.TicketAuthenticatorWrapperType.TicketAuthenticatorWrapper ticketAuthenticatorWrapper) Create a new AuthenticatedActionFuture which uses the default session manager.
AuthenticatedActionFuture(Future<rst.domotic.action.ActionFutureType.ActionFuture> applyActionFuture, rst.domotic.authentication.TicketAuthenticatorWrapperType.TicketAuthenticatorWrapper ticketAuthenticatorWrapper, SessionManager sessionManager) Create a new AuthenticatedActionFuture.

Method Summary

Modifier and Type	Method and Description
protected rst.domotic.action.ActionFutureType.ActionFuture	convertFromInternal(rst.domotic.action.ActionFutureType.ActionFuture internalType) Method defining how to get the return value from the result of the internal future.
protected rst.domotic.authentication.TicketAuthenticatorWrapperType.TicketAuthenticatorWrapper	getTicketFromInternal(rst.domotic.action.ActionFutureType.ActionFuture internalType) Method defining how to get the ticket from the result of the internal future.

Methods inherited from class org.openbase.bco.authentication.lib.future.AuthenticatedFuture

cancel, get, get, getReturnClass, getSessionManager, isCancelled, isDone

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatedActionFuture

public AuthenticatedActionFuture(Future<rst.domotic.action.ActionFutureType.ActionFuture> applyActionFuture,
                                 rst.domotic.authentication.TicketAuthenticatorWrapperType.TicketAuthenticatorWrapper ticketAuthenticatorWrapper)

Create a new AuthenticatedActionFuture which uses the default session manager.

Parameters:

applyActionFuture - The internal future.

ticketAuthenticatorWrapper - The ticket which was used for the request.

AuthenticatedActionFuture

public AuthenticatedActionFuture(Future<rst.domotic.action.ActionFutureType.ActionFuture> applyActionFuture,
                                 rst.domotic.authentication.TicketAuthenticatorWrapperType.TicketAuthenticatorWrapper ticketAuthenticatorWrapper,
                                 SessionManager sessionManager)

Create a new AuthenticatedActionFuture.

Parameters:

applyActionFuture - The internal future.

ticketAuthenticatorWrapper - The ticket which was used for the request.

sessionManager - The session manager used to verify the response.

Method Detail

getTicketFromInternal

protected rst.domotic.authentication.TicketAuthenticatorWrapperType.TicketAuthenticatorWrapper getTicketFromInternal(rst.domotic.action.ActionFutureType.ActionFuture internalType)

Method defining how to get the ticket from the result of the internal future.

Specified by:

getTicketFromInternal in class AuthenticatedFuture<rst.domotic.action.ActionFutureType.ActionFuture,rst.domotic.action.ActionFutureType.ActionFuture>

Parameters:

internalType - The result from the internal future.

Returns:

The ticket inside the action future.

convertFromInternal

protected rst.domotic.action.ActionFutureType.ActionFuture convertFromInternal(rst.domotic.action.ActionFutureType.ActionFuture internalType)
                                                                        throws org.openbase.jul.exception.CouldNotPerformException

Method defining how to get the return value from the result of the internal future.

Specified by:

convertFromInternal in class AuthenticatedFuture<rst.domotic.action.ActionFutureType.ActionFuture,rst.domotic.action.ActionFutureType.ActionFuture>

Parameters:

internalType - The result from the internal future.

Returns:

The internal type.

Throws:

org.openbase.jul.exception.CouldNotPerformException - If the conversion from the internal type fails.