Package net.shibboleth.sp.profile.impl

Class DoStorageOperation

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.sp.profile.AbstractAgentRequestAction

net.shibboleth.sp.profile.AbstractAgentAction

net.shibboleth.sp.profile.impl.DoStorageOperation

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class DoStorageOperation
extends AbstractAgentAction

Action that implements a remote API for SP agents to access or alter StorageService records.

All contexts are prefixed with IdentifiedComponent.getId() to prevent conflicts across agents.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.INVALID_MESSAGE, EventIds.IO_ERROR, DUPLICATE_RECORD, RECORD_NOT_FOUND, VERSION_MISMATCH

Precondition:

AgentRequestContext.getOutput().isstruct()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT	Input member for storage context.
static final String	DUPLICATE_RECORD	Custom event for duplicate record on creation.
static final String	EXP	Member for storage expiration.
private DDF	input	Input message.
static final String	KEY	Input member for storage key.
private org.slf4j.Logger	log	Class logger.
static final String	OP	Input member for operation.
private DDF	output	Output message.
static final String	RECORD_NOT_FOUND	Custom event for duplicate record on creation.
private StorageService	storageService	StorageService to operate on.
static final String	VALUE	Member for storage value.
static final String	VERSION	Member for storage version.
static final String	VERSION_MISMATCH	Custom event for version mismatch on conditional update.

Constructor Summary

Constructors

Constructor	Description
DoStorageOperation()

Method Summary

Modifier and Type	Method	Description
private void	doCreate(ProfileRequestContext profileRequestContext)	Perform create operation.
private void	doDelete(ProfileRequestContext profileRequestContext)	Perform delete operation.
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
private void	doRead(ProfileRequestContext profileRequestContext)	Perform read operation.
private void	doUpdate(ProfileRequestContext profileRequestContext)	Perform update operation.
void	setStorageService(StorageService storage)	Sets the StorageService to use.

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentAction

ensureAgent, getAgent

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentRequestAction

ensureAgentRequestContext, getAgentRequestContext, setAgentRequestContextLookupStrategy

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

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, 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, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, 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.shared.component.InitializableComponent

initialize, isInitialized

Field Details

RECORD_NOT_FOUND

@Nonnull
@NotEmpty
public static final String RECORD_NOT_FOUND

Custom event for duplicate record on creation.

See Also:

• Constant Field Values

DUPLICATE_RECORD

@Nonnull
@NotEmpty
public static final String DUPLICATE_RECORD

Custom event for duplicate record on creation.

See Also:

• Constant Field Values

VERSION_MISMATCH

@Nonnull
@NotEmpty
public static final String VERSION_MISMATCH

Custom event for version mismatch on conditional update.

See Also:

• Constant Field Values

OP

@Nonnull
@NotEmpty
public static final String OP

Input member for operation.

See Also:

• Constant Field Values

CONTEXT

@Nonnull
@NotEmpty
public static final String CONTEXT

Input member for storage context.

See Also:

• Constant Field Values

KEY

@Nonnull
@NotEmpty
public static final String KEY

Input member for storage key.

See Also:

• Constant Field Values

VALUE

@Nonnull
@NotEmpty
public static final String VALUE

Member for storage value.

See Also:

• Constant Field Values

EXP

@Nonnull
@NotEmpty
public static final String EXP

Member for storage expiration.

See Also:

• Constant Field Values

VERSION

@Nonnull
@NotEmpty
public static final String VERSION

Member for storage version.

See Also:

• Constant Field Values

log

@Nonnull
private org.slf4j.Logger log

Class logger.

storageService

@NonnullAfterInit
private StorageService storageService

StorageService to operate on.

input

@NonnullBeforeExec
private DDF input

Input message.

output

@NonnullBeforeExec
private DDF output

Output message.

Constructor Details

DoStorageOperation

public DoStorageOperation()

Method Details

setStorageService

public void setStorageService(@Nonnull
 StorageService storage)

Sets the StorageService to use.

Parameters:

storage - storage service

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractAgentAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

doCreate

private void doCreate(@Nonnull
 ProfileRequestContext profileRequestContext)
               throws IOException

Perform create operation.

Parameters:

profileRequestContext - profile request context

Throws:

IOException - if an error is raised

doRead

private void doRead(@Nonnull
 ProfileRequestContext profileRequestContext)
             throws IOException

Perform read operation.

Parameters:

profileRequestContext - profile request context

Throws:

IOException - if an error is raised

doUpdate

private void doUpdate(@Nonnull
 ProfileRequestContext profileRequestContext)
               throws IOException

Perform update operation.

Parameters:

profileRequestContext - profile request context

Throws:

IOException - if an error is raised

doDelete

private void doDelete(@Nonnull
 ProfileRequestContext profileRequestContext)
               throws IOException

Perform delete operation.

Parameters:

profileRequestContext - profile request context

Throws:

IOException - if an error is raised