net.shibboleth.idp.profile.interceptor

Class ProfileInterceptorFlowDescriptor

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.idp.profile.interceptor.ProfileInterceptorFlowDescriptor

All Implemented Interfaces:

com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>, 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

public class ProfileInterceptorFlowDescriptor
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
implements com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>

A descriptor for a profile interceptor flow.

A profile interceptor flow is designed to be injected into a profile flow to facilitate customization of the profile flow. A profile interceptor flow must include an activation predicate to indicate suitability based on the content of the ProfileRequestContext.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>	activationCondition Predicate that must be true for this flow to be usable for a given request.
static String	FLOW_ID_PREFIX Prefix convention for flow IDs.
private org.opensaml.storage.StorageService	storageService Storage service for the results generated by this flow.
private boolean	supportsNonBrowser Whether this flow supports non-browser clients.

Constructor Summary

Constructors

Constructor and Description
ProfileInterceptorFlowDescriptor() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(org.opensaml.profile.context.ProfileRequestContext input)
boolean	equals(Object obj)
org.opensaml.storage.StorageService	getStorageService() Get the storage service.
int	hashCode()
boolean	isNonBrowserSupported() Get whether this flow supports non-browser clients.
void	setActivationCondition(com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext> condition) Set the activation condition in the form of a Predicate such that iff the condition evaluates to true should the corresponding flow be allowed/possible.
void	setNonBrowserSupported(boolean isSupported) Set whether this flow supports non-browser clients.
void	setStorageService(org.opensaml.storage.StorageService service) Set the storage service.
String	toString()

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, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getId

Field Detail

FLOW_ID_PREFIX

@Nonnull
@NotEmpty
public static final String FLOW_ID_PREFIX

Prefix convention for flow IDs.

See Also:

Constant Field Values

activationCondition

@Nonnull
private com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext> activationCondition

Predicate that must be true for this flow to be usable for a given request.

storageService

@Nullable
private org.opensaml.storage.StorageService storageService

Storage service for the results generated by this flow.

supportsNonBrowser

private boolean supportsNonBrowser

Whether this flow supports non-browser clients.

Constructor Detail

ProfileInterceptorFlowDescriptor

public ProfileInterceptorFlowDescriptor()

Constructor.

Method Detail

setActivationCondition

public void setActivationCondition(@Nonnull
                          com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext> condition)

Set the activation condition in the form of a Predicate such that iff the condition evaluates to true should the corresponding flow be allowed/possible.

Parameters:

condition - predicate that controls activation of the flow

isNonBrowserSupported

public boolean isNonBrowserSupported()

Get whether this flow supports non-browser clients.

Returns:

whether this flow supports non-browser clients

setNonBrowserSupported

public void setNonBrowserSupported(boolean isSupported)

Set whether this flow supports non-browser clients.

Parameters:

isSupported - whether this flow supports non-browser clients

getStorageService

@Nullable
public org.opensaml.storage.StorageService getStorageService()

Get the storage service.

Returns:

the storage service

setStorageService

public void setStorageService(@Nonnull
                     org.opensaml.storage.StorageService service)

Set the storage service.

Parameters:

service - the storage service

apply

public boolean apply(org.opensaml.profile.context.ProfileRequestContext input)

Specified by:

apply in interface com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.common.base.Predicate<org.opensaml.profile.context.ProfileRequestContext>

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object