public interface ScriptOnConnectorApiOp extends APIOperation
Connector
.
That is, if you are using a local framework, the script will be
run in your JVM. If you are connected to a remote framework, the
script will be run in the remote JVM or .Net Runtime.
This API allows an application to run a script in the context of any connector. (A connector need not implement any particular interface in order to enable this.) The minimum contract to which each connector must adhere is as follows:
"connector"
variable
that is equivalent to an initialized instance of a connector.
Thus, at a minimum the script will be able to access
the configuration of the connector
.
script-arguments
passed in by the application.
A connector that implements ScriptOnConnectorOp
may provide more variables than what is described above.
A connector also may perform special processing
for OperationOptions
specific to that connector.
Consult the javadoc of each particular connector to find out what
additional capabilities, if any, that connector exposes for use in scripts.
NOTE: A caller who wants to execute scripts on a connector should assume that a script must not use any method of the connector beyond the minimum contract described above, unless the connector explicitly documents that method as "for use by connector script". The primary function of a connector is to implement the SPI in the context of the Connector framework. In general, no caller should invoke Connector methods directly --whether by a script or by other means.
NO_TIMEOUT
Modifier and Type | Method and Description |
---|---|
Object |
runScriptOnConnector(ScriptContext request,
OperationOptions options)
Runs the script.
|
Object runScriptOnConnector(ScriptContext request, OperationOptions options)
request
- - The script and arguments to run.options
- - Additional options that control how the script is
run. The framework does not currently recognize any options
but specific connectors might. Consult the documentation
for each connector to identify supported options.for a list of supported return types.
Copyright © 2013. All Rights Reserved.