com.tenduke.fileplus.impl

Class DefaultTicketEngine

java.lang.Object

com.tenduke.fileplus.impl.DefaultTicketEngine

All Implemented Interfaces:

TicketEngine

public class DefaultTicketEngine
extends Object
implements TicketEngine

Application logics implementation class that defines ticket generation, consumption, revoking and delete functions. A new instance of this class should be created in relation to each ticket request.

Author:

frej

Constructor Summary

Constructors

Constructor and Description
DefaultTicketEngine(com.tenduke.sdk2.api.security.Actor actor, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Initializes a new instance of the TicketEngine class.

Method Summary

Modifier and Type	Method and Description
<T extends AbstractTicket> TicketConsumptionResult<T>	consume(String ticketKey) Consumes a ticket.
<T extends AbstractTicket> TicketConsumptionResult<T>	consume(String ticketKey, Class<T> ticketClass) Consumes a ticket.
<T extends AbstractTicket> TicketConsumptionResult<T>	consume(T ticket) Consumes a ticket.
<T extends AbstractTicket> T	createTicket(com.tenduke.sdk2.objectmodel.identity.Account account, String path1, String path2, Long allowedConsumption, Boolean isPrivate, Class<T> ticketClass) Generates new upload ticket for owner account.
protected String	generateTicketKey(com.tenduke.sdk2.objectmodel.identity.Account account, String claim) Generates new unique key for a ticket.
protected String	getAccountRootPath(com.tenduke.sdk2.objectmodel.identity.Account account) Gets account's root path used by storage.
<T extends AbstractTicket> List<T>	resolvePrivateTickets(String path1, String path2, Class<T> ticketClass) Resolves tickets associated with a file entry.
protected String	resolveSalt(com.tenduke.sdk2.objectmodel.identity.Account account) Resolves salt for signing ticket.
protected Class<? extends AbstractTicket>	resolveTicketClass(String ticketClassName) Resolves ticket class based on given simple name.
Class<? extends AbstractTicket>	resolveTicketClassByTickeyKey(String ticketKey) Resolves ticket class based on given simple name.
protected String	resolveTicketSaltIdx(com.tenduke.sdk2.objectmodel.identity.Account account) Resolves ticket salt reference.
void	revokeTicket(AbstractTicket ticket) Revokes a ticket.
void	revokeTicket(String ticketKey) Revokes a ticket.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTicketEngine

public DefaultTicketEngine(com.tenduke.sdk2.api.security.Actor actor,
                           Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)

Initializes a new instance of the TicketEngine class.

Parameters:

actor - The effective actor using this ticket engine.

permissionGrants - Permission grants used to authorize operations with AuthorityChecker.

Method Detail

createTicket

public <T extends AbstractTicket> T createTicket(com.tenduke.sdk2.objectmodel.identity.Account account,
                                                 String path1,
                                                 String path2,
                                                 Long allowedConsumption,
                                                 Boolean isPrivate,
                                                 Class<T> ticketClass)

Generates new upload ticket for owner account. Ticket is stored and returned to the caller.

Specified by:

createTicket in interface TicketEngine

Type Parameters:

T - Type of ticket.

Parameters:

account - The owner account that grants ticket for upload.

path1 - Path 1 claim that ticket is about.

path2 - Path 2 claim that ticket is about.

allowedConsumption - The allowed number of requests that this ticket authorizes. If null then value 1 is used as default.

isPrivate - Private flag value to set for ticket. See AbstractTicket.getIsPrivate().

ticketClass - Type of ticket.

Returns:

The resulting ticket.

consume

public <T extends AbstractTicket> TicketConsumptionResult<T> consume(String ticketKey)

Consumes a ticket.

Specified by:

consume in interface TicketEngine

Type Parameters:

T - Type of ticket.

Parameters:

ticketKey - Key that identifies the ticket to consume.

Returns:

Consumption result.

consume

public <T extends AbstractTicket> TicketConsumptionResult<T> consume(String ticketKey,
                                                                     Class<T> ticketClass)

Consumes a ticket.

Specified by:

consume in interface TicketEngine

Type Parameters:

T - Type of ticket.

Parameters:

ticketKey - Key that identifies the ticket to consume.

ticketClass - Type of ticket.

Returns:

Consumption result.

consume

public <T extends AbstractTicket> TicketConsumptionResult<T> consume(T ticket)

Consumes a ticket.

Specified by:

consume in interface TicketEngine

Type Parameters:

T - Type of ticket.

Parameters:

ticket - ticket to consume.

Returns:

Consumption result.

revokeTicket

public void revokeTicket(String ticketKey)

Revokes a ticket.

Specified by:

revokeTicket in interface TicketEngine

Parameters:

ticketKey - Key that identifies the ticket.

revokeTicket

public void revokeTicket(AbstractTicket ticket)

Revokes a ticket.

Specified by:

revokeTicket in interface TicketEngine

Parameters:

ticket - Ticket to revoke. Null allowed, which will have no side effects.

resolveTicketClassByTickeyKey

public Class<? extends AbstractTicket> resolveTicketClassByTickeyKey(String ticketKey)

Resolves ticket class based on given simple name.

Specified by:

resolveTicketClassByTickeyKey in interface TicketEngine

Parameters:

ticketKey - Ticket key to use for resolving ticket class.

Returns:

Ticket class or null if name is not recognized.

resolvePrivateTickets

public <T extends AbstractTicket> List<T> resolvePrivateTickets(String path1,
                                                                String path2,
                                                                Class<T> ticketClass)

Resolves tickets associated with a file entry.

Specified by:

resolvePrivateTickets in interface TicketEngine

Type Parameters:

T - Type of ticket.

Parameters:

path1 - Required value of AbstractTicket.getPath1() to match.

path2 - Required value of AbstractTicket.getPath2() to match.

ticketClass - Class of ticket to resolve.

Returns:

List of private tickets found for the given path arguments.

getAccountRootPath

protected String getAccountRootPath(com.tenduke.sdk2.objectmodel.identity.Account account)

Gets account's root path used by storage.

Parameters:

account - Account who's root path is requested. Null account is allowed as argument (implies system).

Returns:

account's root path used by storage. Null account implies system and will result in empty string.

resolveTicketClass

protected Class<? extends AbstractTicket> resolveTicketClass(String ticketClassName)

Resolves ticket class based on given simple name.

Parameters:

ticketClassName - Simple name of ticket type.

Returns:

Ticket class or null if name is not recognized.

generateTicketKey

protected String generateTicketKey(com.tenduke.sdk2.objectmodel.identity.Account account,
                                   String claim)

Generates new unique key for a ticket.

Parameters:

account - Account that authorizes ticket.

claim - that ticket request is about.

Returns:

new ticket key.

resolveSalt

protected String resolveSalt(com.tenduke.sdk2.objectmodel.identity.Account account)

Resolves salt for signing ticket.

Parameters:

account - Account that authorizes ticket.

Returns:

Salt to use when signing ticket.

resolveTicketSaltIdx

protected String resolveTicketSaltIdx(com.tenduke.sdk2.objectmodel.identity.Account account)

Resolves ticket salt reference.

Parameters:

account - Account that authorizes ticket.

Returns:

Salt reference.