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

Class BeanMetadataPolicyOperator

java.lang.Object

net.shibboleth.oidc.metadata.policy.impl.BeanMetadataPolicyOperator

All Implemented Interfaces:

CustomMetadataPolicyOperator, Aware, ApplicationContextAware

public class BeanMetadataPolicyOperator
extends Object
implements CustomMetadataPolicyOperator, ApplicationContextAware

A custom metadata policy operator that fetches a bean from ApplicationContext and uses it for as CustomMetadataPolicyOperator.

Since:

3.1.0

Field Summary

Fields

Modifier and Type	Field	Description
private ApplicationContext	applicationContext	The application context from where to fetch the custom policy operators.
static final String	BEAN_OPERATOR_NAME	The operator name to be used within MetadataPolicy custom operators.

Constructor Summary

Constructors

Constructor	Description
BeanMetadataPolicyOperator()

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.
protected CustomMetadataPolicyOperator	fetchPolicyOperatorBean(MetadataPolicy policy)	Fetch the bean from ApplicationContext via identifier set in the given policy.
void	setApplicationContext(ApplicationContext context)
boolean	validate(MetadataPolicy policy)	Validate whether the operator is compatible with the other operators in the policy.

Methods inherited from class java.lang.Object

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

Field Details

BEAN_OPERATOR_NAME

public static final String BEAN_OPERATOR_NAME

The operator name to be used within MetadataPolicy custom operators.

See Also:

• Constant Field Values

applicationContext

private ApplicationContext applicationContext

The application context from where to fetch the custom policy operators.

Constructor Details

BeanMetadataPolicyOperator

public BeanMetadataPolicyOperator()

Method Details

validate

public boolean validate(@Nonnull
 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,
 @Nonnull
 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.

fetchPolicyOperatorBean

@Nonnull
protected CustomMetadataPolicyOperator fetchPolicyOperatorBean(@Nonnull
 MetadataPolicy policy)
                                                        throws ConstraintViolationException

Fetch the bean from ApplicationContext via identifier set in the given policy.

Parameters:

policy - The metadata policy possibly containing the bean operator.

Returns:

The bean whose identifier matches the one given in the policy.

Throws:

ConstraintViolationException - If the matching bean could not be wired or its id could not be parsed.

setApplicationContext

public void setApplicationContext(@Nonnull
 ApplicationContext context)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException