org.surfnet.oaaas.auth.principal

Class AuthenticatedPrincipal

java.lang.Object

org.surfnet.oaaas.auth.principal.AuthenticatedPrincipal

All Implemented Interfaces:

Serializable, Principal

public class AuthenticatedPrincipal
extends Object
implements Serializable, Principal

Principal that can contain roles and additional attributes. This is the return Object for AbstractAuthenticator implementations.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticatedPrincipal()
AuthenticatedPrincipal(String username)
AuthenticatedPrincipal(String username, Collection<String> roles)
AuthenticatedPrincipal(String username, Collection<String> roles, Map<String,String> attributes)
AuthenticatedPrincipal(String username, Collection<String> roles, Map<String,String> attributes, Collection<String> groups)
AuthenticatedPrincipal(String username, Collection<String> roles, Map<String,String> attributes, Collection<String> groups, boolean adminPrincipal)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(String key, String value)
void	addGroup(String name)
static AuthenticatedPrincipal	deserialize(String json)
String	getAttribute(String key) Get the given attribute.
Map<String,String>	getAttributes()
String	getDisplayName()
Collection<String>	getGroups()
String	getName()
Collection<String>	getRoles()
boolean	isAdminPrincipal()
boolean	isGroupAware()
String	serialize()
void	setAdminPrincipal(boolean adminPrincipal)
void	setAttributes(Map<String,String> attributes)
void	setGroups(Collection<String> groups)
void	setName(String name)
void	setRoles(Collection<String> roles)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

equals, hashCode

Constructor Detail

AuthenticatedPrincipal

public AuthenticatedPrincipal()

AuthenticatedPrincipal

public AuthenticatedPrincipal(String username)

AuthenticatedPrincipal

public AuthenticatedPrincipal(String username,
                      Collection<String> roles)

AuthenticatedPrincipal

public AuthenticatedPrincipal(String username,
                      Collection<String> roles,
                      Map<String,String> attributes)

AuthenticatedPrincipal

public AuthenticatedPrincipal(String username,
                      Collection<String> roles,
                      Map<String,String> attributes,
                      Collection<String> groups)

AuthenticatedPrincipal

public AuthenticatedPrincipal(String username,
                      Collection<String> roles,
                      Map<String,String> attributes,
                      Collection<String> groups,
                      boolean adminPrincipal)

Method Detail

getRoles

public Collection<String> getRoles()

Returns:

the roles

getAttributes

public Map<String,String> getAttributes()

Returns:

the attributes

getAttribute

public String getAttribute(String key)

Get the given attribute.

Parameters:

key - the attribute key to get.

Returns:

String value if attribute found. Null if attribute not found or no attributes at all.

addAttribute

public void addAttribute(String key,
                String value)

addGroup

public void addGroup(String name)

getName

public String getName()

Specified by:

getName in interface Principal

getDisplayName

public String getDisplayName()

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object

setName

public void setName(String name)

Parameters:

name - the name to set

setRoles

public void setRoles(Collection<String> roles)

Parameters:

roles - the roles to set

setAttributes

public void setAttributes(Map<String,String> attributes)

Parameters:

attributes - the attributes to set

getGroups

public Collection<String> getGroups()

setGroups

public void setGroups(Collection<String> groups)

isGroupAware

public boolean isGroupAware()

isAdminPrincipal

public boolean isAdminPrincipal()

setAdminPrincipal

public void setAdminPrincipal(boolean adminPrincipal)

serialize

public String serialize()

deserialize

public static AuthenticatedPrincipal deserialize(String json)