--- title: Groovy Connector Toolkit description: Connectors continue to be released outside the IDM release. For the latest documentation, refer to the OpenICF documentation. component: pingidm version: 7.2 page_id: pingidm:connector-reference:groovy canonical_url: https://docs.pingidentity.com/pingidm/7.2/connector-reference/groovy.html section_ids: groovy-connectors: Configure scripted Groovy connectors groovy-connection-validation: Validate pooled connections groovy-custom-properties: Use custom properties in scripts debugging-groovy-scripts: Debug Groovy scripts script-compilation: Script compilation and caching groovy-connector-interfaces: Implemented interfaces implemented-interfaces-org-forgerock-openicf-connectors-groovy-ScriptedConnector-1.5.20.15: OpenICF Interfaces Implemented by the Scripted Groovy Connector implemented-interfaces-org-forgerock-openicf-connectors-groovy-ScriptedPoolableConnector-1.5.20.15: OpenICF Interfaces Implemented by the Scripted Poolable Groovy Connector groovy-connector-configuration: Configuration properties config-properties-org-forgerock-openicf-connectors-groovy-ScriptedConnector-1.5.20.15: Scripted Groovy Connector Configuration configuration-properties-org-forgerock-openicf-connectors-groovy-ScriptedConnector-1.5.20.15: Configuration properties operation-script-files-org-forgerock-openicf-connectors-groovy-ScriptedConnector-1.5.20.15: Operation Script Files groovy-engine-configuration-org-forgerock-openicf-connectors-groovy-ScriptedConnector-1.5.20.15: Groovy Engine configuration config-properties-org-forgerock-openicf-connectors-groovy-ScriptedPoolableConnector-1.5.20.15: Scripted Poolable Groovy Connector Configuration configuration-properties-org-forgerock-openicf-connectors-groovy-ScriptedPoolableConnector-1.5.20.15: Configuration properties operation-script-files-org-forgerock-openicf-connectors-groovy-ScriptedPoolableConnector-1.5.20.15: Operation Script Files groovy-engine-configuration-org-forgerock-openicf-connectors-groovy-ScriptedPoolableConnector-1.5.20.15: Groovy Engine configuration --- # Groovy Connector Toolkit | | | | - | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | Connectors continue to be released outside the IDM release. For the latest documentation, refer to the [OpenICF documentation](https://docs.pingidentity.com/openicf/index.html). | The generic Groovy Connector Toolkit runs a Groovy script for any OpenICF operation, such as search, update, create, and others, on any external resource. The Groovy Connector Toolkit is not a complete connector in the traditional sense. Rather, it is a framework within which you must write your own Groovy scripts to address the requirements of your implementation. ## Configure scripted Groovy connectors You cannot configure a scripted Groovy connector through the UI. Configure the connector over REST, as described in [Configure Connectors Over REST](configure-connector.html#connector-wiz-REST). Alternatively, create a connector configuration file in your project's `conf` directory. A number of sample configurations for scripted Groovy implementations are provided in `openidm/samples/example-configurations/provisioners/provisioner.openicf-scriptedimplementation.json`. Use these as the basis for configuring your own scripted connector. The [Samples](../samples-guide/preface.html) describes a number of scripted connector implementations. The scripts provided with these samples demonstrate how the Groovy Connector Toolkit can be used. These scripts cannot be used as is in your deployment, but are a good starting point from which to base your customization. For information about writing your own scripts, see [Scripted connectors with Groovy](../connector-dev-guide/groovy-connectors.html). ### Validate pooled connections The scripted SQL connector uses the [Tomcat JDBC Connection Pool](https://tomcat.apache.org/tomcat-9.0-doc/jdbc-pool.html) to manage its connections. Occasionally, a JDBC resource accessed by the scripted SQL connector might become unavailable for a period. When the resource comes back online, IDM is able to recover automatically and resume operations. However, the connector might not be able to refresh its connection pool and might then pass a closed connection to its scripts. This can affect operations until IDM is restarted. To avoid this situation, you can configure *connection validation*, where connections are validated before being borrowed from the connection pool. To configure connection validation, add the following properties to the `configurationProperties` object in your connector configuration: * `testOnBorrow` Validates the connection object before it is borrowed from the pool. If the object fails to validate, it is dropped from the pool and the connector attempts to borrow another object. For this property to have an effect, you must set `validationQuery` to a non-null string. * `validationQuery` The SQL query used to validate connections from the pool before returning them to the caller. The precise query will differ, depending on the database that you are accessing. The following list provides sample queries for common databases: * HyperSQL DataBase (HSQLDB) ```sql select 1 from INFORMATION_SCHEMA.SYSTEM_USERS ``` * Oracle DB ```sql select 1 from dual ``` * DB2 ```sql select 1 from sysibm.sysdummy1 ``` * MySQL ```sql select 1 ``` * Microsoft SQL ```sql select 1 ``` * PostgreSQL ```sql select 1 ``` * Ingres Database ```sql select 1 ``` * Apache Derby ```sql values 1 ``` * H2 Database ```sql select 1 ``` * Firebird SQL ```sql select 1 from rdb$database ``` * `validationInterval` Specifies the maximum frequency (in milliseconds) at which validation is run. If a connection is due for validation but was previously validated within this interval, it is not validated again. The larger the value, the better the connector performance. However, with a large value you increase the chance of a stale connection being presented to the connector. Connection validation can have an impact on performance and should not be done too frequently. With the following configuration, connections are validated no more than every 34 seconds: ```json { ... "configurationProperties" : { ... "testOnBorrow" : true, "validationQuery" : "select 1 from dual", "validationInterval" : 34000, ... }, ... } ``` ### Use custom properties in scripts The `customConfiguration` and `customSensitiveConfiguration` properties enable you to inject custom properties into your scripts. Properties listed in `customSensitiveConfiguration` are encrypted. For example, the following excerpt of the scripted Kerberos provisioner file shows how these properties inject the Kerberos user and encrypted password into the scripts, using the `kadmin` command. ```json "customConfiguration" : "kadmin { cmd = '/usr/sbin/kadmin.local'; user=''; default_realm='' }", "customSensitiveConfiguration" : "kadmin { password = ''}", ``` ### Debug Groovy scripts When you call a Groovy script from the Groovy connector, you can use the SLF4J logging facility to obtain debug information. For instructions on how to use this facility, see the KnowledgeBase article [How do I add logging to Groovy scripts in IDM](https://backstage.forgerock.com/knowledge/kb/article/a40713338). ### Script compilation and caching The first time a script is read, it is compiled (from Groovy script to Java bytecode) and cached in memory. Each time the script is called, the Groovy script engine checks the last modified of the script file to see if it has changed. If it has not changed, the cached bytecode is executed. If it has changed, the script is reloaded, compiled and cached. ## Implemented interfaces The following tables list the OpenICF interfaces that are implemented for non-poolable and poolable connector implementations: ### OpenICF Interfaces Implemented by the Scripted Groovy Connector The Scripted Groovy Connector implements the following OpenICF interfaces. For additional details, see [OpenICF interfaces](interfaces.html): * Authenticate Provides simple authentication with two parameters, presumed to be a user name and password. * Create Creates an object and its `uid`. * Delete Deletes an object, referenced by its `uid`. * Resolve Username Resolves an object by its username and returns the `uid` of the object. * Schema Describes the object types, operations, and options that the connector supports. * Script on Connector Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: * The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. * The script has access to a `connector` variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. * The script has access to any script arguments passed in by the application. * Script on Resource Runs a script on the target resource that is managed by this connector. * Search Searches the target resource for all objects that match the specified object class and filter. * Sync Polls the target resource for synchronization events, that is, native changes to objects on the target resource. * Test Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. * Update Updates (modifies or replaces) objects on a target resource. ### OpenICF Interfaces Implemented by the Scripted Poolable Groovy Connector The Scripted Poolable Groovy Connector implements the following OpenICF interfaces. For additional details, see [OpenICF interfaces](interfaces.html): * Authenticate Provides simple authentication with two parameters, presumed to be a user name and password. * Create Creates an object and its `uid`. * Delete Deletes an object, referenced by its `uid`. * Resolve Username Resolves an object by its username and returns the `uid` of the object. * Schema Describes the object types, operations, and options that the connector supports. * Script on Connector Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: * The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. * The script has access to a `connector` variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. * The script has access to any script arguments passed in by the application. * Script on Resource Runs a script on the target resource that is managed by this connector. * Search Searches the target resource for all objects that match the specified object class and filter. * Sync Polls the target resource for synchronization events, that is, native changes to objects on the target resource. * Test Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. * Update Updates (modifies or replaces) objects on a target resource. ## Configuration properties The following tables list the configuration properties for non-poolable and poolable connector implementations: ### Scripted Groovy Connector Configuration The Scripted Groovy Connector has the following configurable properties: #### Configuration properties | Property | Type | Default | Encrypted(1) | Required(2) | | -------------------------------------------------------------- | --------------- | ------- | ------------------------ | ------------------------ | | `customSensitiveConfiguration` | `GuardedString` | `null` | [icon: lock, set=fas]Yes | [icon: times, set=fas]No | | Custom Sensitive Configuration script for Groovy ConfigSlurper | | | | | | `customConfiguration` | `String` | `null` | | [icon: times, set=fas]No | | Custom Configuration script for Groovy ConfigSlurper | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations. #### Operation Script Files | Property | Type | Default | Encrypted(1) | Required(2) | | ----------------------------------------------------------------------------------------------------- | -------- | ------- | ------------ | ------------------------------------------------------------------------------------------------------ | | `createScriptFileName` | `String` | `null` | | * [\[interface-CreateApiOp\]](#interface-CreateApiOp) | | The name of the file used to perform the CREATE operation. | | | | | | `customizerScriptFileName` | `String` | `null` | | [icon: times, set=fas]No | | The script used to customize some function of the connector. Read the documentation for more details. | | | | | | `authenticateScriptFileName` | `String` | `null` | | - [\[interface-AuthenticationApiOp\]](#interface-AuthenticationApiOp) | | The name of the file used to perform the AUTHENTICATE operation. | | | | | | `scriptOnResourceScriptFileName` | `String` | `null` | | * [\[interface-ScriptOnResourceApiOp\]](#interface-ScriptOnResourceApiOp) | | The name of the file used to perform the RUNSCRIPTONRESOURCE operation. | | | | | | `deleteScriptFileName` | `String` | `null` | | - [\[interface-DeleteApiOp\]](#interface-DeleteApiOp) | | The name of the file used to perform the DELETE operation. | | | | | | `resolveUsernameScriptFileName` | `String` | `null` | | * [\[interface-ResolveUsernameApiOp\]](#interface-ResolveUsernameApiOp) | | The name of the file used to perform the RESOLVE\_USERNAME operation. | | | | | | `searchScriptFileName` | `String` | `null` | | - [\[interface-GetApiOp\]](#interface-GetApiOp) - [\[interface-SearchApiOp\]](#interface-SearchApiOp) | | The name of the file used to perform the SEARCH operation. | | | | | | `updateScriptFileName` | `String` | `null` | | * [\[interface-UpdateApiOp\]](#interface-UpdateApiOp) | | The name of the file used to perform the UPDATE operation. | | | | | | `schemaScriptFileName` | `String` | `null` | | - [\[interface-SchemaApiOp\]](#interface-SchemaApiOp) | | The name of the file used to perform the SCHEMA operation. | | | | | | `testScriptFileName` | `String` | `null` | | * [\[interface-TestApiOp\]](#interface-TestApiOp) | | The name of the file used to perform the TEST operation. | | | | | | `syncScriptFileName` | `String` | `null` | | - [\[interface-SyncApiOp\]](#interface-SyncApiOp) | | The name of the file used to perform the SYNC operation. | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations. #### Groovy Engine configuration | Property | Type | Default | Encrypted(1) | Required(2) | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ------------ | ------------ | ------------------------- | | `targetDirectory` | `File` | `null` | | [icon: times, set=fas]No | | Directory into which to write classes. | | | | | | `warningLevel` | `int` | `1` | | [icon: times, set=fas]No | | Warning Level of the compiler | | | | | | `scriptExtensions` | `String[]` | `['groovy']` | | [icon: times, set=fas]No | | Gets the extensions used to find groovy files | | | | | | `minimumRecompilationInterval` | `int` | `100` | | [icon: times, set=fas]No | | Sets the minimum of time after a script can be recompiled. | | | | | | `scriptBaseClass` | `String` | `null` | | [icon: times, set=fas]No | | Base class name for scripts (must derive from Script) | | | | | | `scriptRoots` | `String[]` | `null` | | [icon: check, set=fas]Yes | | The root folder to load the scripts from. If the value is null or empty the classpath value is used. | | | | | | `tolerance` | `int` | `10` | | [icon: times, set=fas]No | | The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted. | | | | | | `debug` | `boolean` | `false` | | [icon: times, set=fas]No | | If true, debugging code should be activated | | | | | | `classpath` | `String[]` | `[]` | | [icon: times, set=fas]No | | Classpath for use during compilation. | | | | | | `disabledGlobalASTTransformations` | `String[]` | `null` | | [icon: times, set=fas]No | | Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled. | | | | | | `verbose` | `boolean` | `false` | | [icon: times, set=fas]No | | If true, the compiler should produce action information | | | | | | `sourceEncoding` | `String` | `UTF-8` | | [icon: times, set=fas]No | | Encoding for source files | | | | | | `recompileGroovySource` | `boolean` | `false` | | [icon: times, set=fas]No | | If set to true recompilation is enabled | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations. ### Scripted Poolable Groovy Connector Configuration The Scripted Poolable Groovy Connector has the following configurable properties: #### Configuration properties | Property | Type | Default | Encrypted(1) | Required(2) | | -------------------------------------------------------------- | --------------- | ------- | ------------------------ | ------------------------ | | `customSensitiveConfiguration` | `GuardedString` | `null` | [icon: lock, set=fas]Yes | [icon: times, set=fas]No | | Custom Sensitive Configuration script for Groovy ConfigSlurper | | | | | | `customConfiguration` | `String` | `null` | | [icon: times, set=fas]No | | Custom Configuration script for Groovy ConfigSlurper | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations. #### Operation Script Files | Property | Type | Default | Encrypted(1) | Required(2) | | ----------------------------------------------------------------------------------------------------- | -------- | ------- | ------------ | ------------------------------------------------------------------------------------------------------ | | `createScriptFileName` | `String` | `null` | | * [\[interface-CreateApiOp\]](#interface-CreateApiOp) | | The name of the file used to perform the CREATE operation. | | | | | | `customizerScriptFileName` | `String` | `null` | | [icon: times, set=fas]No | | The script used to customize some function of the connector. Read the documentation for more details. | | | | | | `authenticateScriptFileName` | `String` | `null` | | - [\[interface-AuthenticationApiOp\]](#interface-AuthenticationApiOp) | | The name of the file used to perform the AUTHENTICATE operation. | | | | | | `scriptOnResourceScriptFileName` | `String` | `null` | | * [\[interface-ScriptOnResourceApiOp\]](#interface-ScriptOnResourceApiOp) | | The name of the file used to perform the RUNSCRIPTONRESOURCE operation. | | | | | | `deleteScriptFileName` | `String` | `null` | | - [\[interface-DeleteApiOp\]](#interface-DeleteApiOp) | | The name of the file used to perform the DELETE operation. | | | | | | `resolveUsernameScriptFileName` | `String` | `null` | | * [\[interface-ResolveUsernameApiOp\]](#interface-ResolveUsernameApiOp) | | The name of the file used to perform the RESOLVE\_USERNAME operation. | | | | | | `searchScriptFileName` | `String` | `null` | | - [\[interface-GetApiOp\]](#interface-GetApiOp) - [\[interface-SearchApiOp\]](#interface-SearchApiOp) | | The name of the file used to perform the SEARCH operation. | | | | | | `updateScriptFileName` | `String` | `null` | | * [\[interface-UpdateApiOp\]](#interface-UpdateApiOp) | | The name of the file used to perform the UPDATE operation. | | | | | | `schemaScriptFileName` | `String` | `null` | | - [\[interface-SchemaApiOp\]](#interface-SchemaApiOp) | | The name of the file used to perform the SCHEMA operation. | | | | | | `testScriptFileName` | `String` | `null` | | * [\[interface-TestApiOp\]](#interface-TestApiOp) | | The name of the file used to perform the TEST operation. | | | | | | `syncScriptFileName` | `String` | `null` | | - [\[interface-SyncApiOp\]](#interface-SyncApiOp) | | The name of the file used to perform the SYNC operation. | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations. #### Groovy Engine configuration | Property | Type | Default | Encrypted(1) | Required(2) | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ------------ | ------------ | ------------------------- | | `targetDirectory` | `File` | `null` | | [icon: times, set=fas]No | | Directory into which to write classes. | | | | | | `warningLevel` | `int` | `1` | | [icon: times, set=fas]No | | Warning Level of the compiler | | | | | | `scriptExtensions` | `String[]` | `['groovy']` | | [icon: times, set=fas]No | | Gets the extensions used to find groovy files | | | | | | `minimumRecompilationInterval` | `int` | `100` | | [icon: times, set=fas]No | | Sets the minimum of time after a script can be recompiled. | | | | | | `scriptBaseClass` | `String` | `null` | | [icon: times, set=fas]No | | Base class name for scripts (must derive from Script) | | | | | | `scriptRoots` | `String[]` | `null` | | [icon: check, set=fas]Yes | | The root folder to load the scripts from. If the value is null or empty the classpath value is used. | | | | | | `tolerance` | `int` | `10` | | [icon: times, set=fas]No | | The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted. | | | | | | `debug` | `boolean` | `false` | | [icon: times, set=fas]No | | If true, debugging code should be activated | | | | | | `classpath` | `String[]` | `[]` | | [icon: times, set=fas]No | | Classpath for use during compilation. | | | | | | `disabledGlobalASTTransformations` | `String[]` | `null` | | [icon: times, set=fas]No | | Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled. | | | | | | `verbose` | `boolean` | `false` | | [icon: times, set=fas]No | | If true, the compiler should produce action information | | | | | | `sourceEncoding` | `String` | `UTF-8` | | [icon: times, set=fas]No | | Encoding for source files | | | | | | `recompileGroovySource` | `boolean` | `false` | | [icon: times, set=fas]No | | If set to true recompilation is enabled | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations.