com.atlassian.crowd.model.token

Interface ExpirableUserToken

All Known Implementing Classes:

InternalExpirableUserToken

public interface ExpirableUserToken

This represents a token with a limited lifetime, associated with a user (by email address and/or username).

This can be used for instance for an invite user token. Actual token type is specified by ExpirableUserTokenType

Since:

v2.8

Method Summary

Modifier and Type	Method and Description
long	getDirectoryId() The ID of the directory associated with the token.
String	getEmailAddress() An email address that can be associated with the token.
long	getExpiryDate() The date at which the token expires, in millis since the epoch.
String	getToken() A unique token.
ExpirableUserTokenType	getType() Type of the token, specifying with what feature in Crowd a given token is associated.
String	getUsername() A username that can be associated with the token.

Method Detail

getToken

String getToken()

A unique token.

Returns:

the token

getUsername

@Nullable
String getUsername()

A username that can be associated with the token.

Returns:

a username or null

getEmailAddress

@Nullable
String getEmailAddress()

An email address that can be associated with the token.

Returns:

an email address or null

getExpiryDate

long getExpiryDate()

The date at which the token expires, in millis since the epoch.

Returns:

a date

getDirectoryId

long getDirectoryId()

The ID of the directory associated with the token. This can be used, for instance, to know in which directory to create an invited user.

Returns:

the ID of the directory associated with the token

getType

ExpirableUserTokenType getType()

Type of the token, specifying with what feature in Crowd a given token is associated.

Since:

4.4.0