Package net.shibboleth.oidc.metadata.policy.impl

Class DefaultMetadataPolicyOperator

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.oidc.metadata.policy.impl.DefaultMetadataPolicyOperator

All Implemented Interfaces:

CustomMetadataPolicyOperator, Component, DestructableComponent, InitializableComponent

public class DefaultMetadataPolicyOperator
extends AbstractInitializableComponent
implements CustomMetadataPolicyOperator

A CustomMetadataPolicyOperator implementation that uses customizable Predicate for validating the metadata policy and BiFunction for performing the operation.

Since:

3.1.0

Field Summary

Fields

Modifier and Type	Field	Description
private Predicate<MetadataPolicy>	validator	The metadata policy validator.
private BiFunction<Object,MetadataPolicy,Object>	valueOperator	The metadata policy operator.

Constructor Summary

Constructors

Constructor	Description
DefaultMetadataPolicyOperator()

Method Summary

Modifier and Type	Method	Description
Object	apply(Object inputValue, MetadataPolicy policy)	Apply the operator for the given input that has the given metadata policy attached.
void	doInitialize()
void	setValidator(Predicate<MetadataPolicy> predicate)	Set the metadata policy validator.
void	setValueOperator(BiFunction<Object,MetadataPolicy,Object> function)	Set the metadata policy operator.
boolean	validate(MetadataPolicy policy)	Validate whether the operator is compatible with the other operators in the policy.

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

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Details

validator

@NonnullAfterInit
private Predicate<MetadataPolicy> validator

The metadata policy validator.

valueOperator

@NonnullAfterInit
private BiFunction<Object,MetadataPolicy,Object> valueOperator

The metadata policy operator.

Constructor Details

DefaultMetadataPolicyOperator

public DefaultMetadataPolicyOperator()

Method Details

setValidator

public void setValidator(@Nonnull
 Predicate<MetadataPolicy> predicate)

Set the metadata policy validator.

Parameters:

predicate - What to set.

setValueOperator

public void setValueOperator(@Nonnull
 BiFunction<Object,MetadataPolicy,Object> function)

Set the metadata policy operator.

Parameters:

function - What to set.

doInitialize

public void doInitialize()
                  throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

validate

public boolean validate(@Nullable
 MetadataPolicy policy)

Description copied from interface: CustomMetadataPolicyOperator

Validate whether the operator is compatible with the other operators in the policy.

Specified by:

validate in interface CustomMetadataPolicyOperator

Parameters:

policy - The metadata policy to be used by the custom policy operator.

Returns:

true if

apply

public Object apply(@Nullable
 Object inputValue,
 @Nullable
 MetadataPolicy policy)
             throws ConstraintViolationException

Description copied from interface: CustomMetadataPolicyOperator

Apply the operator for the given input that has the given metadata policy attached.

Specified by:

apply in interface CustomMetadataPolicyOperator

Parameters:

inputValue - The value to be used by the custom policy operator.

policy - The metadata policy to be used by the custom policy operator.

Returns:

The value returned by the custom policy operator.

Throws:

ConstraintViolationException - If the value-check of the custom operator fails.