net.shibboleth.idp.admin.impl

Class UnlockPrivateKeys

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.admin.impl.UnlockPrivateKeys

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.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 UnlockPrivateKeys
extends net.shibboleth.idp.profile.AbstractProfileAction

Action that creates private key objects and injects them into existing MutableCredential objects.

An error event will be signaled after the first unsuccessful unlock operation.

Since:

3.4.0

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.INVALID_MESSAGE

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<org.opensaml.security.credential.MutableCredential>	credentials Credentials to operate on.
static String	KEY_PASSWORD_PARAM_NAME Name of private key password parameter.
private Collection<org.springframework.core.io.Resource>	keyResources Keys to load.
private Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
UnlockPrivateKeys() Constructor.

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	setCredentials(Collection<org.opensaml.security.credential.MutableCredential> creds) Set the credentials to load keys into.
void	setKeyResources(Collection<org.springframework.core.io.Resource> keys) Set the key resources to load.

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

KEY_PASSWORD_PARAM_NAME

@Nonnull
@NotEmpty
public static final String KEY_PASSWORD_PARAM_NAME

Name of private key password parameter.

See Also:

Constant Field Values

log

@Nonnull
private Logger log

Class logger.

credentials

@Nonnull
@NonnullElements
private Collection<org.opensaml.security.credential.MutableCredential> credentials

Credentials to operate on.

keyResources

@Nonnull
@NonnullElements
private Collection<org.springframework.core.io.Resource> keyResources

Keys to load.

Constructor Detail

UnlockPrivateKeys

public UnlockPrivateKeys()

Constructor.

Method Detail

setCredentials

public void setCredentials(@Nullable@NonnullElements
                  Collection<org.opensaml.security.credential.MutableCredential> creds)

Set the credentials to load keys into.

Parameters:

creds - credentials to load keys into

setKeyResources

public void setKeyResources(@Nullable@NonnullElements
                   Collection<org.springframework.core.io.Resource> keys)

Set the key resources to load.

Parameters:

keys - key resources to load

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doPreExecute

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

Overrides:

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

doExecute

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

Overrides:

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