Groovy Documentation
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

ActionExecution - Class in org.linkedin.glu.agent.impl.script
@author ypujante@linkedin.com
addChild(MountPoint, def, def, def) - Method in ScriptNode
addScriptNode(ScriptNode) - Method in ScriptManagerImpl
addTag(null) - Method in AgentImpl
addTag(null) - Method in TagsStorage
addTags(null) - Method in AgentImpl
addTags(null) - Method in TagsStorage
addTimer(def) - Method in ScriptState
AgentContext - Interface in org.linkedin.glu.agent.impl.script
Represents the agent context
AgentImpl - Class in org.linkedin.glu.agent.impl
The main implementation of the agent
AgentProperties - Class in org.linkedin.glu.agent.impl.storage
Encapsulates the notion of agent properties.
AgentProperties(null) - Constructor in AgentProperties
ant(null) - Method in ShellImpl
Exporting ant access to the shell
AntHelper - Class in org.linkedin.glu.agent.impl.capabilities
Helper methods for ant
AutoUpgradeScript - Class in org.linkedin.glu.agent.impl.script
This is the script that will auto upgrade the agent.

B

boot(def) - Method in AgentImpl
**************************************************************** Boot *****************************************************************

C

CallExecution - Class in org.linkedin.glu.agent.impl.script
@author ypujante@linkedin.com
cancel(boolean) - Method in FutureExecutionImpl
cancel(null, boolean) - Method in ScriptExecution
Convenient call to future using its unique id
cancelTimer(null, boolean) - Method in ScriptExecution
Cancels a timer by name
cancelTimer(def) - Method in ScriptNode
@return false if the execution could not be cancelled, typically because it has already completed normally; true otherwise
cat(def) - Method in ShellImpl
Returns the content of the location as a String or null if the location is not reachable
changeState(null) - Method in ScriptState
checkValidTransitionForAction(def) - Method in ScriptNode
Checks if this is a valid transition at this moment in time.
chmod(def, def) - Method in ShellImpl
Change the permission of the file
chmodPlusX(def) - Method in ShellImpl
Shortcut/More efficient implementation of the more generic {@link #chmod(Object, Object) call
chmodRecursive(def, def) - Method in ShellImpl
clearAllStates() - Method in DualWriteStorage
clearAllStates() - Method in FileSystemStorage
clearAllStates() - Method in FilteredStorage
clearAllStates() - Method in RAMStorage
clearAllStates() - Method in WriteOnlyStorage
clearAllStates() - Method in ZooKeeperStorage
clearError(def) - Method in AgentImpl
{@inheritdoc}
clearError(def) - Method in ScriptManager
Clears the error of the script mounted at the provided mount point
clearError(def) - Method in ScriptManagerImpl
Clears the error of the script mounted at the provided mount point
clearError() - Method in ScriptNode
clearState(MountPoint) - Method in DualWriteStorage
clearState(MountPoint) - Method in FileSystemStorage
clearState(MountPoint) - Method in FilteredStorage
clearState(MountPoint) - Method in RAMStorage
clearState(MountPoint) - Method in WriteOnlyStorage
clearState(MountPoint) - Method in ZooKeeperStorage
ClosureScriptFactory - Class in org.linkedin.glu.agent.impl.script
Represents a script factory where the factory is a closure
compareTo(FutureExecutionImpl) - Method in FutureExecutionImpl
createScript() - Method in ClosureScriptFactory
createScript(ScriptConfig) - Method in FromClassNameScriptFactory
createScript(ScriptConfig) - Method in FromLocationScriptFactory
createScript(ScriptConfig) - Method in ScriptFactory
Creates a script
createStateMachine(def) - Method in MOP
Creates a state machine
createStateMachine(def) - Method in MOPImpl

D

deleteInvalidStates() - Method in FileSystemStorage
DualWriteStorage - Class in org.linkedin.glu.agent.impl.storage
All the reads are delegated to the readWriteStorage, all the writes are dispatched to both.
DualWriteStorage(Storage, WriteOnlyStorage) - Constructor in DualWriteStorage

E

equals(def) - Method in FromClassNameScriptFactory
equals(def) - Method in FromLocationScriptFactory
equals(def) - Method in ScriptDefinition
exec(null) - Method in ShellImpl
Executes a shell command... the command will be delegated straight to shell and the output of the shell command is returned.
execute() - Method in FutureExecutionImpl
execute() - Method in Invocation
execute() - Method in TimerExecution
executeAction(def) - Method in AgentImpl
{@inheritdoc}
executeAction(null, def, null) - Method in ScriptExecution
Executes the action for the given script.
executeAction(def) - Method in ScriptManager
Executes the action on the software that was installed on the given mount point.
executeAction(def) - Method in ScriptManagerImpl
Executes the action on the software that was installed on the given mount point.
executeAction(def) - Method in ScriptNode
@param args.action
executeActionAndWait(def) - Method in AgentImpl
{@inheritdoc}
executeActionAndWaitForState(null) - Method in AgentImpl
{@inheritdoc}
executeCall(def) - Method in AgentImpl
{@inheritdoc}
executeCall(null, def, null) - Method in ScriptExecution
Executes the call for the given script.
executeCall(def) - Method in ScriptManager
Executes the call on the software that was installed on the given mount point.
executeCall(def) - Method in ScriptManagerImpl
Executes the call on the software that was installed on the given mount point.
executeCall(def) - Method in ScriptNode
Executes the call.

F

fail(def) - Method in ShellImpl
Calling this method will force a script failure
fetch(def, def) - Method in ShellImpl
Fetches the file pointed to by the location.
fetchContent(def) - Method in ShellImpl
Fetches the content of the location and returns it as a String or null if the location is not reachable
FileSystemStorage - Class in org.linkedin.glu.agent.impl.storage
Store in the filesystem
FileSystemStorage(null, AgentProperties, null) - Constructor in FileSystemStorage
FilteredStorage - Class in org.linkedin.glu.agent.impl.storage
Implement a filter/decorator pattern... subclasses can simply overrides only the methods they care about.
FilteredStorage(Storage) - Constructor in FilteredStorage
findFuture(null) - Method in ScriptExecution
Returns:
the future by unique id.
findFutureActionById(null) - Method in ScriptExecution
By id (only actions)
findFutureActionByName(null) - Method in ScriptExecution
By name
findLog(def) - Method in ScriptManager
@return the log for the given mountpoint (or null if no such mountpoint)
findLog(def) - Method in ScriptManagerImpl
@return the log for the given mountpoint
findScript(def) - Method in AgentImpl
@return a script previously installed (or null if not found)
findScript(def) - Method in ScriptManager
@return a script previously installed (or null if not found)
findScript(def) - Method in ScriptManagerImpl
Returns the script mounted at the provided mount point (null if there is no such script)
forceChangeState(def, def) - Method in ScriptNode
FromClassNameScriptFactory - Class in org.linkedin.glu.agent.impl.script
The script factory from a class name (simply use reflection to instantiate the class)
FromClassNameScriptFactory(null) - Constructor in FromClassNameScriptFactory
FromLocationScriptFactory - Class in org.linkedin.glu.agent.impl.script
The script factory from a location: will 'fetch' the script, execute it and returns the class found inside.
FromLocationScriptFactory(def) - Constructor in FromLocationScriptFactory
FutureExecutionImpl - Class in org.linkedin.glu.agent.impl.script
@author ypujante@linkedin.com
FutureExecutionImpl() - Constructor in FutureExecutionImpl

G

get(def) - Method in FutureExecutionImpl
get(null, long, null) - Method in ScriptExecution
Convenient call to future using its unique id
getAt(null) - Method in AgentProperties
getAttribute(null, def, null) - Method in MBeanServerConnectionCategory
getAttributes(null, def, def) - Method in MBeanServerConnectionCategory
getAvailableActionsClosures(StateMachine, null) - Method in ScriptWrapperImpl
getChildren() - Method in ScriptNode
getChildrenMountPoints() - Method in ScriptNode
getClock() - Method in AgentContext
getClock() - Method in AgentImpl
getCurrent() - Method in ScriptExecution
@return currently running execution
getEnv() - Method in ShellImpl
getExposedProperties() - Method in AgentProperties
getExposedProperty(null) - Method in AgentProperties
getExternalFullState() - Method in ScriptState
getFileContent(def) - Method in AgentImpl
{@inheritdoc}
getFileSystem() - Method in FileSystemStorage
getFullState(def) - Method in AgentImpl
{@inheritdoc}
getFullState(def) - Method in ScriptManager
@return the full state of the mountpoint ([scriptDefinition: [...], scriptState: [...]]
getFullState(def) - Method in ScriptManagerImpl
getFullState() - Method in ScriptNode
getHostInfo() - Method in AgentImpl
{@inheritdoc}
getLock() - Method in ScriptExecution
mostly for use from test only...
getLog() - Method in ScriptNode
getMimeTypes(def) - Method in ShellImpl
getMop() - Method in AgentContext
getMop() - Method in AgentImpl
getMountPoint() - Method in ScriptNode
getMountPoints() - Method in AgentImpl
getMountPoints() - Method in FileSystemStorage
getMountPoints() - Method in FilteredStorage
getMountPoints() - Method in RAMStorage
getMountPoints() - Method in ReadOnlyStorage
getMountPoints() - Method in ScriptManager
@return a list of all mount points currently mounted
getMountPoints() - Method in ScriptManagerImpl
getMountPoints() - Method in ZooKeeperStorage
getName() - Method in ScriptNode
getParams() - Method in ScriptNode
getParent() - Method in ScriptNode
getParentMountPoint() - Method in ScriptNode
getPastExecutions() - Method in ScriptExecution
getPersistentProperties() - Method in AgentProperties
getPersistentProperty(null) - Method in AgentProperties
getRootScript() - Method in ScriptManagerImpl
the root script
getScript() - Method in Invocation
getScript(def) - Method in ScriptManagerImpl
Returns the script mounted at the provided mount point.
getScript() - Method in ScriptNode
getScript() - Method in TimerExecution
getScriptDefinition() - Method in ScriptNode
getScriptExecution() - Method in ScriptNode
getScriptNodes() - Method in ScriptManagerImpl
getScriptState() - Method in ScriptNode
getShell() - Method in ScriptNode
getShellForScripts() - Method in AgentContext
getShellForScripts() - Method in AgentImpl
getState(def) - Method in AgentImpl
{@inheritdoc}
getState(def) - Method in ScriptManager
@return the state of the script (currentState/transitionState/error)
getState(def) - Method in ScriptManagerImpl
{@inheridoc}
getState() - Method in ScriptNode
getStateManager() - Method in ScriptNode
getStorage() - Method in FilteredStorage
getStorage() - Method in RAMStorage
getTags() - Method in AgentImpl
getTagsCount() - Method in AgentImpl
getTimeline() - Method in ScriptExecution
getTimers() - Method in ScriptExecution
@return the timers that have been set
getTimers() - Method in ScriptNode
getUpgradeLog() - Method in AutoUpgradeScript
Returns the upgrade log // TODO HIGH YP: need to stream instead
getWriteOnlyStorage() - Method in DualWriteStorage
getZkAgentProperties() - Method in ZooKeeperStorage
getZkState() - Method in ZooKeeperStorage
grep(def, def, def) - Method in ShellImpl
Similarly to the unix grep command, checks the location one line at a time and returns all the lines which matches the pattern
gunzip(def, def) - Method in ShellImpl
Uncompresses the provided file (if compressed) into a new file
gzip(def, def) - Method in ShellImpl
Compresses the provided file (first make sure that the file is compressed)
gzipFileOrFolder(def, boolean) - Method in ShellImpl
Compresses each file in a folder

H

hasAllTags(null) - Method in AgentImpl
hasAnyTag(null) - Method in AgentImpl
hashCode() - Method in FromClassNameScriptFactory
hashCode() - Method in FromLocationScriptFactory
hashCode() - Method in ScriptDefinition
hasTag(null) - Method in AgentImpl
hasTags() - Method in AgentImpl
httpHead(def) - Method in ShellImpl
Issue a 'HEAD' request.
httpPost(def, null) - Method in ShellImpl
Issue a 'POST' request.

I

installRootScript(def) - Method in ScriptManager
Installs the root script
installRootScript(def) - Method in ScriptManagerImpl
installRootScript(def) - Method in StateKeeperScriptManager
installScript(def) - Method in AgentImpl
{@inheritdoc}
installScript(def) - Method in ScriptManager
Install scripts.
installScript(def) - Method in ScriptManagerImpl
Install scripts.
installScript(def) - Method in StateKeeperScriptManager
interruptAction(def) - Method in AgentImpl
interruptAction(def) - Method in ScriptManager
@param args.mountPoint same mount point provided during installScript(Object)
interruptAction(def) - Method in ScriptManagerImpl
{@inheritDoc}
interruptAction(def) - Method in ScriptNode
@param args.action the name of the action to interrupt
interruptCurrentExecution() - Method in ScriptNode
@return false if the execution could not be cancelled, typically because it has already completed normally; true otherwise
Invocation - Class in org.linkedin.glu.agent.impl.script
@author ypujante@linkedin.com
invoke(null, def, null, def) - Method in MBeanServerConnectionCategory
isCancelled() - Method in FutureExecutionImpl
isCancelled(null) - Method in ScriptExecution
Convenient call to future using its unique id
isDone() - Method in FutureExecutionImpl
isDone(null) - Method in ScriptExecution
Convenient call to future using its unique id
isMounted(def) - Method in ScriptManager
@return true if there is a script mounted at the given mount point
isMounted(def) - Method in ScriptManagerImpl
@return true if there is a script mounted at the given mount point

J


K

kill(long, int) - Method in AgentImpl
{@inheritdoc}

L

listening(def, def) - Method in ShellImpl
@return true if there is a socket open on the server/port combination
load(null) - Method in AgentProperties
Load/Initialize this object from a file
loadAgentProperties() - Method in FileSystemStorage
loadAgentProperties() - Method in FilteredStorage
loadAgentProperties() - Method in RAMStorage
loadAgentProperties() - Method in ReadOnlyStorage
loadState(MountPoint) - Method in FileSystemStorage
loadState(MountPoint) - Method in FilteredStorage
loadState(MountPoint) - Method in RAMStorage
loadState(MountPoint) - Method in ReadOnlyStorage
log - Field in AgentImpl
log - Field in FileSystemStorage
log - Field in ScriptManagerImpl
log - Field in ScriptState
log - Field in ShellImpl
log - Field in StateKeeperScriptManager
log - Field in ZooKeeperStorage

M

MBeanServerConnectionCategory - Class in org.linkedin.glu.agent.impl.capabilities
methodMissing(null, def) - Method in ScriptNode
MODULE - Field in AgentImpl
MODULE - Field in FileSystemStorage
MODULE - Field in ScriptManagerImpl
MODULE - Field in ScriptState
MODULE - Field in ShellImpl
MODULE - Field in StateKeeperScriptManager
MODULE - Field in ZooKeeperStorage
MOP - Interface in org.linkedin.glu.agent.impl.script
Meta Object Programming methods
MOPImpl - Class in org.linkedin.glu.agent.impl.capabilities
@author ypujante@linkedin.com
MOPImpl(def) - Constructor in MOPImpl

N

newShell(def) - Method in ShellImpl
noException(null) - Method in ShellImpl
Runs the closure in a protected block that will not throw an exception but will return null in the case one happens

O


P

propertyMissing(null) - Method in ScriptNode
ps() - Method in AgentImpl
{@inheritdoc}
putAt(null, null) - Method in AgentProperties

Q


R

RAMStorage - Class in org.linkedin.glu.agent.impl.storage
Simply store everything in memory.
RAMStorage(null, AgentProperties) - Constructor in RAMStorage
ReadOnlyStorage - Interface in org.linkedin.glu.agent.impl.storage
Only the read parts of the storage
removeChild(ScriptNode) - Method in ScriptNode
removeScriptNode(MountPoint) - Method in ScriptManagerImpl
removeTag(null) - Method in AgentImpl
removeTag(null) - Method in TagsStorage
removeTags(null) - Method in AgentImpl
removeTags(null) - Method in TagsStorage
removeTimer(null) - Method in ScriptState
replaceTokens(def, def, null) - Method in ShellImpl
Processes from through the replacement token mechanism and writes the result to to
restore(def) - Method in ScriptState
restorePermanentState(def) - Method in ScriptState
RootScript - Class in org.linkedin.glu.agent.impl.script
The root script... there can be only one of those...
run() - Method in FutureExecutionImpl

S

save(null) - Method in AgentProperties
Save the persistent properties to a file
saveAgentProperties(AgentProperties) - Method in DualWriteStorage
saveAgentProperties(AgentProperties) - Method in FileSystemStorage
saveAgentProperties(AgentProperties) - Method in FilteredStorage
saveAgentProperties(AgentProperties) - Method in RAMStorage
saveAgentProperties(AgentProperties) - Method in WriteOnlyStorage
saveAgentProperties(AgentProperties) - Method in ZooKeeperStorage
saveContent(def, null, null) - Method in ShellImpl
Processes the content to the token replacement method.
scheduleTimer(null, def, def, null) - Method in ScriptExecution
Schedule a timer.
scheduleTimer(def) - Method in ScriptNode
Schedule a timer.
SCRIPT_STATE_NAMES - Field in ScriptState
ScriptConfig - Class in org.linkedin.glu.agent.impl.script
The script config
ScriptConfig(def) - Constructor in ScriptConfig
ScriptDefinition - Class in org.linkedin.glu.agent.impl.script
Represents the script definition (does not change over the life of the script)
ScriptDefinition(MountPoint, MountPoint, ScriptFactory, def) - Constructor in ScriptDefinition
ScriptExecution - Class in org.linkedin.glu.agent.impl.script
@author ypujante@linkedin.com
ScriptExecution(def, null, Logger) - Constructor in ScriptExecution
ScriptFactory - Interface in org.linkedin.glu.agent.impl.script
Encapsulates the notion of script factory so that we can recreate the scripts at will.
ScriptManager - Interface in org.linkedin.glu.agent.impl.script
Manager for scripts
ScriptManagerImpl - Class in org.linkedin.glu.agent.impl.script
Manager for scripts
ScriptManagerImpl(def) - Constructor in ScriptManagerImpl
ScriptNode - Class in org.linkedin.glu.agent.impl.script
A script node (recursive structure)
ScriptNode(AgentContext, ScriptDefinition, StateMachine, def, Logger) - Constructor in ScriptNode
ScriptState - Class in org.linkedin.glu.agent.impl.script
Contains the state of the script (state machine + script itself)
ScriptState(ScriptDefinition, StateMachine, def) - Constructor in ScriptState
ScriptWrapperImpl - Class in org.linkedin.glu.agent.impl.script
The goal of this class is to wrap a script so that it has access to convenient variables like the shell, params,...
setAgentProperty(null, null) - Method in AgentProperties
setStateChangeListener(def) - Method in ScriptState
setTags(null) - Method in AgentImpl
setTags(null) - Method in TagsStorage
ShellImpl - Class in org.linkedin.glu.agent.impl.capabilities
contains the utility methods for the shell
shutdown(boolean) - Method in AgentImpl
Shuts down the agent
shutdown() - Method in ScriptExecution
shutdown() - Method in ScriptManagerImpl
shutdown() - Method in ScriptNode
shutdown() - Method in StateKeeperScriptManager
start() - Method in ScriptExecution
start() - Method in ScriptNode
StateKeeperScriptManager - Class in org.linkedin.glu.agent.impl.script
The purpose of this class is to keep track and record the state of the script manager so that we can restore in the even of a shutdown/restart.
StateKeeperScriptManager(def) - Constructor in StateKeeperScriptManager
StateMachineFactoryImpl - Class in org.linkedin.glu.agent.impl.state
Simple factory which looks at a static field in the script
Storage - Interface in org.linkedin.glu.agent.impl.storage
Abstraction to storage.
storeState(MountPoint, def) - Method in DualWriteStorage
storeState(MountPoint, def) - Method in FileSystemStorage
storeState(MountPoint, def) - Method in FilteredStorage
storeState(MountPoint, null) - Method in RAMStorage
storeState(MountPoint, def) - Method in WriteOnlyStorage
storeState(MountPoint, def) - Method in ZooKeeperStorage
sync() - Method in AgentImpl
{@inheritdoc}
sync() - Method in DualWriteStorage
Synchronizes the 2 storages (the source of truth is supposed to be the readWriteStorage).

T

TAGS_SERIALIZER - Field in TagsStorage
TagsStorage - Class in org.linkedin.glu.agent.impl.storage
@author yan@pongasoft.com
TagsStorage(Storage, null) - Constructor in TagsStorage
tail(def) - Method in ShellImpl
Tail the location
tailAgentLog(def) - Method in AgentImpl
{@inheritdoc}
TimerExecution - Class in org.linkedin.glu.agent.impl.script
@author ypujante@linkedin.com
toExternalRepresentation() - Method in FromClassNameScriptFactory
toExternalRepresentation() - Method in FromLocationScriptFactory
toExternalRepresentation() - Method in ScriptDefinition
toExternalRepresentation() - Method in ScriptFactory
@returns an external representation of the factory
toString() - Method in FromClassNameScriptFactory
toString() - Method in FromLocationScriptFactory
toString() - Method in FutureExecutionImpl
toString() - Method in Invocation
toString() - Method in ScriptDefinition
toString() - Method in ScriptNode
toString() - Method in TimerExecution

U

uninstallScript(def) - Method in AgentImpl
{@inheritdoc}
uninstallScript(def, boolean) - Method in ScriptManager
Uninstall the script
uninstallScript(def, boolean) - Method in ScriptManagerImpl
Uninstall the script
uninstallScript(def, boolean) - Method in StateKeeperScriptManager
Uninstall the script
untar(def, def) - Method in ShellImpl
untarAndDecrypt(def, def, def) - Method in ShellImpl
unzip(def, def) - Method in ShellImpl
updateAgentProperty(null, null) - Method in DualWriteStorage
updateAgentProperty(null, null) - Method in FileSystemStorage
updateAgentProperty(null, null) - Method in FilteredStorage
updateAgentProperty(null, null) - Method in RAMStorage
updateAgentProperty(null, null) - Method in WriteOnlyStorage
updateAgentProperty(null, null) - Method in ZooKeeperStorage

V


W

waitFor(null) - Method in ShellImpl
Waits for the condition to be true no longer than the timeout.
waitForAction(def) - Method in AgentImpl
{@inheritdoc}
waitForAction(def) - Method in ScriptManager
Waits for the action (previously scheduled in executeAction(Object)) to complete no longer than the timeout provided.
waitForAction(def) - Method in ScriptManagerImpl
{@inheritDoc}
waitForAction(def) - Method in ScriptNode
Waits for the action (previously scheduled in executeAction(Object)) to complete no longer than the timeout provided.
waitForShutdown() - Method in AgentImpl
waitForShutdown(null) - Method in ScriptExecution
waitForShutdown(def) - Method in ScriptManagerImpl
waitForShutdown(null) - Method in ScriptNode
waitForShutdown(null) - Method in StateKeeperScriptManager
waitForState(def) - Method in AgentImpl
{@inheritdoc}
waitForState(def) - Method in ScriptManager
Waits for the script to be in the state
waitForState(def) - Method in ScriptManagerImpl
Waits for the script to be in the state
waitForState(def, def) - Method in ScriptNode
withBuilder(null) - Method in AntHelper
Executes the closure with a builder and make sure to catch BuildException to propertly unwrap them
withMBeanServerConnection(def, null) - Method in ShellImpl
Invokes the closure with an MBeanServerConnection to the jmx control running on the vm started with the provided pid.
withReader(def, null) - Method in ShellImpl
Same as withInputStream but wraps in a reader using the charset
withWriter(def, null) - Method in ShellImpl
Same as withOutputStream but wraps in a writer using the charset
wrapScript(def) - Method in MOP
Wrap the script (add properties and closures)
wrapScript(def) - Method in MOPImpl
WriteOnlyStorage - Interface in org.linkedin.glu.agent.impl.storage
Represent the write only part of the storage

X


Y


Z

ZooKeeperStorage - Class in org.linkedin.glu.agent.impl.zookeeper
Implementation of the storage using zookeeper.
ZooKeeperStorage(IZKClient, IZKClient) - Constructor in ZooKeeperStorage

_


Groovy Documentation