net.krotscheck.kangaroo.authz.common.database.entity

Class OAuthToken

java.lang.Object

net.krotscheck.kangaroo.common.hibernate.entity.AbstractEntity

net.krotscheck.kangaroo.authz.common.database.entity.AbstractAuthzEntity

net.krotscheck.kangaroo.authz.common.database.entity.OAuthToken

All Implemented Interfaces:

Cloneable, Principal, ICreatedDateEntity, IModifiedDateEntity

@Entity
 @Indexed(index="oauth_tokens")
 @Analyzer(definition="entity_analyzer")
public final class OAuthToken
extends AbstractAuthzEntity
implements Principal

This entity represents an OAuth Token, provided to a user, for a specific application, on a particular client's domain.

Author:

Michael Krotscheck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuthToken.Deserializer Deserialize a reference to an OAuthToken.

Constructor Summary

Constructors

Constructor and Description
OAuthToken()

Method Summary

Modifier and Type	Method and Description
OAuthToken	getAuthToken() Retrieve the oauth token for this refresh token.
Client	getClient() Retrieve the client for whom this token is valid.
Long	getExpiresIn() Get the token lifetime, in seconds.
HttpSession	getHttpSession() Get the attached HTTP Session.
UserIdentity	getIdentity() Get the user identity to which this token was issued.
String	getIssuer() Get the issuer.
String	getName() Returns the name of this principal.
User	getOwner() The owner of this entity.
URI	getRedirect() Get the redirect attached to this token.
SortedMap<String,ApplicationScope>	getScopes() Get this token's scopes.
OAuthTokenType	getTokenType() Get the token type.
boolean	isExpired() This method returns true if the created time, plus the expiration seconds, is less than the current time.
void	setAuthToken(OAuthToken authToken) Set the new parent auth token (for refresh tokens only).
void	setClient(Client client) Set the client for whom this token is valid.
void	setExpiresIn(int expiresIn) Set the expiration time, in seconds, from the creation date.
void	setExpiresIn(long expiresIn) Set the expiration time, in seconds, from the creation date.
void	setExpiresIn(Number expiresIn) Set the expiration time, in seconds, from the creation date.
void	setHttpSession(HttpSession httpSession) Set the attached HTTP Session.
void	setIdentity(UserIdentity identity) Set the user identity to whom this token was issued.
void	setIssuer(String issuer) Set the URL of the server that issued this token.
void	setRedirect(URI redirect) Set the redirect for this particular token.
void	setScopes(SortedMap<String,ApplicationScope> scopes) Set this token's scopes.
void	setTokenType(OAuthTokenType tokenType) Set the token type.

Methods inherited from class net.krotscheck.kangaroo.common.hibernate.entity.AbstractEntity

clone, equals, getCreatedDate, getId, getModifiedDate, hashCode, setCreatedDate, setId, setModifiedDate, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Constructor Detail

OAuthToken

public OAuthToken()

Method Detail

getIssuer

public String getIssuer()

Get the issuer.

Returns:

The URL of the server that issued this token.

setIssuer

public void setIssuer(String issuer)

Set the URL of the server that issued this token.

Parameters:

issuer - The new issuer.

getHttpSession

public HttpSession getHttpSession()

Get the attached HTTP Session.

Returns:

The http session.

setHttpSession

public void setHttpSession(HttpSession httpSession)

Set the attached HTTP Session.

Parameters:

httpSession - The http session.

getIdentity

public UserIdentity getIdentity()

Get the user identity to which this token was issued.

Returns:

The user identity.

setIdentity

public void setIdentity(UserIdentity identity)

Set the user identity to whom this token was issued.

Parameters:

identity - The identity.

getClient

public Client getClient()

Retrieve the client for whom this token is valid.

Returns:

The client.

setClient

public void setClient(Client client)

Set the client for whom this token is valid.

Parameters:

client - The client.

getAuthToken

public OAuthToken getAuthToken()

Retrieve the oauth token for this refresh token.

Returns:

The auth token.

setAuthToken

public void setAuthToken(OAuthToken authToken)

Set the new parent auth token (for refresh tokens only).

Parameters:

authToken - The new auth token.

getTokenType

public OAuthTokenType getTokenType()

Get the token type.

Returns:

Bearer or Authorization, as an enum.

setTokenType

public void setTokenType(OAuthTokenType tokenType)

Set the token type.

Parameters:

tokenType - The token type.

getExpiresIn

public Long getExpiresIn()

Get the token lifetime, in seconds.

Returns:

The lifetime of the token, in seconds.

setExpiresIn

public void setExpiresIn(int expiresIn)

Set the expiration time, in seconds, from the creation date.

Parameters:

expiresIn - The time, in seconds.

setExpiresIn

public void setExpiresIn(long expiresIn)

Set the expiration time, in seconds, from the creation date.

Parameters:

expiresIn - The time, in seconds.

setExpiresIn

public void setExpiresIn(Number expiresIn)

Set the expiration time, in seconds, from the creation date.

Parameters:

expiresIn - The time, in seconds.

getScopes

public SortedMap<String,ApplicationScope> getScopes()

Get this token's scopes.

Returns:

A map of scopes.

setScopes

public void setScopes(SortedMap<String,ApplicationScope> scopes)

Set this token's scopes.

Parameters:

scopes - A new map of scopes.

isExpired

public boolean isExpired()

This method returns true if the created time, plus the expiration seconds, is less than the current time.

Returns:

True of this token is expired, otherwise false.

getRedirect

public URI getRedirect()

Get the redirect attached to this token.

Returns:

The redirect.

setRedirect

public void setRedirect(URI redirect)

Set the redirect for this particular token.

Parameters:

redirect - The new redirect.

getName

public String getName()

Returns the name of this principal. In our case, this will either be the remote ID of the user identity, or the human readable name of the OAuth Client application (in the case of a ClientCredentials Client).

Specified by:

getName in interface Principal

Returns:

the name of this principal.

getOwner

public User getOwner()

The owner of this entity.

Specified by:

getOwner in class AbstractAuthzEntity

Returns:

This entity's owner, if it exists.