edu.internet2.middleware.shibboleth.idp.authn

Class Saml2LoginContext

java.lang.Object

edu.internet2.middleware.shibboleth.idp.authn.LoginContext

edu.internet2.middleware.shibboleth.idp.authn.Saml2LoginContext

All Implemented Interfaces:

Serializable

public class Saml2LoginContext
extends LoginContext
implements Serializable

A SAML 2.0 LoginContext. This class can interpret RequestedAuthnContext and act accordingly.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private AuthnRequest	authnRequest The authentication request.
private String	relayState Relay state from authentication request.
private boolean	requestAuthenticated Was the request authenticated when received.
private String	serialAuthnRequest Serialized authentication request.
private static long	serialVersionUID Serial version UID.
private boolean	unsolicited Unsolicited SSO indicator.

Fields inherited from class edu.internet2.middleware.shibboleth.idp.authn.LoginContext

LOGIN_CONTEXT_KEY

Constructor Summary

Constructors

Constructor and Description
Saml2LoginContext(String relyingParty, String state, AuthnRequest request) Creates a new instance of Saml2LoginContext.

Method Summary

Methods

Modifier and Type	Method and Description
protected List<String>	extractRequestedAuthenticationMethods(AuthnRequest request) Extracts the authentication methods requested within the request.
String	getAuthenticationRequest() Gets the serialized authentication request that started the login process.
AuthnRequest	getAuthenticiationRequestXmlObject() Gets the authentication request object.
String	getRelayState() Gets the relay state from the originating authentication request.
boolean	isRequestAuthenticated() Gets whether the message was authenticated when received.
boolean	isUnsolicited() Returns the unsolicited SSO indicator.
protected String	serializeRequest(AuthnRequest request) Serializes an authentication request into a string.
void	setRequestAuthenticated(boolean flag) Sets whether the message was authenticated when received.
void	setUnsolicited(boolean isUnsolicited) Sets the unsolicited SSO indicator.

Methods inherited from class edu.internet2.middleware.shibboleth.idp.authn.LoginContext

getAttemptedAuthnMethod, getAuthenticationAttempted, getAuthenticationDuration, getAuthenticationEngineURL, getAuthenticationFailure, getAuthenticationInstant, getAuthenticationMethod, getAuthenticationMethodInformation, getDefaultAuthenticationMethod, getPrincipalName, getProfileHandlerURL, getProperty, getRelyingPartyId, getRequestedAuthenticationMethods, getSessionID, isForceAuthRequired, isPassiveAuthRequired, isPrincipalAuthenticated, setAttemptedAuthnMethod, setAuthenticationAttempted, setAuthenticationDuration, setAuthenticationEngineURL, setAuthenticationFailure, setAuthenticationInstant, setAuthenticationMethod, setAuthenticationMethodInformation, setDefaultAuthenticationMethod, setForceAuthRequired, setPassiveAuthRequired, setPrincipalAuthenticated, setPrincipalName, setProfileHandlerURL, setProperty, setRelyingParty, setSessionID

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial version UID.

See Also:

Constant Field Values

relayState

private String relayState

Relay state from authentication request.

authnRequest

private transient AuthnRequest authnRequest

The authentication request.

serialAuthnRequest

private String serialAuthnRequest

Serialized authentication request.

requestAuthenticated

private boolean requestAuthenticated

Was the request authenticated when received.

unsolicited

private boolean unsolicited

Unsolicited SSO indicator.

Constructor Detail

Saml2LoginContext

public Saml2LoginContext(String relyingParty,
                 String state,
                 AuthnRequest request)
                  throws MarshallingException

Creates a new instance of Saml2LoginContext.

Parameters:

relyingParty - entity ID of the relying party

state - relay state from incoming authentication request

request - SAML 2.0 Authentication Request

Throws:

MarshallingException - thrown if the given request can not be marshalled and serialized into a string

Method Detail

getAuthenticiationRequestXmlObject

public AuthnRequest getAuthenticiationRequestXmlObject()
                                                throws UnmarshallingException

Gets the authentication request object.

Returns:

the authentication request object

Throws:

UnmarshallingException - thrown if there is a problem unmarshalling the serialized form of the request

getAuthenticationRequest

public String getAuthenticationRequest()
                                throws UnmarshallingException

Gets the serialized authentication request that started the login process.

Returns:

authentication request that started the login process

Throws:

UnmarshallingException - thrown if the serialized form on the authentication request can be unmarshalled

getRelayState

public String getRelayState()

Gets the relay state from the originating authentication request.

Returns:

relay state from the originating authentication request

isUnsolicited

public boolean isUnsolicited()

Returns the unsolicited SSO indicator.

Returns:

the unsolicited SSO indicator

setUnsolicited

public void setUnsolicited(boolean isUnsolicited)

Sets the unsolicited SSO indicator.

Parameters:

isUnsolicited - unsolicited SSO indicator to set

isRequestAuthenticated

public boolean isRequestAuthenticated()

Gets whether the message was authenticated when received.

Returns:

whether the message was authenticated when received

setRequestAuthenticated

public void setRequestAuthenticated(boolean flag)

Sets whether the message was authenticated when received.

Parameters:

flag - whether the message was authenticated when received

serializeRequest

protected String serializeRequest(AuthnRequest request)
                           throws MarshallingException

Serializes an authentication request into a string.

Parameters:

request - the request to serialize

Returns:

the serialized form of the string

Throws:

MarshallingException - thrown if the request can not be marshalled and serialized

extractRequestedAuthenticationMethods

protected List<String> extractRequestedAuthenticationMethods(AuthnRequest request)

Extracts the authentication methods requested within the request.

Parameters:

request - the authentication request

Returns:

requested authentication methods, or an empty list if no preference