public interface ScriptTask extends ScheduleTask
Modifier and Type | Interface and Description |
---|---|
static class |
ScriptTask.Type
the script task
|
Modifier and Type | Method and Description |
---|---|
String |
getCustomConnectionLogin()
If this script uses a custom user
Connection , the user login of the Connection is returned,
null is returned if a system connection is used. |
Executable |
getExecutable()
Provides an executable defined with this script.
|
List<Map.Entry<String,String>> |
getParameters()
A set of paramaters set for this
ScriptTask |
Properties |
getProperties()
Provides the defined properties.
|
String |
getSource()
the source code of this script
|
ScriptTask.Type |
getType()
the
Type of this script |
boolean |
getUseCustomConnection()
Returns
true if this script uses a custom user Connection , false is returned if
a system Connection is used. |
void |
removeParameter(String name)
Removes a parameter having the given name.
|
void |
setParameter(String name,
String value)
Set a parameter value having the given name to the provided value.
|
void |
setSource(String value)
Sets the source code of this script.
|
void |
setType(ScriptTask.Type type)
Sets the script type.
|
void |
setUseCustomConnection(String login,
String password)
Use a custom user
Connection to execute this script. |
void |
setUseSystemConnection()
Use a default system
Connection to execute this script and clear all custom connection credentials. |
checkParams, getClusterNodeName, getDescription, getExecuteInFault, getExecuteParallel, getName, getRemoteTaskType, getScheduleEntry, getTemplate, hasTemplate, isActive, isExecuteOnClusterNode, isProjectTask, setActive, setClusterNodeName, setDescription, setExecuteInFault, setExecuteOnClusterNode, setExecuteParallel, setName, setTemplate, test
ScriptTask.Type getType()
Type
of this scriptvoid setType(ScriptTask.Type type)
type
- the Type
of this scriptString getSource()
void setSource(String value)
value
- the source code of this scriptProperties getProperties()
@NotNull List<Map.Entry<String,String>> getParameters()
ScriptTask
void setParameter(@NotNull String name, @Nullable String value)
name
- The parameter's name.value
- The value to be set.void removeParameter(@NotNull String name)
name
- The parameter's name.Executable getExecutable()
void setUseCustomConnection(@NotNull String login, @NotNull String password) throws AuthenticationException
Connection
to execute this script.login
- The connection user loginpassword
- The connection user passwordAuthenticationException
- Thrown if the authentication of the user failedboolean getUseCustomConnection()
true
if this script uses a custom user Connection
, false
is returned if
a system Connection
is used.True
if this script used a custom user connection@Nullable String getCustomConnectionLogin()
Connection
, the user login of the Connection
is returned,
null
is returned if a system connection is used.Connection
, null
if a system connection is
used.void setUseSystemConnection()
Connection
to execute this script and clear all custom connection credentials.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210