org.aerogear.mobile.auth.user

Interface UserPrincipal

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

UserPrincipalImpl

public interface UserPrincipal
extends java.io.Serializable

Public interface for user principals. It extends the Serializable interface to allow instances to be easily pass around between Activity and Fragment using Bundle.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessToken() Returns the token that will allow access to other services.
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 users 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() Returns the realm roles associated with this principal
java.lang.String	getRefreshToken() Returns the users refresh token.
java.util.Set<UserRole>	getResourceRoles() Returns the resource roles associated with this principal
java.util.Set<UserRole>	getRoles() Returns the roles associated with this principal
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.

Method Detail

hasResourceRole

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

Checks if the user has the specified Resource role.

Parameters:

role - role to be checked

resourceId - resourceId related to role

Returns:

true or false

hasRealmRole

boolean hasRealmRole(java.lang.String role)

Checks if the user has the specified Realm role.

Parameters:

role - role to be checked

Returns:

true or false

getUsername

java.lang.String getUsername()

Returns the username

Returns:

the username

getName

java.lang.String getName()

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

Returns:

users full name

getFirstName

java.lang.String getFirstName()

Returns the first name of the user.

Returns:

users first name.

getLastName

java.lang.String getLastName()

Returns the last name of the user.

Returns:

users last name.

getEmail

java.lang.String getEmail()

Returns the email

Returns:

the email

getRoles

java.util.Set<UserRole> getRoles()

Returns the roles associated with this principal

Returns:

the roles associated with this principal

getRealmRoles

java.util.Set<UserRole> getRealmRoles()

Returns the realm roles associated with this principal

Returns:

the realm roles associated with this principal

getResourceRoles

java.util.Set<UserRole> getResourceRoles()

Returns the resource roles associated with this principal

Returns:

the resource roles associated with this principal

getAccessToken

java.lang.String getAccessToken()

Returns the token that will allow access to other services.

Returns:

the access token.

getIdentityToken

java.lang.String getIdentityToken()

Returns the users identity token.

Returns:

the identity token.

getRefreshToken

java.lang.String getRefreshToken()

Returns the users refresh token.

Returns:

the refresh token.

getCustomStringAttribute

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

Returns the custom user attribute of type string.

Parameters:

attributeName - the user attribute to retrieve

Returns:

the custom string attribute

getCustomBooleanAttribute

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

Returns the custom user attribute of type boolean.

Parameters:

attributeName - the user attribute to retrieve

Returns:

the custom boolean attribute

getCustomLongAttribute

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

Returns the custom user attribute of type long.

Parameters:

attributeName - the user attribute to retrieve

Returns:

the custom long attribute

getCustomIntegerAttribute

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

Returns the custom user attribute of type int.

Parameters:

attributeName - the user attribute to retrieve

Returns:

the custom int attribute