net.shibboleth.metadata.validate

Class BaseValidator

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.metadata.validate.BaseValidator

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractX509Validator

public abstract class BaseValidator
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

Base class for validator implementations. Encapsulates the notion of an identifier for each validator class, and helper methods for constructing status metadata.

Constructor Summary

Constructors

Constructor and Description
BaseValidator()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addError(String message, Item<?> item, String stageId) Add an ErrorStatus to the given Item.
protected void	addStatus(boolean error, String message, Item<?> item, String stageId) Add a WarningStatus or ErrorStatus to the given Item.
protected void	addWarning(String message, Item<?> item, String stageId) Add a WarningStatus to the given Item.
private String	makeComponentId(String stageId) Construct a modified component identifier from the stage identifier and the validator identifier.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

doInitialize, getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

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

getId

Constructor Detail

BaseValidator

public BaseValidator()

Method Detail

makeComponentId

private String makeComponentId(@Nonnull
                     String stageId)

Construct a modified component identifier from the stage identifier and the validator identifier.

Parameters:

stageId - identifier for the calling stage

Returns:

composite component identifier

addError

protected void addError(@Nonnull
            String message,
            @Nonnull
            Item<?> item,
            @Nonnull
            String stageId)

Add an ErrorStatus to the given Item.

Parameters:

message - message to include in the status metadata

item - Item to add the status metadata to

stageId - component identifier for the calling stage

addWarning

protected void addWarning(@Nonnull
              String message,
              @Nonnull
              Item<?> item,
              @Nonnull
              String stageId)

Add a WarningStatus to the given Item.

Parameters:

message - message to include in the status metadata

item - Item to add the status metadata to

stageId - component identifier for the calling stage

addStatus

protected void addStatus(boolean error,
             @Nonnull
             String message,
             @Nonnull
             Item<?> item,
             @Nonnull
             String stageId)

Add a WarningStatus or ErrorStatus to the given Item.

Parameters:

error - true if an ErrorStatus should be added

message - message to include in the status metadata

item - Item to add the status metadata to

stageId - component identifier for the calling stage