hudson.tasks
Class Maven.MavenInstallation

java.lang.Object
  hudson.model.AbstractDescribableImpl<ToolInstallation>
      hudson.tools.ToolInstallation
          hudson.tasks.Maven.MavenInstallation

All Implemented Interfaces:

ExtensionPoint, Describable<ToolInstallation>, EnvironmentSpecific<Maven.MavenInstallation>, NodeSpecific<Maven.MavenInstallation>, Serializable

Enclosing class:

Maven

public static final class Maven.MavenInstallation
extends ToolInstallation
implements EnvironmentSpecific<Maven.MavenInstallation>, NodeSpecific<Maven.MavenInstallation>

Represents a Maven installation in a system.

See Also:

Serialized Form

Nested Class Summary

static class	Maven.MavenInstallation.ConverterImpl
static class	Maven.MavenInstallation.DescriptorImpl

Nested classes/interfaces inherited from class hudson.tools.ToolInstallation

ToolInstallation.ToolConverter

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

static int	MAVEN_20 Constants for describing Maven versions for comparison.
static int	MAVEN_21
static int	MAVEN_30

Constructor Summary

Maven.MavenInstallation(String name, String home)
Deprecated. as of 1.308. Use #MavenInstallation(String, String, List)

Maven.MavenInstallation(String name, String home, List<? extends ToolProperty<?>> properties)

Method Summary

void	buildEnvVars(EnvVars env) Expose any environment variables that this tool installation wants the build to see.
Maven.MavenInstallation	forEnvironment(EnvVars environment) Returns a specialized copy of T for functioning in the given environment.
Maven.MavenInstallation	forNode(Node node, TaskListener log) Returns a specialized copy of T for functioning in the given node.
String	getExecutable(Launcher launcher) Gets the executable path of this maven on the given target system.
boolean	getExists() Returns true if the executable exists.
File	getHomeDir()
String	getMavenHome() Deprecated. as of 1.308. Use ToolInstallation.getHome().
boolean	isMaven2_1(Launcher launcher) Is this Maven 2.1.x or 2.2.x - but not Maven 3.x?
boolean	meetsMavenReqVersion(Launcher launcher, int mavenReqVersion) Compares the version of this Maven installation to the minimum required version specified.

Methods inherited from class hudson.tools.ToolInstallation

all, getHome, getName, getProperties, readResolve, translate, translate, translateFor

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

MAVEN_20

public static final int MAVEN_20

Constants for describing Maven versions for comparison.

See Also:

Constant Field Values

MAVEN_21

public static final int MAVEN_21

See Also:

Constant Field Values

MAVEN_30

public static final int MAVEN_30

See Also:

Constant Field Values

Constructor Detail

Maven.MavenInstallation

public Maven.MavenInstallation(String name,
                               String home)

Deprecated. as of 1.308. Use #MavenInstallation(String, String, List)

Maven.MavenInstallation

@DataBoundConstructor
public Maven.MavenInstallation(String name,
                                                    String home,
                                                    List<? extends ToolProperty<?>> properties)

Method Detail

getMavenHome

public String getMavenHome()

Deprecated. as of 1.308. Use ToolInstallation.getHome().

install directory.

getHomeDir

public File getHomeDir()

buildEnvVars

public void buildEnvVars(EnvVars env)

Description copied from class: ToolInstallation

Expose any environment variables that this tool installation wants the build to see.

To add entry to PATH, do envVars.put("PATH+XYZ",path) where 'XYZ' is something unique. Variable names of the form 'A+B' is interpreted as adding the value to the existing PATH.

Overrides:

buildEnvVars in class ToolInstallation

meetsMavenReqVersion

public boolean meetsMavenReqVersion(Launcher launcher,
                                    int mavenReqVersion)
                             throws IOException,
                                    InterruptedException

Compares the version of this Maven installation to the minimum required version specified.

Parameters:

launcher - Represents the node on which we evaluate the path.

mavenReqVersion - Represents the minimum required Maven version - constants defined above.

Throws:

IOException

InterruptedException

isMaven2_1

public boolean isMaven2_1(Launcher launcher)
                   throws IOException,
                          InterruptedException

Is this Maven 2.1.x or 2.2.x - but not Maven 3.x?

Parameters:

launcher - Represents the node on which we evaluate the path.

Throws:

IOException

InterruptedException

getExecutable

public String getExecutable(Launcher launcher)
                     throws IOException,
                            InterruptedException

Gets the executable path of this maven on the given target system.

Throws:

IOException

InterruptedException

getExists

public boolean getExists()

Returns true if the executable exists.

forEnvironment

public Maven.MavenInstallation forEnvironment(EnvVars environment)

Description copied from interface: EnvironmentSpecific

Returns a specialized copy of T for functioning in the given environment.

Specified by:

forEnvironment in interface EnvironmentSpecific<Maven.MavenInstallation>

forNode

public Maven.MavenInstallation forNode(Node node,
                                       TaskListener log)
                                throws IOException,
                                       InterruptedException

Description copied from interface: NodeSpecific

Returns a specialized copy of T for functioning in the given node.

Specified by:

forNode in interface NodeSpecific<Maven.MavenInstallation>

Throws:

IOException

InterruptedException