net.shibboleth.metadata.validate

Interface Validator<V>

Type Parameters:

V - type of the object to be validated

All Superinterfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

All Known Implementing Classes:

AbstractX509Validator, X509RSAExponentValidator, X509RSAKeyLengthValidator, X509RSAOpenSSLBlacklistValidator

public interface Validator<V>
extends net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

Interface for a validator to be applied to an object in the context of a given Item.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Validator.Action Validator instances are normally applied in sequence in a chain of responsibility pattern orchestrated by the caller.

Method Summary

Methods

Modifier and Type	Method and Description
Validator.Action	validate(V e, Item<?> item, String stageId) Apply the validator to the object in the given Item context.

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiableComponent

setId

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Method Detail

validate

Validator.Action validate(@Nonnull
                        V e,
                        @Nonnull
                        Item<?> item,
                        @Nonnull
                        String stageId)
                          throws StageProcessingException

Apply the validator to the object in the given Item context. The validator influences future processing by adding item metadata to the Item.

Parameters:

e - the object to be validated

item - the Item context for the validation

stageId - the identifier for the stage that is requesting the validation, for inclusion in status metadata

Returns:

an indication of whether to process additional validators

Throws:

StageProcessingException - if an error occurs during validation