Package org.jivesoftware.openfire.auth

Class AuthToken

java.lang.Object

org.jivesoftware.openfire.auth.AuthToken

Direct Known Subclasses:

AuthToken.OneTimeAuthToken

public class AuthToken
extends Object

A token that proves that a user has successfully authenticated.

Author:

Matt Tucker

See Also:

AuthFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthToken.OneTimeAuthToken	A token that proves that a user uses a one time access token.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AuthToken(String jid)	Constructs a new AuthToken with the specified username.

Method Summary

Modifier and Type	Method	Description
static AuthToken	generateAnonymousToken()	Constructs a new AuthToken that represents an authenticated, but anonymous user.
static AuthToken	generateOneTimeToken(String token)	Constructs a new OneTimeAuthToken that represents an one time recovery user.
static AuthToken	generateUserToken(String username)	Constructs a new AuthToken that represents an authenticated user identified by the provider username.
String	getUsername()	Returns the username associated with this AuthToken.
boolean	isAnonymous()	Returns true if this AuthToken is the Anonymous auth token.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthToken

protected AuthToken(String jid)

Constructs a new AuthToken with the specified username. The username can be either a simple username or a full JID.

Parameters:

jid - the username or bare JID to create an authToken token with.

Method Detail

generateUserToken

public static AuthToken generateUserToken(String username)

Constructs a new AuthToken that represents an authenticated user identified by the provider username.

Parameters:

username - the username to create an authToken token with.

Returns:

the auth token for the user

generateAnonymousToken

public static AuthToken generateAnonymousToken()

Constructs a new AuthToken that represents an authenticated, but anonymous user.

Returns:

an anonymouse auth token

generateOneTimeToken

public static AuthToken generateOneTimeToken(String token)

Constructs a new OneTimeAuthToken that represents an one time recovery user.

Parameters:

token - the one time token.

Returns:

the newly generated auth token

getUsername

public String getUsername()

Returns the username associated with this AuthToken. A null value means that the authenticated user is anonymous.

Returns:

the username associated with this AuthToken or null when using an anonymous user.

isAnonymous

public boolean isAnonymous()

Returns true if this AuthToken is the Anonymous auth token.

Returns:

true if this token is the anonymous AuthToken.