Delete script
|
Connectors continue to be released outside the IDM release. For the latest documentation, refer to the ICF documentation. |
A delete script deletes an object in the external resource. Connectors that do not support delete operations should throw an UnsupportedOperationException.
A sample delete script for an SQL database is provided in openidm/samples/scripted-sql-with-mysql/tools/DeleteScript.groovy.
- Input variables
-
The following variables are available to an update script:
- configuration
-
A handler to the connector’s configuration object.
- options
-
A handler to the Operation Options.
- operation
-
An OperationType that corresponds to the action (
DELETE). - objectClass
-
The object class that is deleted, such as
__ACCOUNT__or__GROUP__. - uid
-
The UID of the object to be deleted. The UID corresponds to the OpenICF
__UID__attribute. - log
-
A logger instance for the connector.
- Returns
-
This script has no return value but should throw an exception if the delete is unsuccessful.