com.seitenbau.jenkins.plugins.dynamicparameter.scriptler
Class ScriptlerParameterDefinition

java.lang.Object
  hudson.model.ParameterDefinition
      hudson.model.SimpleParameterDefinition
          com.seitenbau.jenkins.plugins.dynamicparameter.BaseParameterDefinition
              com.seitenbau.jenkins.plugins.dynamicparameter.scriptler.ScriptlerParameterDefinition

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.ParameterDefinition>, Serializable

Direct Known Subclasses:

ScriptlerChoiceParameterDefinition, ScriptlerStringParameterDefinition

public abstract class ScriptlerParameterDefinition
extends BaseParameterDefinition

Base class for all dynamic parameters using Scriptler scripts.

See Also:

Serialized Form

Nested Class Summary

static class	ScriptlerParameterDefinition.ParameterizedScriptCall Remote call implementation.
static class	ScriptlerParameterDefinition.ScriptParameter Script parameter which has a data bound constructor.

Nested classes/interfaces inherited from class hudson.model.ParameterDefinition

hudson.model.ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.seitenbau.jenkins.plugins.dynamicparameter.BaseParameterDefinition

logger

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

protected

ScriptlerParameterDefinition(String name, String description, String uuid, String scriptlerScriptId, ScriptlerParameterDefinition.ScriptParameter[] parameters, boolean remote) Constructor.

Method Summary

ScriptlerParameterDefinition.ScriptParameter[]	getParameters() Get script parameters.
String	getScriptlerScriptId() Get Scriptler script id.
protected ScriptlerParameterDefinition.ParameterizedScriptCall	prepareLocalCall() Prepare a local call.
protected ScriptlerParameterDefinition.ParameterizedScriptCall	prepareRemoteCall(hudson.remoting.VirtualChannel channel) Prepare a remote call.

Methods inherited from class com.seitenbau.jenkins.plugins.dynamicparameter.BaseParameterDefinition

checkParameterValue, createValue, createValue, getScriptResultAsList, getScriptResultAsString, getUUID, isRemote

Methods inherited from class hudson.model.SimpleParameterDefinition

createValue, createValue

Methods inherited from class hudson.model.ParameterDefinition

all, copyWithDefaultValue, getDefaultParameterValue, getDescription, getDescriptor, getName, getType

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptlerParameterDefinition

protected ScriptlerParameterDefinition(String name,
                                       String description,
                                       String uuid,
                                       String scriptlerScriptId,
                                       ScriptlerParameterDefinition.ScriptParameter[] parameters,
                                       boolean remote)

Constructor.

Parameters:

name - parameter name

description - parameter description

uuid - UUID of the parameter definition

scriptlerScriptId - Scriptler script identifier

parameters - script parameters

remote - flag showing if the script should be executed remotely

Method Detail

getScriptlerScriptId

public final String getScriptlerScriptId()

Get Scriptler script id.

Returns:

scriptler script id

getParameters

public final ScriptlerParameterDefinition.ScriptParameter[] getParameters()

Get script parameters.

Returns:

array with script parameters

prepareLocalCall

protected ScriptlerParameterDefinition.ParameterizedScriptCall prepareLocalCall()
                                                                         throws Exception

Description copied from class: BaseParameterDefinition

Prepare a local call.

Specified by:

prepareLocalCall in class BaseParameterDefinition

Returns:

call instance

Throws:

Exception - if a call instance cannot be created

prepareRemoteCall

protected ScriptlerParameterDefinition.ParameterizedScriptCall prepareRemoteCall(hudson.remoting.VirtualChannel channel)
                                                                          throws Exception

Description copied from class: BaseParameterDefinition

Prepare a remote call.

Specified by:

prepareRemoteCall in class BaseParameterDefinition

Parameters:

channel - channel to the remote slave where the call will be executed

Returns:

call instance

Throws:

Exception - if a call instance cannot be created