Package net.shibboleth.idp.plugin.oidc.op.admin.impl

Class AbstractAdminApiProfileAction

java.lang.Object

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

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.plugin.oidc.op.admin.impl.AbstractAdminApiProfileAction

All Implemented Interfaces:

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

Direct Known Subclasses:

DoClientManagementOperation, IssueRegistrationAccessToken

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

Base class for admin flow actions producing JSON responses.

Event:

EventIds.INVALID_PROFILE_CTX

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	Class logger.
private com.fasterxml.jackson.databind.ObjectMapper	objectMapper	JSON object mapper.

Constructor Summary

Constructors

Constructor	Description
AbstractAdminApiProfileAction()

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()	Get the JSON ObjectMapper to use for serialization.
protected 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

doExecute, 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

log

@Nonnull
private org.slf4j.Logger log

Class logger.

objectMapper

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

JSON object mapper.

Constructor Detail

AbstractAdminApiProfileAction

public AbstractAdminApiProfileAction()

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

getObjectMapper

@NonnullAfterInit
public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Get the JSON ObjectMapper to use for serialization.

Returns:

The JSON ObjectMapper to use for serialization.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

sendError

protected 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