com.atlassian.crowd.model.token

Class InternalExpirableUserToken

java.lang.Object

com.atlassian.crowd.model.token.InternalExpirableUserToken

All Implemented Interfaces:

ExpirableUserToken, Serializable

public final class InternalExpirableUserToken
extends Object
implements Serializable, ExpirableUserToken

Represent a token that can expire for a user

Since:

v2.8

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static InternalExpirableUserToken	createChangeEmailToken(String token, String username, String newEmailAddress, long expiryDate, long directoryId)
static InternalExpirableUserToken	createInviteUserToken(String token, String email, long expiryDate, long directoryId)
static InternalExpirableUserToken	createResetPasswordToken(String token, String username, String email, long expiryDate, long directoryId)
boolean	equals(Object o)
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.
long	getId()
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.
int	hashCode()
void	setType(ExpirableUserTokenType type)

Methods inherited from class java.lang.Object

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

Method Detail

createResetPasswordToken

public static InternalExpirableUserToken createResetPasswordToken(String token,
                                                                  String username,
                                                                  String email,
                                                                  long expiryDate,
                                                                  long directoryId)

createInviteUserToken

public static InternalExpirableUserToken createInviteUserToken(String token,
                                                               String email,
                                                               long expiryDate,
                                                               long directoryId)

createChangeEmailToken

public static InternalExpirableUserToken createChangeEmailToken(String token,
                                                                String username,
                                                                String newEmailAddress,
                                                                long expiryDate,
                                                                long directoryId)

getId

public long getId()

getToken

public String getToken()

Description copied from interface: ExpirableUserToken

A unique token.

Specified by:

getToken in interface ExpirableUserToken

Returns:

the token

getUsername

@Nullable
public String getUsername()

Description copied from interface: ExpirableUserToken

A username that can be associated with the token.

Specified by:

getUsername in interface ExpirableUserToken

Returns:

a username or null

getEmailAddress

@Nullable
public String getEmailAddress()

Description copied from interface: ExpirableUserToken

An email address that can be associated with the token.

Specified by:

getEmailAddress in interface ExpirableUserToken

Returns:

an email address or null

getExpiryDate

public long getExpiryDate()

Description copied from interface: ExpirableUserToken

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

Specified by:

getExpiryDate in interface ExpirableUserToken

Returns:

a date

getDirectoryId

public long getDirectoryId()

Description copied from interface: ExpirableUserToken

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.

Specified by:

getDirectoryId in interface ExpirableUserToken

Returns:

the ID of the directory associated with the token

getType

public ExpirableUserTokenType getType()

Description copied from interface: ExpirableUserToken

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

Specified by:

getType in interface ExpirableUserToken

setType

public void setType(ExpirableUserTokenType type)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object