org.forgerock.openam.scripting.service

Interface ScriptingService

All Known Implementing Classes:

ScriptConfigurationService

public interface ScriptingService

An interface for access to the persisted instances of the provided type. It is the layer on top of the ScriptingDataStore, which is responsible for access to all the persisted scripting related data.

Since:

13.0.0

Method Summary

Modifier and Type	Method and Description
ScriptConfiguration	create(ScriptConfiguration config, Subject subject) Create the scripting configuration and persist it.
void	delete(String uuid) Delete the configuration with the given UUID.
Set<ScriptConfiguration>	get(org.forgerock.util.query.QueryFilter<String> queryFilter) Retrieve the stored configuration.
ScriptConfiguration	get(String uuid) Retrieve the stored configuration.
Set<ScriptConfiguration>	getAll() Retrieve the stored configuration.
ScriptConfiguration	update(ScriptConfiguration config, Subject subject) Update the given scripting configuration and persist it.

Method Detail

create

ScriptConfiguration create(ScriptConfiguration config,
                           Subject subject)
                    throws ScriptException

Create the scripting configuration and persist it.

Parameters:

config - The configuration to create and persist.

subject - The subject that is creating the script configuration.

Returns:

The created configuration object.

Throws:

ScriptException - if the operation was not successful

delete

void delete(String uuid)
     throws ScriptException

Delete the configuration with the given UUID.

Parameters:

uuid - The unique identifier for the configuration.

Throws:

ScriptException - if the operation was not successful

getAll

Set<ScriptConfiguration> getAll()
                         throws ScriptException

Retrieve the stored configuration.

Returns:

A set of configuration objects.

Throws:

ScriptException - if the operation was not successful

get

Set<ScriptConfiguration> get(org.forgerock.util.query.QueryFilter<String> queryFilter)
                      throws ScriptException

Retrieve the stored configuration.

Returns:

The configuration object with the given UUID or null if it cannot be found.

Throws:

ScriptException - if the operation was not successful

get

ScriptConfiguration get(String uuid)
                 throws ScriptException

Retrieve the stored configuration.

Returns:

The configuration object with the given UUID or null if it cannot be found.

Throws:

ScriptException - if the operation was not successful

update

ScriptConfiguration update(ScriptConfiguration config,
                           Subject subject)
                    throws ScriptException

Update the given scripting configuration and persist it.

Parameters:

config - The configuration to update and persist.

subject - The subject that is updating the script configuration.

Returns:

The updated configuration object.

Throws:

ScriptException - if the operation was not successful