Package se.litsec.opensaml.common.validation

Class AbstractValidationParametersBuilder<T extends AbstractValidationParametersBuilder<T>>

java.lang.Object

se.litsec.opensaml.common.validation.AbstractValidationParametersBuilder<T>

All Implemented Interfaces:

ValidationParametersBuilder

Direct Known Subclasses:

AbstractResponseValidationParametersBuilder

public abstract class AbstractValidationParametersBuilder<T extends AbstractValidationParametersBuilder<T>>
extends Object
implements ValidationParametersBuilder

Abstract base class for building the ValidationContext object using a builder pattern. These settings are parameters that control the validation of an object.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

Constructor Summary

Constructors

Constructor	Description
AbstractValidationParametersBuilder()

Method Summary

Modifier and Type	Method	Description
void	addDynamicParameter(String name, Object value)	Adds a dynamic validation parameter.
void	addDynamicParameters(Map<String,Object> pars)	Adds dynamic validation parameters.
void	addStaticParameter(String name, Object value)	Adds a static validation parameter.
void	addStaticParameterIfMissing(String name, Object value)	Adds a static validation parameter if it is not set yet.
void	addStaticParameters(Map<String,Object> pars)	Adds static validation parameters.
T	allowedClockSkew(long millis)	Gives the number of milliseconds that is the maximum allowed clock skew when verifying time stamps.
T	allowedClockSkew(Duration skew)	Gives the duration that is the maximum allowed clock skew when verifying time stamps.
ValidationContext	build()	Builds a ValidationContext object.
T	dynamicParameter(String name, Object value)	Generic method that adds a dynamic validation parameter.
protected abstract T	getThis()	Returns 'this' object.
T	maxAgeReceivedMessage(long millis)	Gives the maximum age (difference between issuance time and the validation time) that a received message is allowed to have.
T	maxAgeReceivedMessage(Duration maxAge)	Gives the maximum age (difference between issuance time and the validation time) that a received message is allowed to have.
T	receiveInstant(long instant)	Sets the receive instant (i.e., when a message being validated was received).
T	receiveInstant(Instant instant)	Sets the receive instant (i.e., when a message being validated was received).
T	signatureRequired(boolean required)	Tells whether we require an object being validated to be signed.
T	signatureValidationCriteriaSet(CriteriaSet criteriaSet)	Gives the trust basis criteria set to use when verifying signatures (SignatureTrustEngine.validate).
T	staticParameter(String name, Object value)	Generic method that adds a static validation parameter.
T	strictValidation(boolean flag)	Tells whether strict validation should be performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractValidationParametersBuilder

public AbstractValidationParametersBuilder()

Method Detail

build

public ValidationContext build()

Builds a ValidationContext object.

Specified by:

build in interface ValidationParametersBuilder

Returns:

the ValidationContext object

staticParameter

public T staticParameter(String name,
                         Object value)

Generic method that adds a static validation parameter.

Parameters:

name - the parameter name

value - the parameter value

Returns:

the builder

dynamicParameter

public T dynamicParameter(String name,
                          Object value)

Generic method that adds a dynamic validation parameter.

Parameters:

name - the parameter name

value - the parameter value

Returns:

the builder

strictValidation

public T strictValidation(boolean flag)

Tells whether strict validation should be performed.

Parameters:

flag - true/false

Returns:

the builder

allowedClockSkew

public T allowedClockSkew(Duration skew)

Gives the duration that is the maximum allowed clock skew when verifying time stamps.

Parameters:

skew - duration

Returns:

the builder

allowedClockSkew

public T allowedClockSkew(long millis)

Gives the number of milliseconds that is the maximum allowed clock skew when verifying time stamps.

Parameters:

millis - number of milliseconds

Returns:

the builder

maxAgeReceivedMessage

public T maxAgeReceivedMessage(Duration maxAge)

Gives the maximum age (difference between issuance time and the validation time) that a received message is allowed to have.

Parameters:

maxAge - maximum allowed age on messages

Returns:

the builder

maxAgeReceivedMessage

public T maxAgeReceivedMessage(long millis)

Gives the maximum age (difference between issuance time and the validation time) that a received message is allowed to have.

Parameters:

millis - number of milliseconds

Returns:

the builder

receiveInstant

public T receiveInstant(Instant instant)

Sets the receive instant (i.e., when a message being validated was received).

Parameters:

instant - the receive instant

Returns:

the builder

receiveInstant

public T receiveInstant(long instant)

Sets the receive instant (i.e., when a message being validated was received).

Parameters:

instant - the receive instant

Returns:

the builder

signatureRequired

public T signatureRequired(boolean required)

Tells whether we require an object being validated to be signed.

Parameters:

required - true/false

Returns:

the builder

signatureValidationCriteriaSet

public T signatureValidationCriteriaSet(CriteriaSet criteriaSet)

Gives the trust basis criteria set to use when verifying signatures (SignatureTrustEngine.validate).

Parameters:

criteriaSet - the criteria set

Returns:

the builder

getThis

protected abstract T getThis()

Returns 'this' object.

Returns:

this object (the concrete builder}

addStaticParameter

public final void addStaticParameter(String name,
                                     Object value)

Adds a static validation parameter.

Parameters:

name - the name of the parameter

value - the value of the parameter

addStaticParameterIfMissing

public final void addStaticParameterIfMissing(String name,
                                              Object value)

Adds a static validation parameter if it is not set yet.

Parameters:

name - the name of the parameter

value - the value of the parameter

addStaticParameters

public final void addStaticParameters(Map<String,Object> pars)

Adds static validation parameters.

Parameters:

pars - static validation parameters

addDynamicParameter

public final void addDynamicParameter(String name,
                                      Object value)

Adds a dynamic validation parameter.

Parameters:

name - the name of the parameter

value - the value of the parameter

addDynamicParameters

public final void addDynamicParameters(Map<String,Object> pars)

Adds dynamic validation parameters.

Parameters:

pars - dynamic validation parameters