net.shibboleth.idp.authn.context

Class AuthenticationWarningContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.authn.context.AuthenticationWarningContext

All Implemented Interfaces:

Iterable<org.opensaml.messaging.context.BaseContext>

public class AuthenticationWarningContext
extends org.opensaml.messaging.context.BaseContext

A BaseContext, usually attached to AuthenticationContext, that holds information about authentication warnings.

The login process is particularly prone to requiring detailed warning information to provide appropriate user feedback and auditing, and this context tracks warnings that occur and preserves detailed information about the kind of warnings encountered in multi-part authentication flows.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

org.opensaml.messaging.context.BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<String>	classifiedWarnings Warning conditions detected through classified warning messages.

Constructor Summary

Constructors

Constructor and Description
AuthenticationWarningContext() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<String>	getClassifiedWarnings() Get a mutable collection of warning "tokens" associated with the context.
boolean	isClassifiedWarning(String warning) Check for the presence of a particular warning condition in the context.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, isAutoCreateSubcontexts, iterator, removeSubcontext, removeSubcontext, setAutoCreateSubcontexts, setParent

Methods inherited from class java.lang.Object

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

Field Detail

classifiedWarnings

private Collection<String> classifiedWarnings

Warning conditions detected through classified warning messages.

Constructor Detail

AuthenticationWarningContext

public AuthenticationWarningContext()

Constructor.

Method Detail

getClassifiedWarnings

@Nonnull
@NonnullElements
@Live
public Collection<String> getClassifiedWarnings()

Get a mutable collection of warning "tokens" associated with the context.

Returns:

mutable collection of warning strings

isClassifiedWarning

public boolean isClassifiedWarning(@Nonnull@NotEmpty
                          String warning)

Check for the presence of a particular warning condition in the context.

Parameters:

warning - the condition to check for

Returns:

true if the context contains the warning condition specified