|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD |
org.linkedin.util.lifecycle.Shutdownableorg.linkedin.glu.agent.impl.script.ScriptManager
interface ScriptManager extends Shutdownable
Manager for scripts
Method Summary | |
---|---|
void
|
clearError(java.lang.Object mountPoint)
Clears the error of the script mounted at the provided mount point |
FutureExecution
|
executeAction(java.lang.Object args)
Executes the action on the software that was installed on the given mount point. |
java.lang.Object
|
executeCall(java.lang.Object args)
Executes the call on the software that was installed on the given mount point. |
Logger
|
findLog(java.lang.Object mountPoint)
@return the log for the given mountpoint (or |
ScriptNode
|
findScript(java.lang.Object mountPoint)
@return a script previously installed (or |
java.lang.Object
|
getFullState(java.lang.Object mountPoint)
@return the full state of the mountpoint ( |
java.lang.Object
|
getMountPoints()
@return a list of all mount points currently mounted |
java.lang.Object
|
getState(java.lang.Object mountPoint)
@return the state of the script (currentState/transitionState/error) |
ScriptNode
|
installRootScript(java.lang.Object actionArgs)
Installs the root script |
ScriptNode
|
installScript(java.lang.Object args)
Install scripts. |
boolean
|
interruptAction(java.lang.Object args)
@param args.mountPoint same mount point provided during installScript(Object) |
boolean
|
isMounted(java.lang.Object mountPoint)
@return |
void
|
uninstallScript(java.lang.Object mountPoint, boolean force)
Uninstall the script |
java.lang.Object
|
waitForAction(java.lang.Object args)
Waits for the action (previously scheduled in executeAction(Object)) to complete no longer than the timeout provided. |
boolean
|
waitForState(java.lang.Object args)
Waits for the script to be in the state |
Method Detail |
---|
void clearError(java.lang.Object mountPoint)
FutureExecution executeAction(java.lang.Object args)
args.mountPoint
- same mount point provided during installScript(Object)args.action
- the lifecycle method you want to executeargs.actionArgs
- the arguments to provide the action
java.lang.Object executeCall(java.lang.Object args)
args.mountPoint
- same mount point provided during installScript(Object)args.call
- the call you want to executeargs.callArgs
- the arguments to provide the call
Logger findLog(java.lang.Object mountPoint)
null
if no such mountpoint)
ScriptNode findScript(java.lang.Object mountPoint)
null
if not found)
java.lang.Object getFullState(java.lang.Object mountPoint)
[scriptDefinition: [...], scriptState: [...]]
java.lang.Object getMountPoints()
java.lang.Object getState(java.lang.Object mountPoint)
ScriptNode installRootScript(java.lang.Object actionArgs)
ScriptNode installScript(java.lang.Object args)
boolean interruptAction(java.lang.Object args)
args.mountPoint
- same mount point provided during installScript(Object)args.action
- the name of the action to interruptargs.actionId
- the id of the action to interrupt (only one of each)false
if the task could not be cancelled, typically because it has already completed
normally; true
otherwise
boolean isMounted(java.lang.Object mountPoint)
true
if there is a script mounted at the given mount point
void uninstallScript(java.lang.Object mountPoint, boolean force)
force
- force uninstall regardless of the state of the script
java.lang.Object waitForAction(java.lang.Object args)
NoSuchActionException
in some cases:
args.mountPoint
- the mount point of the script you want to wait forargs.actionId
- the id of the action to wait forargs.timeout
- if not null
, the amount of time to wait maximum
boolean waitForState(java.lang.Object args)
args.mountPoint
- the mount point of the script you want to wait forargs.state
- the desired state to wait forargs.timeout
- if not null
, the amount of time to wait maximumtrue
if the state was reached within the timeout, false
Groovy Documentation