Package com.netflix.genie.web.scripts

Class GroovyScriptUtils

java.lang.Object

com.netflix.genie.web.scripts.GroovyScriptUtils

public final class GroovyScriptUtils
extends Object

Utility functions that can be used within Groovy scripts executed from Genie.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
static AgentLauncherSelectionContext	getAgentLauncherSelectionContext(groovy.lang.Binding binding)	Given the Binding that a script has attempt to extract the cluster selection context.
static Set<Cluster>	getClusters(groovy.lang.Binding binding)	Deprecated. Use getClusterSelectionContext(Binding) or getCommandSelectionContext(Binding) instead
static ClusterSelectionContext	getClusterSelectionContext(groovy.lang.Binding binding)	Given the Binding that a script has attempt to extract the cluster selection context.
static Set<Command>	getCommands(groovy.lang.Binding binding)	Deprecated. Use getClusterSelectionContext(Binding) or getCommandSelectionContext(Binding) instead
static CommandSelectionContext	getCommandSelectionContext(groovy.lang.Binding binding)	Given the Binding that a script has attempt to extract the command selection context.
static Map<String,String>	getProperties(groovy.lang.Binding binding)	Given the Binding that a script has attempt to extract the properties map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getCommandSelectionContext

public static CommandSelectionContext getCommandSelectionContext(groovy.lang.Binding binding)
                                                          throws IllegalArgumentException

Given the Binding that a script has attempt to extract the command selection context.

Parameters:

binding - The Binding for the script

Returns:

The CommandSelectionContext instance

Throws:

IllegalArgumentException - If there is no context parameter for the script or it is not a CommandSelectionContext

getClusterSelectionContext

public static ClusterSelectionContext getClusterSelectionContext(groovy.lang.Binding binding)
                                                          throws IllegalArgumentException

Given the Binding that a script has attempt to extract the cluster selection context.

Parameters:

binding - The Binding for the script

Returns:

The ClusterSelectionContext instance

Throws:

IllegalArgumentException - If there is no context parameter for the script or it is not a ClusterSelectionContext

getAgentLauncherSelectionContext

public static AgentLauncherSelectionContext getAgentLauncherSelectionContext(groovy.lang.Binding binding)
                                                                      throws IllegalArgumentException

Given the Binding that a script has attempt to extract the cluster selection context.

Parameters:

binding - The Binding for the script

Returns:

The ClusterSelectionContext instance

Throws:

IllegalArgumentException - If there is no context parameter for the script or it is not a ClusterSelectionContext

getProperties

public static Map<String,String> getProperties(groovy.lang.Binding binding)

Given the Binding that a script has attempt to extract the properties map.

Parameters:

binding - The Binding for the script

Returns:

The map of properties

getClusters

@Deprecated
public static Set<Cluster> getClusters(groovy.lang.Binding binding)
                                throws IllegalArgumentException

Deprecated.

Use getClusterSelectionContext(Binding) or getCommandSelectionContext(Binding) instead

Given the Binding that a script has attempt to extract the clusters parameter.

Parameters:

binding - The Binding of the script

Returns:

The set of Cluster's

Throws:

IllegalArgumentException - If there is no clusters parameter, it isn't a set, is empty or doesn't contain all Cluster instances

getCommands

@Deprecated
public static Set<Command> getCommands(groovy.lang.Binding binding)
                                throws IllegalArgumentException

Deprecated.

Use getClusterSelectionContext(Binding) or getCommandSelectionContext(Binding) instead

Given the Binding that a script has attempt to extract the commands parameter.

Parameters:

binding - The Binding of the script

Returns:

The set of Command's

Throws:

IllegalArgumentException - If there is no commands parameter, it isn't a set, is empty or doesn't contain all Command instances