org.sourceid.saml20.adapter.sp.authn

Class SsoContext

java.lang.Object

org.sourceid.saml20.adapter.sp.authn.SsoContext

All Implemented Interfaces:

Serializable

public class SsoContext
extends Object
implements Serializable

SsoContext is just a wrapper class that contains contextual information about a single sign-on event.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SsoContext(AttributeMap subjectAttributes, AssertionType ssoAssertion, List<AssertionType> otherValidAssertions, String idpPartnerEntityId, String targetResourceUrl) Create a new SsoContext.
SsoContext(AttributeMap subjectAttributes, AssertionType ssoAssertion, List<AssertionType> otherValidAssertions, String idpPartnerEntityId, String targetResourceUrl, String authnCtx, Date authnInstant) Create a new SsoContext.

Method Summary

Modifier and Type	Method and Description
String	getAuthenticationContext() Gets the authentication context (class reference URI) or authentication method of the assertion.
Date	getAuthenticationInstant() Gets the authentication instant.
String	getIdpPartnerEntityId() Gets the entity id of the IDP who authenticated the user.
List<AssertionType>	getOtherValidAssertions() If more than one assertion was included by the IdP, the additional valid assertion can be accessed by this method.
AssertionType	getSsoAssertion() The raw assertion that was relied upon for SSO.
Map	getSubjectAttributes() Deprecated. Please use getSubjectAttrs() instead.
Map<String,AttributeValue>	getSubjectAttrs() Gets the attributes resulting from the PingFederate server's subject and attribute mapping process.
String	getTargetResourceUrl() The URL that is the end target destination of the SSO.
void	setTargetResourceUrl(String targetResourceUrl) Set the target resource URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

SsoContext

public SsoContext(AttributeMap subjectAttributes,
                  AssertionType ssoAssertion,
                  List<AssertionType> otherValidAssertions,
                  String idpPartnerEntityId,
                  String targetResourceUrl)

Create a new SsoContext.

SsoContext

public SsoContext(AttributeMap subjectAttributes,
                  AssertionType ssoAssertion,
                  List<AssertionType> otherValidAssertions,
                  String idpPartnerEntityId,
                  String targetResourceUrl,
                  String authnCtx,
                  Date authnInstant)

Create a new SsoContext.

Method Detail

getSubjectAttributes

@Deprecated
public Map getSubjectAttributes()

Deprecated. Please use getSubjectAttrs() instead.

getSubjectAttrs

public Map<String,AttributeValue> getSubjectAttrs()

Gets the attributes resulting from the PingFederate server's subject and attribute mapping process.

Returns:

the map of attributes (name/value pairs where the values are AttributeValue objects). This map should fulfill the the incoming attribute contract of your adapter implementation.

See Also:

AttributeValue

getIdpPartnerEntityId

public String getIdpPartnerEntityId()

Gets the entity id of the IDP who authenticated the user.

Returns:

the entity id.

getTargetResourceUrl

public String getTargetResourceUrl()

The URL that is the end target destination of the SSO.

Returns:

the target resource URL.

setTargetResourceUrl

public void setTargetResourceUrl(String targetResourceUrl)

Set the target resource URL.

An SpAuthenticationAdapter implementation can modify the targetResourceUrl during the SpAuthenticationAdapter.createAuthN(org.sourceid.saml20.adapter.sp.authn.SsoContext, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String) method, if it needs to by calling this setter method and the PingFederate server will use the new value.

Parameters:

targetResourceUrl - the new target resource URL.

getSsoAssertion

public AssertionType getSsoAssertion()

The raw assertion that was relied upon for SSO.

All protocol validation has been performed on the assertion and the commonly used values have been placed in the subject attributes map getSubjectAttributes(). In general, only advanced usages will need this method because getSubjectAttributes() contains most of the commonly needed information.

Returns:

an XmlBeans AssertionType object

getOtherValidAssertions

public List<AssertionType> getOtherValidAssertions()

If more than one assertion was included by the IdP, the additional valid assertion can be accessed by this method.

All protocol validation has been performed on these assertions and the commonly used values have been placed in the subject attributes map getSubjectAttributes(). In general, only advanced usages will need this method because getSubjectAttributes() contains most of the commonly needed information.

Returns:

a list of XmlBeans AssertionType objects

getAuthenticationContext

public String getAuthenticationContext()

Gets the authentication context (class reference URI) or authentication method of the assertion.

Returns:

a string representing the method or context of the principals authentication event.

getAuthenticationInstant

public Date getAuthenticationInstant()

Gets the authentication instant.

Returns:

the authentication instant from the assertion.