org.forgerock.openam.scripting.rest

Class ScriptResource

java.lang.Object

org.forgerock.openam.rest.SubjectAwareResource

org.forgerock.openam.rest.RealmAwareResource

org.forgerock.openam.scripting.rest.ScriptResource

All Implemented Interfaces:

org.forgerock.json.resource.CollectionResourceProvider

public class ScriptResource
extends RealmAwareResource

A REST endpoint for managing scripts in OpenAM.

Since:

13.0.0

Field Summary

Fields inherited from class org.forgerock.openam.rest.RealmAwareResource

EMPTY

Constructor Summary

Constructors

Constructor and Description
ScriptResource(org.slf4j.Logger logger, ScriptingServiceFactory scriptConfigService, ExceptionMappingHandler<ScriptException,org.forgerock.json.resource.ResourceException> exceptionMappingHandler, ScriptValidator scriptValidator) Creates an instance of the ScriptResource.

Method Summary

Modifier and Type	Method and Description
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException>	actionCollection(org.forgerock.services.context.Context context, org.forgerock.json.resource.ActionRequest request)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException>	actionInstance(org.forgerock.services.context.Context context, String resourceId, org.forgerock.json.resource.ActionRequest request)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	createInstance(org.forgerock.services.context.Context context, org.forgerock.json.resource.CreateRequest request)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	deleteInstance(org.forgerock.services.context.Context context, String resourceId, org.forgerock.json.resource.DeleteRequest request)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	patchInstance(org.forgerock.services.context.Context context, String resourceId, org.forgerock.json.resource.PatchRequest request)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,org.forgerock.json.resource.ResourceException>	queryCollection(org.forgerock.services.context.Context context, org.forgerock.json.resource.QueryRequest request, org.forgerock.json.resource.QueryResourceHandler resultHandler)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	readInstance(org.forgerock.services.context.Context context, String resourceId, org.forgerock.json.resource.ReadRequest request)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	updateInstance(org.forgerock.services.context.Context context, String resourceId, org.forgerock.json.resource.UpdateRequest request)

Methods inherited from class org.forgerock.openam.rest.RealmAwareResource

getRealm

Methods inherited from class org.forgerock.openam.rest.SubjectAwareResource

getContextSubject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptResource

@Inject
public ScriptResource(org.slf4j.Logger logger,
                              ScriptingServiceFactory scriptConfigService,
                              ExceptionMappingHandler<ScriptException,org.forgerock.json.resource.ResourceException> exceptionMappingHandler,
                              ScriptValidator scriptValidator)

Creates an instance of the ScriptResource.

Parameters:

scriptConfigService - An instance of the ScriptConfigurationService.

exceptionMappingHandler - An instance of the ExceptionMappingHandler.

Method Detail

actionCollection

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException> actionCollection(org.forgerock.services.context.Context context,
                                                                                                                                                     org.forgerock.json.resource.ActionRequest request)

actionInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException> actionInstance(org.forgerock.services.context.Context context,
                                                                                                                                                   String resourceId,
                                                                                                                                                   org.forgerock.json.resource.ActionRequest request)

patchInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> patchInstance(org.forgerock.services.context.Context context,
                                                                                                                                                    String resourceId,
                                                                                                                                                    org.forgerock.json.resource.PatchRequest request)

createInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> createInstance(org.forgerock.services.context.Context context,
                                                                                                                                                     org.forgerock.json.resource.CreateRequest request)

deleteInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> deleteInstance(org.forgerock.services.context.Context context,
                                                                                                                                                     String resourceId,
                                                                                                                                                     org.forgerock.json.resource.DeleteRequest request)

queryCollection

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,org.forgerock.json.resource.ResourceException> queryCollection(org.forgerock.services.context.Context context,
                                                                                                                                                   org.forgerock.json.resource.QueryRequest request,
                                                                                                                                                   org.forgerock.json.resource.QueryResourceHandler resultHandler)

readInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> readInstance(org.forgerock.services.context.Context context,
                                                                                                                                                   String resourceId,
                                                                                                                                                   org.forgerock.json.resource.ReadRequest request)

updateInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> updateInstance(org.forgerock.services.context.Context context,
                                                                                                                                                     String resourceId,
                                                                                                                                                     org.forgerock.json.resource.UpdateRequest request)