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

Class UserIdentity

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.UserIdentity

All Implemented Interfaces:

Cloneable, ICreatedDateEntity, IModifiedDateEntity

@Entity
 @Indexed(index="user_identities")
 @Analyzer(definition="entity_analyzer")
public final class UserIdentity
extends AbstractAuthzEntity

A user's identity, as provided by authenticators. Note that a user may have more than one identity from an authenticator- for instance, a user may link to two separate gmail accounts.

Author:

Michael Krotscheck

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
UserIdentity()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getClaims() Retrieve identity claims made by the authenticator.
User	getOwner() The owner of this entity.
String	getPassword() Get the password.
String	getRemoteId() The remote ID by which the authenticator recognizes the user.
String	getSalt() Get the salt.
List<OAuthToken>	getTokens() Get all the tokens issued to this identity.
AuthenticatorType	getType() The type of authenticator.
User	getUser() Get the user record for this identity.
void	setClaims(Map<String,String> claims) Set the claims made by the authenticator.
void	setPassword(String password) Set a new password.
void	setRemoteId(String remoteId) Set the remote ID by which the authenticator recognizes the user.
void	setSalt(String salt) Set a new salt.
void	setTokens(List<OAuthToken> tokens) Set the list of tokens for this user.
void	setType(AuthenticatorType authType) Set the type of authenticator.
void	setUser(User user) Set the user for this identity.

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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserIdentity

public UserIdentity()

Method Detail

getUser

public User getUser()

Get the user record for this identity.

Returns:

The user record.

setUser

public void setUser(User user)

Set the user for this identity.

Parameters:

user - This identity's user.

getRemoteId

public String getRemoteId()

The remote ID by which the authenticator recognizes the user.

Returns:

A string, representing this authenticator.

setRemoteId

public void setRemoteId(String remoteId)

Set the remote ID by which the authenticator recognizes the user.

Parameters:

remoteId - The remote ID.

getClaims

public Map<String,String> getClaims()

Retrieve identity claims made by the authenticator.

Returns:

A set of claims, such as email and name.

setClaims

public void setClaims(Map<String,String> claims)

Set the claims made by the authenticator.

Parameters:

claims - The claims.

getType

public AuthenticatorType getType()

The type of authenticator.

Returns:

The authenticator type.

setType

public void setType(AuthenticatorType authType)

Set the type of authenticator.

Parameters:

authType - The new authType.

getTokens

public List<OAuthToken> getTokens()

Get all the tokens issued to this identity.

Returns:

A list of all tokens (lazy loaded)

setTokens

public void setTokens(List<OAuthToken> tokens)

Set the list of tokens for this user.

Parameters:

tokens - A new list of tokens.

getSalt

public String getSalt()

Get the salt.

Returns:

The current salt.

setSalt

public void setSalt(String salt)

Set a new salt.

Parameters:

salt - A new salt, should be 32 characters long.

getPassword

public String getPassword()

Get the password.

Returns:

An encrypted password.

setPassword

public void setPassword(String password)

Set a new password. Make sure this is encrypted first.

Parameters:

password - The new password.

getOwner

public User getOwner()

The owner of this entity.

Specified by:

getOwner in class AbstractAuthzEntity

Returns:

This entity's owner, if it exists.