public interface ScriptOnConnectorOp extends SPIOperation
ScriptOnResourceOp
, which runs a script
on the target resource that the connector manages.)
A connector that intends to provide to scripts
more than is required by the basic contract
specified in the javadoc for ScriptOnConnectorApiOp
should implement this interface.
Each connector that implements this interface must support
at least the behavior specified by ScriptOnConnectorApiOp
.
A connector also may expose additional variables for use by scripts
and may respond to specific options
.
Each connector that implements this interface
must describe in its javadoc as available "for use by connector scripts"
any such additional variables or supported options.
NOTE: It will be fairly typical for connectors to not need to implement this method. Connectors may still expose features for a script to use simply by having a method public. Those methods that are intended for a script to be used should be documented as "for use by connector scripts". Otherwise script authors should not assume that the method is safe to be called from a script.
Modifier and Type | Method and Description |
---|---|
Object |
runScriptOnConnector(ScriptContext request,
OperationOptions options)
Runs the script request.
|
Object runScriptOnConnector(ScriptContext request, OperationOptions options)
request
- The script and arguments to run.options
- Additional options that control how the script is
run.ObjectSerializerFactory
for a list of supported types.Copyright © 2013. All Rights Reserved.