net.shibboleth.idp.attribute.resolver

Interface ResolverPlugin<ResolvedType>

Type Parameters:

ResolvedType - object type this plug-in resolves to

All Superinterfaces:

Component, DestructableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent

All Known Subinterfaces:

AttributeDefinition, DataConnector, DataConnectorEx

All Known Implementing Classes:

AbstractAttributeDefinition, AbstractDataConnector, AbstractResolverPlugin, ResolvedAttributeDefinition, ResolvedDataConnector

@ThreadSafe
public interface ResolverPlugin<ResolvedType>
extends UnmodifiableComponent, InitializableComponent, DestructableComponent, IdentifiedComponent

Interface defining the base work done by all plugins used within attribute resolution.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.base.Predicate<ProfileRequestContext>	getActivationCondition() Get the predicate which defines whether this plugin is active for a given request.
Set<ResolverPluginDependency>	getDependencies() Get the unmodifiable list of dependencies for this plugin.
boolean	isPropagateResolutionExceptions() Get whether a ResolutionException that occurred resolving attributes will be re-thrown.
ResolvedType	resolve(AttributeResolutionContext resolutionContext) Perform the attribute resolution for this plugin.

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

initialize, isInitialized

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

destroy, isDestroyed

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

getId

Method Detail

isPropagateResolutionExceptions

boolean isPropagateResolutionExceptions()

Get whether a ResolutionException that occurred resolving attributes will be re-thrown. Doing so will cause the entire attribute resolution request to fail.

Returns:

true if ResolutionExceptions are propagated, false if not

getActivationCondition

@Nullable
com.google.common.base.Predicate<ProfileRequestContext> getActivationCondition()

Get the predicate which defines whether this plugin is active for a given request.

Returns:

the predicate.

getDependencies

@NonnullAfterInit
@NonnullElements
@Unmodifiable
Set<ResolverPluginDependency> getDependencies()

Get the unmodifiable list of dependencies for this plugin.

Returns:

unmodifiable list of dependencies for this plugin, never null

resolve

@Nullable
ResolvedType resolve(@Nonnull
                            AttributeResolutionContext resolutionContext)
                     throws ResolutionException

Perform the attribute resolution for this plugin.

Parameters:

resolutionContext - current attribute resolution context

Returns:

the attributes made available by the resolution, or null if no attributes were resolved

Throws:

ResolutionException - thrown if there was a problem resolving the attributes