net.shibboleth.idp.admin.impl

Class DoStorageOperation

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.DoStorageOperation

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, org.opensaml.profile.action.ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class DoStorageOperation
extends net.shibboleth.idp.profile.AbstractProfileAction

Action that implements a JSON REST API for accessing StorageService records.

The API supports GET and DELETE at the moment, using jsonapi.org conventions.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.IO_ERROR

Field Summary

Fields

Modifier and Type	Field and Description
private String	context Storage context to operate on.
static String	CONTEXT Flow variable indicating ID of storage context.
private String	key Storage key to operate on.
static String	KEY Flow variable indicating ID of storage key.
private Logger	log Class logger.
private com.fasterxml.jackson.databind.ObjectMapper	objectMapper JSON object mapper.
static String	SERVICE_ID Flow variable indicating ID of storage service bean to reload.
private org.opensaml.storage.StorageService	storageService StorageService to operate on.

Constructor Summary

Constructors

Constructor and Description
DoStorageOperation()

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)
private org.opensaml.storage.StorageService	getStorageService(RequestContext requestContext) Helper method to get the storage service bean to operate on.
private void	sendError(int status, String title, String detail) Output an error object.
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper) Set the JSON ObjectMapper to use for serialization.

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

SERVICE_ID

@Nonnull
@NotEmpty
public static final String SERVICE_ID

Flow variable indicating ID of storage service bean to reload.

See Also:

Constant Field Values

CONTEXT

@Nonnull
@NotEmpty
public static final String CONTEXT

Flow variable indicating ID of storage context.

See Also:

Constant Field Values

KEY

@Nonnull
@NotEmpty
public static final String KEY

Flow variable indicating ID of storage key.

See Also:

Constant Field Values

log

@Nonnull
private Logger log

Class logger.

objectMapper

@NonnullAfterInit
private com.fasterxml.jackson.databind.ObjectMapper objectMapper

JSON object mapper.

storageService

@Nullable
private org.opensaml.storage.StorageService storageService

StorageService to operate on.

context

@Nullable
@NotEmpty
private String context

Storage context to operate on.

key

@Nullable
@NotEmpty
private String key

Storage key to operate on.

Constructor Detail

DoStorageOperation

public DoStorageOperation()

Method Detail

setObjectMapper

public void setObjectMapper(@Nonnull
                   com.fasterxml.jackson.databind.ObjectMapper mapper)

Set the JSON ObjectMapper to use for serialization.

Parameters:

mapper - object mapper

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

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

getStorageService

@Nullable
private org.opensaml.storage.StorageService getStorageService(@Nonnull
                                                             RequestContext requestContext)

Helper method to get the storage service bean to operate on.

Parameters:

requestContext - current SWF request context

Returns:

storage service or null

sendError

private void sendError(int status,
             @Nonnull@NotEmpty
             String title,
             @Nonnull@NotEmpty
             String detail)
                throws IOException

Output an error object.

Parameters:

status - HTTP status

title - fixed error description

detail - human-readable error description

Throws:

IOException - if unable to output the error