Package org.identityconnectors.framework.spi.operations

Interface ScriptOnResourceOp

  • All Superinterfaces:
    SPIOperation
    public interface ScriptOnResourceOp
extends SPIOperation
    Operation that runs a script directly on a target resource. (Compare to ScriptOnConnectorOp, which runs a script in the context of a particular connector.)

    A connector that intends to support ScriptOnResourceApiOp should implement this interface. Each connector that implements this interface must document which script languages the connector supports, as well as any supported OperationOptions.

    • Method Detail

      • runScriptOnResource

        Object runScriptOnResource​(ScriptContext request,
                           OperationOptions options)
        Run the specified script on the target resource that this connector manages.
        Parameters:
        request - The script and arguments to run.
        options - Additional options that control how the script is run.
        Returns:
        The result of the script. The return type must be a type that the framework supports for serialization. See ObjectSerializerFactory for a list of supported types.