Package net.shibboleth.metadata.validate.string

Class AcceptStringValueValidator

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.metadata.validate.BaseValidator

net.shibboleth.metadata.validate.string.BaseStringValueValidator

net.shibboleth.metadata.validate.string.AcceptStringValueValidator

All Implemented Interfaces:

Validator<String>, net.shibboleth.shared.component.Component, net.shibboleth.shared.component.DestructableComponent, net.shibboleth.shared.component.IdentifiableComponent, net.shibboleth.shared.component.IdentifiedComponent, net.shibboleth.shared.component.InitializableComponent

@ThreadSafe
public class AcceptStringValueValidator
extends BaseStringValueValidator
implements Validator<String>

A Validator that accepts a fixed String value. This validator returns Validator.Action.DONE if the value is matched, thus terminating any validator sequence.

Since:

0.10.0

Nested Class Summary

Nested classes/interfaces inherited from interface net.shibboleth.metadata.validate.Validator

Validator.Action

Constructor Summary

Constructors

Constructor	Description
AcceptStringValueValidator()

Method Summary

Modifier and Type	Method	Description
Validator.Action	validate(String e, Item<?> item, String callerId)	Apply the validator to a value in the context of the given Item.

Methods inherited from class net.shibboleth.metadata.validate.string.BaseStringValueValidator

doInitialize, getValue, setValue

Methods inherited from class net.shibboleth.metadata.validate.BaseValidator

addError, addErrorMessage, addErrorMessage, addErrorMessage, addStatus, addWarning, getMessage, makeComponentId, setMessage

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, 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.shared.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.shared.component.IdentifiableComponent

setId

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.metadata.validate.Validator

validate

Constructor Details

AcceptStringValueValidator

public AcceptStringValueValidator()

Method Details

validate

@Nonnull
public Validator.Action validate(@Nonnull
 String e,
 @Nonnull
 Item<?> item,
 @Nonnull
 String callerId)

Description copied from interface: Validator

Apply the validator to a value in the context of the given Item.

The validator influences future processing by adding item metadata to the Item.

A common case is that the validator will add a StatusMetadata to the Item, for example a ErrorStatus. In this case, the convention is that the componentId of the ErrorStatus would be created by combining the callerId with a / and the validator's own identifier. For example, a validator val called by a stage stage would normally use a componentId of stage/val.

Specified by:

validate in interface Validator<String>

Parameters:

e - the value to be validated

item - the Item context for the validation

callerId - a String identifying the caller

Returns:

an indication of whether to process additional validators