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 firstName, java.lang.String lastName, 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.Boolean	getCustomBooleanAttribute(java.lang.String attributeName) Returns the custom user attribute of type boolean.
java.lang.Integer	getCustomIntegerAttribute(java.lang.String attributeName) Returns the custom user attribute of type int.
java.lang.Long	getCustomLongAttribute(java.lang.String attributeName) Returns the custom user attribute of type long.
java.lang.String	getCustomStringAttribute(java.lang.String attributeName) Returns the custom user attribute of type string.
java.lang.String	getEmail() Returns the email
java.lang.String	getFirstName() Returns the first name of the user.
java.lang.String	getIdentityToken() Returns the identity token.
java.lang.String	getLastName() Returns the last name of the user.
java.lang.String	getName() Returns the full name of the user.
java.util.Set<UserRole>	getRealmRoles() Get's the user realm roles
java.lang.String	getRefreshToken() Returns the refresh token.
java.util.Set<UserRole>	getResourceRoles() Get's the user resource roles
java.util.Set<UserRole>	getRoles() Get's user roles
java.lang.String	getUsername() Returns the username
boolean	hasRealmRole(java.lang.String role) Checks if the user has the specified Realm role.
boolean	hasResourceRole(java.lang.String role, java.lang.String resourceId) Checks if the user has the specified Resource 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 firstName,
                            java.lang.String lastName,
                            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

firstName - the first name of the authenticated user

lastName - the last name 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

hasResourceRole

public boolean hasResourceRole(java.lang.String role,
                               java.lang.String resourceId)

Checks if the user has the specified Resource role.

Specified by:

hasResourceRole in interface UserPrincipal

Parameters:

role - role to be checked

resourceId - resourceId 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

getUsername

public java.lang.String getUsername()

Description copied from interface: UserPrincipal

Returns the username

Specified by:

getUsername in interface UserPrincipal

Returns:

the username

getFirstName

public java.lang.String getFirstName()

Description copied from interface: UserPrincipal

Returns the first name of the user.

Specified by:

getFirstName in interface UserPrincipal

Returns:

users first name.

getLastName

public java.lang.String getLastName()

Description copied from interface: UserPrincipal

Returns the last name of the user.

Specified by:

getLastName in interface UserPrincipal

Returns:

users last name.

getName

public java.lang.String getName()

Description copied from interface: UserPrincipal

Returns the full name of the user. Both first and last name.

Specified by:

getName in interface UserPrincipal

Returns:

users full name

getRoles

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

Get's user roles

Specified by:

getRoles in interface UserPrincipal

Returns:

user's roles

getRealmRoles

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

Get's the user realm roles

Specified by:

getRealmRoles in interface UserPrincipal

Returns:

user's realm roles

getResourceRoles

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

Get's the user resource roles

Specified by:

getResourceRoles in interface UserPrincipal

Returns:

user's resource 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

getCustomStringAttribute

public java.lang.String getCustomStringAttribute(java.lang.String attributeName)

Returns the custom user attribute of type string.

Specified by:

getCustomStringAttribute in interface UserPrincipal

Parameters:

attributeName - the user attribute to retrieve

Returns:

the custom string attribute

getCustomBooleanAttribute

public java.lang.Boolean getCustomBooleanAttribute(java.lang.String attributeName)

Returns the custom user attribute of type boolean.

Specified by:

getCustomBooleanAttribute in interface UserPrincipal

Parameters:

attributeName - the user attribute to retrieve

Returns:

the custom boolean attribute

getCustomLongAttribute

public java.lang.Long getCustomLongAttribute(java.lang.String attributeName)

Returns the custom user attribute of type long.

Specified by:

getCustomLongAttribute in interface UserPrincipal

Parameters:

attributeName - the user attribute to retrieve

Returns:

the custom long attribute

getCustomIntegerAttribute

public java.lang.Integer getCustomIntegerAttribute(java.lang.String attributeName)

Returns the custom user attribute of type int.

Specified by:

getCustomIntegerAttribute in interface UserPrincipal

Parameters:

attributeName - the user attribute to retrieve

Returns:

the custom int attribute