Package org.keycloak.adapters.saml

Class SamlPrincipal

java.lang.Object

org.keycloak.adapters.saml.SamlPrincipal

All Implemented Interfaces:

Serializable, Principal

public class SamlPrincipal
extends Object
implements Serializable, Principal

Version:

$Revision: 1 $

Author:

Bill Burke

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ROLE_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor	Description
SamlPrincipal()
SamlPrincipal(AssertionType assertion, String name, String samlSubject, String nameIDFormat, MultivaluedHashMap<String,String> attributes, MultivaluedHashMap<String,String> friendlyAttributes)
SamlPrincipal(AssertionType assertion, Document assertionDocument, String name, String samlSubject, String nameIDFormat, MultivaluedHashMap<String,String> attributes, MultivaluedHashMap<String,String> friendlyAttributes)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
AssertionType	getAssertion()	Get full saml assertion
Document	getAssertionDocument()
String	getAttribute(String name)	Convenience function that gets first value of an attribute by attribute name
Set<String>	getAttributeNames()	Get set of all assertion attribute names
Map<String,List<String>>	getAttributes()	Convenience function that gets the attributes associated with this principal
List<String>	getAttributes(String name)	Convenience function that gets Attribute value by attribute name
String	getFriendlyAttribute(String friendlyName)	Convenience function that gets first value of an attribute by attribute name
List<String>	getFriendlyAttributes(String friendlyName)	Convenience function that gets Attribute value by attribute friendly name
Set<String>	getFriendlyNames()	Get set of all assertion friendly attribute names
String	getName()
NameIDType	getNameID()	Subject nameID format
String	getNameIDFormat()	Subject nameID format
String	getSamlSubject()	Get SAML subject sent in assertion
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.security.Principal

implies, toString

Field Details

DEFAULT_ROLE_ATTRIBUTE_NAME

public static final String DEFAULT_ROLE_ATTRIBUTE_NAME

See Also:

• Constant Field Values

Constructor Details

SamlPrincipal

public SamlPrincipal(AssertionType assertion,
 String name,
 String samlSubject,
 String nameIDFormat,
 MultivaluedHashMap<String,String> attributes,
 MultivaluedHashMap<String,String> friendlyAttributes)

SamlPrincipal

public SamlPrincipal(AssertionType assertion,
 Document assertionDocument,
 String name,
 String samlSubject,
 String nameIDFormat,
 MultivaluedHashMap<String,String> attributes,
 MultivaluedHashMap<String,String> friendlyAttributes)

SamlPrincipal

public SamlPrincipal()

Method Details

getAssertion

public AssertionType getAssertion()

Get full saml assertion

Returns:

getSamlSubject

public String getSamlSubject()

Get SAML subject sent in assertion

Returns:

getNameIDFormat

public String getNameIDFormat()

Subject nameID format

Returns:

getNameID

public NameIDType getNameID()

Subject nameID format

Returns:

getAssertionDocument

public Document getAssertionDocument()

getName

public String getName()

Specified by:

getName in interface Principal

getAttributes

public List<String> getAttributes(String name)

Convenience function that gets Attribute value by attribute name

Parameters:

name -

Returns:

getAttributes

public Map<String,List<String>> getAttributes()

Convenience function that gets the attributes associated with this principal

Returns:

attributes associated with this principal

getFriendlyAttributes

public List<String> getFriendlyAttributes(String friendlyName)

Convenience function that gets Attribute value by attribute friendly name

Parameters:

friendlyName -

Returns:

getAttribute

public String getAttribute(String name)

Convenience function that gets first value of an attribute by attribute name

Parameters:

name -

Returns:

getFriendlyAttribute

public String getFriendlyAttribute(String friendlyName)

Convenience function that gets first value of an attribute by attribute name

Parameters:

friendlyName -

Returns:

getAttributeNames

public Set<String> getAttributeNames()

Get set of all assertion attribute names

Returns:

getFriendlyNames

public Set<String> getFriendlyNames()

Get set of all assertion friendly attribute names

Returns:

equals

public boolean equals(Object other)

Specified by:

equals in interface Principal

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object