org.forgerock.openam.scripting.service

Class ScriptConfigurationService

java.lang.Object

org.forgerock.openam.scripting.service.ScriptConfigurationService

All Implemented Interfaces:

ServiceListener, ScriptingService

public class ScriptConfigurationService
extends Object
implements ScriptingService, ServiceListener

The ScriptConfigurationService for access to the persisted ScriptConfiguration instances. It is the layer on top of the ScriptConfigurationDataStore.

Since:

13.0.0

Field Summary

Fields inherited from interface com.sun.identity.sm.ServiceListener

ADDED, MODIFIED, REMOVED

Constructor Summary

Constructors

Constructor and Description
ScriptConfigurationService(org.slf4j.Logger logger, String realm, CoreWrapper coreWrapper, ServiceConfigManager scm) Construct a new instance of ScriptConfigurationService.

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.
void	globalConfigChanged(String serviceName, String version, String groupName, String serviceComponent, int type)
void	organizationConfigChanged(String serviceName, String version, String orgName, String groupName, String serviceComponent, int type)
void	schemaChanged(String serviceName, String version)
ScriptConfiguration	update(ScriptConfiguration config, Subject subject) Update the given scripting configuration and persist it.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptConfigurationService

@Inject
public ScriptConfigurationService(org.slf4j.Logger logger,
                                          String realm,
                                          CoreWrapper coreWrapper,
                                          ServiceConfigManager scm)

Construct a new instance of ScriptConfigurationService.

Parameters:

logger - The logger log any error and debug messages to.

realm - The realm in which the ScriptConfiguration resides in.

coreWrapper - Wrapper for access to core services.

Method Detail

create

public ScriptConfiguration create(ScriptConfiguration config,
                                  Subject subject)
                           throws ScriptException

Description copied from interface: ScriptingService

Create the scripting configuration and persist it.

Specified by:

create in interface ScriptingService

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

update

public ScriptConfiguration update(ScriptConfiguration config,
                                  Subject subject)
                           throws ScriptException

Description copied from interface: ScriptingService

Update the given scripting configuration and persist it.

Specified by:

update in interface ScriptingService

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

delete

public void delete(String uuid)
            throws ScriptException

Description copied from interface: ScriptingService

Delete the configuration with the given UUID.

Specified by:

delete in interface ScriptingService

Parameters:

uuid - The unique identifier for the configuration.

Throws:

ScriptException - if the operation was not successful

getAll

public Set<ScriptConfiguration> getAll()

Description copied from interface: ScriptingService

Retrieve the stored configuration.

Specified by:

getAll in interface ScriptingService

Returns:

A set of configuration objects.

get

public ScriptConfiguration get(String uuid)
                        throws ScriptException

Description copied from interface: ScriptingService

Retrieve the stored configuration.

Specified by:

get in interface ScriptingService

Returns:

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

Throws:

ScriptException - if the operation was not successful

get

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

Description copied from interface: ScriptingService

Retrieve the stored configuration.

Specified by:

get in interface ScriptingService

Returns:

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

schemaChanged

public void schemaChanged(String serviceName,
                          String version)

Specified by:

schemaChanged in interface ServiceListener

globalConfigChanged

public void globalConfigChanged(String serviceName,
                                String version,
                                String groupName,
                                String serviceComponent,
                                int type)

Specified by:

globalConfigChanged in interface ServiceListener

organizationConfigChanged

public void organizationConfigChanged(String serviceName,
                                      String version,
                                      String orgName,
                                      String groupName,
                                      String serviceComponent,
                                      int type)

Specified by:

organizationConfigChanged in interface ServiceListener