org.opensaml.saml.saml2.assertion.impl

Class AbstractSubjectConfirmationValidator

java.lang.Object

org.opensaml.saml.saml2.assertion.impl.AbstractSubjectConfirmationValidator

All Implemented Interfaces:

SubjectConfirmationValidator

Direct Known Subclasses:

BearerSubjectConfirmationValidator, HolderOfKeySubjectConfirmationValidator, SenderVouchersSubjectConfirmationValidator

@ThreadSafe
public abstract class AbstractSubjectConfirmationValidator
extends Object
implements SubjectConfirmationValidator

A base class for SubjectConfirmationValidator implementations.

This class takes care of processing the NotBefore, NotOnOrAfter, Recipient, and Address checks.

Supports the following ValidationContext static parameters:

• SAML2AssertionValidationParameters.SC_VALID_ADDRESSES: Required.
• SAML2AssertionValidationParameters.SC_VALID_RECIPIENTS: Required.

Supports the following ValidationContext dynamic parameters:

None.

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
AbstractSubjectConfirmationValidator() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract ValidationResult	doValidate(SubjectConfirmation confirmation, Assertion assertion, ValidationContext context) Performs any further validation required for the specific confirmation method implementation.
ValidationResult	validate(SubjectConfirmation confirmation, Assertion assertion, ValidationContext context)
protected ValidationResult	validateAddress(SubjectConfirmation confirmation, Assertion assertion, ValidationContext context) Validates the Address condition of the SubjectConfirmationData, if any is present.
protected ValidationResult	validateNotBefore(SubjectConfirmation confirmation, Assertion assertion, ValidationContext context) Validates the NotBefore condition of the SubjectConfirmationData, if any is present.
protected ValidationResult	validateNotOnOrAfter(SubjectConfirmation confirmation, Assertion assertion, ValidationContext context) Validates the NotOnOrAfter condition of the SubjectConfirmationData, if any is present.
protected ValidationResult	validateRecipient(SubjectConfirmation confirmation, Assertion assertion, ValidationContext context) Validates the Recipient condition of the SubjectConfirmationData, if any is present.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.saml.saml2.assertion.SubjectConfirmationValidator

getServicedMethod

Field Detail

log

private Logger log

Class logger.

Constructor Detail

AbstractSubjectConfirmationValidator

public AbstractSubjectConfirmationValidator()

Constructor.

Method Detail

validate

@Nonnull
public ValidationResult validate(@Nonnull
                                SubjectConfirmation confirmation,
                                @Nonnull
                                Assertion assertion,
                                @Nonnull
                                ValidationContext context)
                          throws AssertionValidationException

Specified by:

validate in interface SubjectConfirmationValidator

Throws:

AssertionValidationException

validateNotBefore

@Nonnull
protected ValidationResult validateNotBefore(@Nonnull
                                         SubjectConfirmation confirmation,
                                         @Nonnull
                                         Assertion assertion,
                                         @Nonnull
                                         ValidationContext context)
                                      throws AssertionValidationException

Validates the NotBefore condition of the SubjectConfirmationData, if any is present.

Parameters:

confirmation - confirmation method, with SubjectConfirmationData, being validated

assertion - assertion bearing the confirmation method

context - current validation context

Returns:

the result of the validation evaluation

Throws:

AssertionValidationException - thrown if there is a problem determining the validity of the NotBefore

validateNotOnOrAfter

@Nonnull
protected ValidationResult validateNotOnOrAfter(@Nonnull
                                            SubjectConfirmation confirmation,
                                            @Nonnull
                                            Assertion assertion,
                                            @Nonnull
                                            ValidationContext context)
                                         throws AssertionValidationException

Validates the NotOnOrAfter condition of the SubjectConfirmationData, if any is present.

Parameters:

confirmation - confirmation method, with SubjectConfirmationData, being validated

assertion - assertion bearing the confirmation method

context - current validation context

Returns:

the result of the validation evaluation

Throws:

AssertionValidationException - thrown if there is a problem determining the validity of the NotOnOrAFter

validateRecipient

@Nonnull
protected ValidationResult validateRecipient(@Nonnull
                                         SubjectConfirmation confirmation,
                                         @Nonnull
                                         Assertion assertion,
                                         @Nonnull
                                         ValidationContext context)
                                      throws AssertionValidationException

Validates the Recipient condition of the SubjectConfirmationData, if any is present.

Parameters:

confirmation - confirmation method being validated

assertion - assertion bearing the confirmation method

context - current validation context

Returns:

the result of the validation evaluation

Throws:

AssertionValidationException - thrown if there is a problem determining the validity of the recipient

validateAddress

@Nonnull
protected ValidationResult validateAddress(@Nonnull
                                       SubjectConfirmation confirmation,
                                       @Nonnull
                                       Assertion assertion,
                                       @Nonnull
                                       ValidationContext context)
                                    throws AssertionValidationException

Validates the Address condition of the SubjectConfirmationData, if any is present.

Parameters:

confirmation - confirmation method being validated

assertion - assertion bearing the confirmation method

context - current validation context

Returns:

the result of the validation evaluation

Throws:

AssertionValidationException - thrown if there is a problem determining the validity of the address

doValidate

@Nonnull
protected abstract ValidationResult doValidate(@Nonnull
                                  SubjectConfirmation confirmation,
                                  @Nonnull
                                  Assertion assertion,
                                  @Nonnull
                                  ValidationContext context)
                                        throws AssertionValidationException

Performs any further validation required for the specific confirmation method implementation.

Parameters:

confirmation - confirmation method being validated

assertion - assertion bearing the confirmation method

context - current validation context

Returns:

the result of the validation evaluation

Throws:

AssertionValidationException - thrown if further validation finds the confirmation method to be invalid