sirius.web.security

Class SAMLResponse

java.lang.Object

sirius.web.security.SAMLResponse

public class SAMLResponse
extends Object

Represents the parsed payload of a SAML response.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_EMAIL_ADDRESS Contains the attribute URI used to transmit the email address of the user being authenticated.
static String	ATTRIBUTE_GIVEN_NAME Contains the attribute URI used to transmit the given name of the user being authenticated.
static String	ATTRIBUTE_GROUP Contains the attribute URI used to transmit a security group.
static String	ATTRIBUTE_SURNAME Contains the attribute URI used to transmit the surname of the user being authenticated.

Constructor Summary

Constructors

Constructor and Description
SAMLResponse(String issuer, String fingerprint, String nameId, sirius.kernel.commons.MultiMap<String,String> attributes) Creates a new SAML response.

Method Summary

Modifier and Type	Method and Description
Collection<String>	getAttribute(String name) Returns all attributes which were submitted for the given attribute URI.
String	getAttributeValue(String name) Returns the first attribute value submitted for the given attribute URI.
String	getFingerprint() Returns the fingerprint of the certificate which was used to sign the response.
String	getIssuer() Returns the issuer of the assertion.
String	getNameId() Returns the username or id which has been authenticated.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_GROUP

public static final String ATTRIBUTE_GROUP

Contains the attribute URI used to transmit a security group.

See Also:

Constant Field Values

ATTRIBUTE_GIVEN_NAME

public static final String ATTRIBUTE_GIVEN_NAME

Contains the attribute URI used to transmit the given name of the user being authenticated.

See Also:

Constant Field Values

ATTRIBUTE_SURNAME

public static final String ATTRIBUTE_SURNAME

Contains the attribute URI used to transmit the surname of the user being authenticated.

See Also:

Constant Field Values

ATTRIBUTE_EMAIL_ADDRESS

public static final String ATTRIBUTE_EMAIL_ADDRESS

Contains the attribute URI used to transmit the email address of the user being authenticated.

See Also:

Constant Field Values

Constructor Detail

SAMLResponse

public SAMLResponse(String issuer,
                    String fingerprint,
                    String nameId,
                    sirius.kernel.commons.MultiMap<String,String> attributes)

Creates a new SAML response.

Parameters:

issuer - the issuer which created the SAML response

fingerprint - the fingerprint of the certificate which was used to sign the response

nameId - the name of the user

attributes - the attributes within the Assertion

Method Detail

getIssuer

public String getIssuer()

Returns the issuer of the assertion.

Returns:

the issuer of the assertion

getFingerprint

public String getFingerprint()

Returns the fingerprint of the certificate which was used to sign the response.

Returns:

the fungerprint of the X509 certificate

getNameId

public String getNameId()

Returns the username or id which has been authenticated.

Returns:

the username

getAttribute

@Nonnull
public Collection<String> getAttribute(String name)

Returns all attributes which were submitted for the given attribute URI.

Parameters:

name - the name or attribute URI

Returns:

a collection containing all values submitted for the given attribute or an empty collection if there are none.

getAttributeValue

@Nullable
public String getAttributeValue(String name)

Returns the first attribute value submitted for the given attribute URI.

Parameters:

name - the name or attribute URI

Returns:

the first value being submitted or null if there was no value