org.ametys.core.authentication.token

Class AuthenticationTokenManager.Token

java.lang.Object

org.ametys.core.authentication.token.AuthenticationTokenManager.Token

Enclosing class:

AuthenticationTokenManager

public static class AuthenticationTokenManager.Token
extends Object

An Ametys authentication token

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	_autoRenewDuration The token auto renewal duration, in seconds
protected String	_comment The token associated comment
protected String	_context The token context
protected Date	_creationDate The token creation date
protected Date	_endDate The token end date
protected Integer	_id The token identifier
protected Date	_lastUpdateDate The token last update date
protected Integer	_nbUsesLeft The token number of use left
protected String	_type The token type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Token(Integer id, String type, String comment, Date creationDate, Date endDate, Date lastUpdateDate, Integer nbUsesLeft, Long autoRenewDuration, String context) Creates a Token

Method Summary

Modifier and Type	Method and Description
Long	getAutoRenewDuration() Get the duration which the token should be automatically renewed on each use, in seconds
String	getComment() Get the associated creation comment
String	getContext() Get the context on which the token can be used
Date	getCreationDate() Get the creation date of the token
Date	getEndDate() Get the end date of the token validity
Integer	getId() Get the token identifier
Date	getLastUpdateDate() Get the last update date of the token
Integer	getNbUsesLeft() Get the number of uses allowed for this token
String	getType() Get the token type

Methods inherited from class java.lang.Object

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

Field Detail

_id

protected Integer _id

The token identifier

_type

protected String _type

The token type

_comment

protected String _comment

The token associated comment

_creationDate

protected Date _creationDate

The token creation date

_endDate

protected Date _endDate

The token end date

_lastUpdateDate

protected Date _lastUpdateDate

The token last update date

_nbUsesLeft

protected Integer _nbUsesLeft

The token number of use left

_autoRenewDuration

protected Long _autoRenewDuration

The token auto renewal duration, in seconds

_context

protected String _context

The token context

Constructor Detail

Token

protected Token(Integer id,
                String type,
                String comment,
                Date creationDate,
                Date endDate,
                Date lastUpdateDate,
                Integer nbUsesLeft,
                Long autoRenewDuration,
                String context)

Creates a Token

Parameters:

id - The identifier

type - The type of token

comment - The comment. Can be null.

creationDate - The creation date. Can be null.

endDate - The end date. Can be null.

lastUpdateDate - The last update date. Can be null.

nbUsesLeft - nb of uses left for this token (null for no limitation)

autoRenewDuration - duration that will be added (from "now") each time the token is updated

context - context of the token (ressource id for example)

Method Detail

getId

public Integer getId()

Get the token identifier

Returns:

The identifier

getType

public String getType()

Get the token type

Returns:

The type

getComment

public String getComment()

Get the associated creation comment

Returns:

The comment or null

getCreationDate

public Date getCreationDate()

Get the creation date of the token

Returns:

The creation date or null

getEndDate

public Date getEndDate()

Get the end date of the token validity

Returns:

The end date or null

getLastUpdateDate

public Date getLastUpdateDate()

Get the last update date of the token

Returns:

The last update date or null

getAutoRenewDuration

public Long getAutoRenewDuration()

Get the duration which the token should be automatically renewed on each use, in seconds

Returns:

The auto renewal duration in seconds or null if not applicable

getContext

public String getContext()

Get the context on which the token can be used

Returns:

The token context or null if not applicable

getNbUsesLeft

public Integer getNbUsesLeft()

Get the number of uses allowed for this token

Returns:

The number of allowed uses or null if not applicable