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

Class DoClientManagementOperation

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

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

All Implemented Interfaces:

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

public class DoClientManagementOperation
extends AbstractAdminApiProfileAction

Action that implements a JSON REST API for querying and deleting OIDC client information.

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

Since:

3.1.0

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.IO_ERROR

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLIENT_ID	Flow variable indicating ID of storage key.
private String	clientId	Client ID to operate on.
private org.slf4j.Logger	log	Class logger.
private net.shibboleth.oidc.metadata.ClientInformationManager	manager	ClientInformationManager to operate on.
private net.shibboleth.oidc.metadata.ClientInformationResolver	resolver	ClientInformationResolver to operate on.

Constructor Summary

Constructors

Constructor	Description
DoClientManagementOperation()

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setClientInformationManager(net.shibboleth.oidc.metadata.ClientInformationManager theManager)	Set the ClientInformationManager to use for deletion.
void	setClientInformationResolver(net.shibboleth.oidc.metadata.ClientInformationResolver theResolver)	Set the ClientInformationResolver to use for retrieval.

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.admin.impl.AbstractAdminApiProfileAction

getObjectMapper, sendError, setObjectMapper

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

CLIENT_ID

@Nonnull
@NotEmpty
public static final String CLIENT_ID

Flow variable indicating ID of storage key.

See Also:

Constant Field Values

log

@Nonnull
private org.slf4j.Logger log

Class logger.

resolver

@NonnullAfterInit
private net.shibboleth.oidc.metadata.ClientInformationResolver resolver

ClientInformationResolver to operate on.

manager

@NonnullAfterInit
private net.shibboleth.oidc.metadata.ClientInformationManager manager

ClientInformationManager to operate on.

clientId

@Nullable
@NotEmpty
private String clientId

Client ID to operate on.

Constructor Detail

DoClientManagementOperation

public DoClientManagementOperation()

Method Detail

setClientInformationResolver

public void setClientInformationResolver(@Nonnull
                                         net.shibboleth.oidc.metadata.ClientInformationResolver theResolver)

Set the ClientInformationResolver to use for retrieval.

Parameters:

theResolver - client info resolver

setClientInformationManager

public void setClientInformationManager(@Nonnull
                                        net.shibboleth.oidc.metadata.ClientInformationManager theManager)

Set the ClientInformationManager to use for deletion.

Parameters:

theManager - client info manager

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractAdminApiProfileAction

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractAdminApiProfileAction

doExecute

protected void doExecute(ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction