com.dtolabs.rundeck.core.dispatcher
Interface IDispatchedScript

All Superinterfaces:
IDispatchedExecution
All Known Implementing Classes:
DispatchedScriptImpl, ExecTool

public interface IDispatchedScript
extends IDispatchedExecution

IDispatchedScript describes the parameters for a dispatch invocation sent to the Dispatcher


Method Summary
 java.lang.String getFrameworkProject()
          Get the framework project name
 java.lang.String getScript()
          Get the full script
 java.io.InputStream getScriptAsStream()
          Get an InputStream that can provide the full script
 java.lang.String getScriptURLString()
          Get the script URL
 java.lang.String getServerScriptFilePath()
          Get the server-local script path
 
Methods inherited from interface com.dtolabs.rundeck.core.dispatcher.IDispatchedExecution
getArgs, getDataContext, getLoglevel, getNodeSet
 

Method Detail

getFrameworkProject

java.lang.String getFrameworkProject()
Get the framework project name

Returns:
project name

getScript

java.lang.String getScript()
Get the full script

Returns:
the script string

getScriptAsStream

java.io.InputStream getScriptAsStream()
Get an InputStream that can provide the full script

Returns:
the inputstream
Throws:
java.io.IOException - if an error occurs reading or getting the input stream

getServerScriptFilePath

java.lang.String getServerScriptFilePath()
Get the server-local script path

Returns:
server-side script path

getScriptURLString

java.lang.String getScriptURLString()
Get the script URL

Returns:
URL