org.aerogear.mobile.auth.user

Class UserPrincipalImpl

java.lang.Object

org.aerogear.mobile.auth.user.UserPrincipalImpl

All Implemented Interfaces:

java.io.Serializable, UserPrincipal

public class UserPrincipalImpl
extends java.lang.Object
implements UserPrincipal

This class represent an authenticated user

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserPrincipalImpl.Builder Builds and return a UserPrincipalImpl object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserPrincipalImpl(java.lang.String username, java.lang.String email, java.util.Set<UserRole> roles, java.lang.String identityToken, java.lang.String accessToken, java.lang.String refreshToken) Builds a new UserPrincipalImpl object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessToken() Returns the access token for the current logged user.
java.lang.String	getEmail() Returns the email
java.lang.String	getIdentityToken() Returns the identity token.
java.lang.String	getName() Returns the username
java.lang.String	getRefreshToken() Returns the refresh token.
java.util.Set<UserRole>	getRoles() Get's user roles
boolean	hasClientRole(java.lang.String role, java.lang.String clientId) Checks if the user has the specified Client role.
boolean	hasRealmRole(java.lang.String role) Checks if the user has the specified Realm role.
static UserPrincipalImpl.Builder	newUser()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPrincipalImpl

protected UserPrincipalImpl(java.lang.String username,
                            java.lang.String email,
                            java.util.Set<UserRole> roles,
                            java.lang.String identityToken,
                            java.lang.String accessToken,
                            java.lang.String refreshToken)

Builds a new UserPrincipalImpl object

Parameters:

username - the username of the authenticated user

email - the email of the authenticated user

roles - roles assigned to the user

identityToken - the identity token

accessToken - the access token

refreshToken - the refresh token

Method Detail

hasClientRole

public boolean hasClientRole(java.lang.String role,
                             java.lang.String clientId)

Checks if the user has the specified Client role.

Specified by:

hasClientRole in interface UserPrincipal

Parameters:

role - role to be checked

clientId - clientID related to role

Returns:

true or false

hasRealmRole

public boolean hasRealmRole(java.lang.String role)

Checks if the user has the specified Realm role.

Specified by:

hasRealmRole in interface UserPrincipal

Parameters:

role - role to be checked

Returns:

true or false

getName

public java.lang.String getName()

Description copied from interface: UserPrincipal

Returns the username

Specified by:

getName in interface UserPrincipal

Returns:

the username

getRoles

public java.util.Set<UserRole> getRoles()

Get's user roles

Specified by:

getRoles in interface UserPrincipal

Returns:

user's roles

getEmail

public java.lang.String getEmail()

Description copied from interface: UserPrincipal

Returns the email

Specified by:

getEmail in interface UserPrincipal

Returns:

the email

newUser

public static UserPrincipalImpl.Builder newUser()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIdentityToken

public java.lang.String getIdentityToken()

Returns the identity token. It is used during logout.

Specified by:

getIdentityToken in interface UserPrincipal

Returns:

the identity token

getAccessToken

public java.lang.String getAccessToken()

Returns the access token for the current logged user. This token can be added to HTTP requests as the "Authorization: Bearer" header.

Specified by:

getAccessToken in interface UserPrincipal

Returns:

the access token

getRefreshToken

public java.lang.String getRefreshToken()

Returns the refresh token.

Specified by:

getRefreshToken in interface UserPrincipal

Returns:

the refresh token