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.String	getEmail() Returns the email
java.lang.String	getIdentityToken() Returns the users identity token.
java.lang.String	getName() Returns the username
java.lang.String	getRefreshToken() Returns the users refresh token.
java.util.Set<UserRole>	getRoles() Returns the roles associated with this principal
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.

Method Detail

hasClientRole

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

Checks if the user has the specified Client role.

Parameters:

role - role to be checked

clientId - clientID 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

getName

java.lang.String getName()

Returns the username

Returns:

the username

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

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.