Package jenkins.plugins.nodejs

Class NodeJSCommandInterpreter

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

hudson.tasks.CommandInterpreter

jenkins.plugins.nodejs.NodeJSCommandInterpreter

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, EnvVarsFilterableBuilder

public class NodeJSCommandInterpreter
extends CommandInterpreter

This class executes a JavaScript file using node. The file should contain NodeJS script specified in the job configuration.

Author:

cliffano, Nikolas Falco

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NodeJSCommandInterpreter.NodeJsDescriptor	Provides builder details for the job configuration page.

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.tasks.CommandInterpreter

command, configuredLocalRules

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
NodeJSCommandInterpreter(String command, String nodeJSInstallationName)	Constructs a NodeJSCommandInterpreter with specified command.
NodeJSCommandInterpreter(String command, String nodeJSInstallationName, String configId)	Constructs a NodeJSCommandInterpreter with specified command.

Method Summary

Modifier and Type	Method	Description
String[]	buildCommandLine(FilePath script)
CacheLocationLocator	getCacheLocationStrategy()
String	getConfigId()
protected String	getContents()
protected String	getFileExtension()
NodeJSInstallation	getNodeJS()	Gets the NodeJS to invoke, or null to invoke the default one.
String	getNodeJSInstallationName()
protected boolean	internalPerform(AbstractBuild<?,?> build, Launcher launcher, TaskListener listener)
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, TaskListener listener)
void	setCacheLocationStrategy(CacheLocationLocator cacheLocationStrategy)
void	setConfigId(String configId)

Methods inherited from class hudson.tasks.CommandInterpreter

buildEnvVarsFilterRules, createScriptFile, getCommand, getConfiguredLocalRules, isErrorlevelForUnstableBuild, join, perform

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Details

NodeJSCommandInterpreter

@DataBoundConstructor
public NodeJSCommandInterpreter(String command,
 String nodeJSInstallationName)

Constructs a NodeJSCommandInterpreter with specified command.

Parameters:

command - the NodeJS script

nodeJSInstallationName - the NodeJS label configured in Jenkins

NodeJSCommandInterpreter

public NodeJSCommandInterpreter(String command,
 String nodeJSInstallationName,
 String configId)

Constructs a NodeJSCommandInterpreter with specified command.

Parameters:

command - the NodeJS script

nodeJSInstallationName - the NodeJS label configured in Jenkins

configId - the provided Config id

Method Details

getNodeJS

public NodeJSInstallation getNodeJS()

Gets the NodeJS to invoke, or null to invoke the default one.

Returns:

a NodeJS installation setup for this job, null otherwise.

perform

public boolean perform(AbstractBuild<?,?> build,
 Launcher launcher,
 TaskListener listener)
                throws InterruptedException

Overrides:

perform in class CommandInterpreter

Throws:

InterruptedException

internalPerform

protected boolean internalPerform(AbstractBuild<?,?> build,
 Launcher launcher,
 TaskListener listener)
                           throws InterruptedException

Throws:

InterruptedException

buildCommandLine

public String[] buildCommandLine(FilePath script)

Specified by:

buildCommandLine in class CommandInterpreter

getContents

protected String getContents()

Specified by:

getContents in class CommandInterpreter

getFileExtension

protected String getFileExtension()

Specified by:

getFileExtension in class CommandInterpreter

getNodeJSInstallationName

public String getNodeJSInstallationName()

getConfigId

public String getConfigId()

setConfigId

@DataBoundSetter
public void setConfigId(String configId)

getCacheLocationStrategy

public CacheLocationLocator getCacheLocationStrategy()

setCacheLocationStrategy

@DataBoundSetter
public void setCacheLocationStrategy(CacheLocationLocator cacheLocationStrategy)