net.shibboleth.idp.saml.profile.impl

Class ReloadMetadata

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction<InboundMessageType,OutboundMessageType>

org.opensaml.profile.action.AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.saml.profile.impl.ReloadMetadata

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, org.opensaml.profile.action.ProfileAction, org.springframework.beans.factory.Aware, org.springframework.context.MessageSource, org.springframework.context.MessageSourceAware, org.springframework.webflow.execution.Action

public class ReloadMetadata
extends AbstractProfileAction

Action that refreshes a MetadataResolver manually.

The MetadataResolver to reload is indicated by supplying RESOLVER_ID as a flow variable.

On success, a 200 HTTP status with a simple response body is returned. On failure, a non-successful HTTP status is returned.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_MESSAGE, EventIds.INVALID_PROFILE_CTX, EventIds.IO_ERROR

Field Summary

Fields

Modifier and Type	Field and Description
private String	id Identifies bean to refresh.
private org.slf4j.Logger	log Class logger.
private ReloadableService<org.opensaml.saml.metadata.resolver.MetadataResolver>	metadataResolverService The service that contains the metadata.
static String	RESOLVER_ID Flow variable indicating ID of metadata provider bean to reload.

Constructor Summary

Constructors

Constructor and Description
ReloadMetadata()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
void	setMetadataResolver(ReloadableService<org.opensaml.saml.metadata.resolver.MetadataResolver> service) Set the service that describes the metadata.

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

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.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

RESOLVER_ID

@Nonnull
@NotEmpty
public static final String RESOLVER_ID

Flow variable indicating ID of metadata provider bean to reload.

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

metadataResolverService

@NonnullAfterInit
private ReloadableService<org.opensaml.saml.metadata.resolver.MetadataResolver> metadataResolverService

The service that contains the metadata.

id

@Nullable
private String id

Identifies bean to refresh.

Constructor Detail

ReloadMetadata

public ReloadMetadata()

Method Detail

setMetadataResolver

public void setMetadataResolver(@Nonnull
                       ReloadableService<org.opensaml.saml.metadata.resolver.MetadataResolver> service)

Set the service that describes the metadata.

Parameters:

service - what to set.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
                   org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class org.opensaml.profile.action.AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
             org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class org.opensaml.profile.action.AbstractProfileAction