Groovy Documentation

org.linkedin.glu.agent.api
[Groovy] Interface GluScript


interface GluScript

All glu script will at runtime implement this interface. This essentially serves as documentation in order to know what is available when you write a glu script.

Authors:
yan@pongasoft.com


Method Summary
java.util.Collection getChildren()

@return the children of this glu script

Logger getLog()

@return a logger to log information (in the agent log file)

MountPoint getMountPoint()

Returns:
the mountPoint on which the script was installed.

java.util.Map getParams()

@return the initParameters provided at installation time

GluScript getParent()

@return the parent of this glu script (null when root script)

GluScript getSelf()

@return a reference to 'this' script

Shell getShell()

@return the shell for (unix) shell like capabilities

java.lang.Object getState()

Shortcut to getStateManager().state

StateManager getStateManager()

@return the state manager to be able to get information about the state

Timers getTimers()

@return the timers object allows you to schedule and cancel timers

 

Method Detail

getChildren

java.util.Collection getChildren()
Returns:
the children of this glu script


getLog

Logger getLog()
Returns:
a logger to log information (in the agent log file)


getMountPoint

MountPoint getMountPoint()
Returns:
the mountPoint on which the script was installed. In general, this property is used to install the application in a unique location (since the mountPoint is unique)


getParams

java.util.Map getParams()
Returns:
the initParameters provided at installation time


getParent

GluScript getParent()
Returns:
the parent of this glu script (null when root script)


getSelf

GluScript getSelf()
Returns:
a reference to 'this' script


getShell

Shell getShell()
Returns:
the shell for (unix) shell like capabilities
See Also:
Shell


getState

java.lang.Object getState()
Shortcut to getStateManager().state


getStateManager

StateManager getStateManager()
Returns:
the state manager to be able to get information about the state
See Also:
StateManager


getTimers

Timers getTimers()
Returns:
the timers object allows you to schedule and cancel timers
See Also:
Timers


 

Groovy Documentation