hudson.maven.reporters

Class MavenArtifact

java.lang.Object

hudson.maven.reporters.MavenArtifact

All Implemented Interfaces:

Serializable

@ExportedBean
public final class MavenArtifact
extends Object
implements Serializable

Captures information about an artifact created by Maven and archived by Jenkins, so that we can later deploy it to repositories of our choice.

This object is created within the Maven process and sent back to the master, so it shouldn't contain anything non-serializable as fields.

Once it's constructed, the object should be considered final and immutable.

Since:

1.189

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MavenArtifact.CloseableArtifact Artifact holder that can be released in a finally-block.
class	MavenArtifact.TemporaryFile Representation of an archived artifact that might be accessed in various ways.

Field Summary

Fields

Modifier and Type	Field and Description
String	artifactId Basic parameters of a Maven artifact.
String	canonicalName The canonical artifact file name, used by Maven in the repository.
String	classifier Basic parameters of a Maven artifact.
String	fileName File name (without directory portion) of this artifact in the Hudson archive.
String	groupId Basic parameters of a Maven artifact.
String	md5sum The md5sum for this artifact.
String	type Basic parameters of a Maven artifact.
String	version Basic parameters of a Maven artifact.

Constructor Summary

Constructors

Constructor and Description
MavenArtifact(org.apache.maven.artifact.Artifact a)
MavenArtifact(String groupId, String artifactId, String version, String classifier, String type, String fileName, String md5sum)

Method Summary

Modifier and Type	Method and Description
void	archive(MavenBuildProxy build, File file, hudson.model.BuildListener listener) Called from within Maven to archive an artifact in Hudson.
static MavenArtifact	create(org.apache.maven.artifact.Artifact a) Convenience method to check if the given Artifact object contains enough information suitable for recording, and if so, create MavenArtifact.
org.kohsuke.stapler.HttpResponse	doFile(MavenArtifactRecord parent) Serve the file.
hudson.model.Api	getApi()
File	getFile(MavenBuild build) Deprecated. only works with StandardArtifactManager and subclasses; use getTemporaryFile(hudson.maven.MavenBuild) instead
MavenArtifact.TemporaryFile	getTemporaryFile(MavenBuild build) Gets an archived artifact.
boolean	isPOM()
org.apache.maven.artifact.Artifact	toArtifact(org.apache.maven.artifact.handler.manager.ArtifactHandlerManager handlerManager, org.apache.maven.artifact.factory.ArtifactFactory factory, MavenBuild build) Deprecated. only works with StandardArtifactManager and subclasses; use toCloseableArtifact(org.apache.maven.artifact.handler.manager.ArtifactHandlerManager, org.apache.maven.artifact.factory.ArtifactFactory, hudson.maven.MavenBuild) instead
MavenArtifact.CloseableArtifact	toCloseableArtifact(org.apache.maven.artifact.handler.manager.ArtifactHandlerManager handlerManager, org.apache.maven.artifact.factory.ArtifactFactory factory, MavenBuild build) Creates a Maven Artifact back from the persisted data.

Methods inherited from class java.lang.Object

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

Field Detail

groupId

@Exported
public final String groupId

Basic parameters of a Maven artifact.

artifactId

@Exported
public final String artifactId

Basic parameters of a Maven artifact.

version

@Exported
public final String version

Basic parameters of a Maven artifact.

classifier

@Exported
public final String classifier

Basic parameters of a Maven artifact.

type

@Exported
public final String type

Basic parameters of a Maven artifact.

fileName

@Exported
public final String fileName

File name (without directory portion) of this artifact in the Hudson archive. Remembered explicitly because some times this doesn't follow the standard naming convention, due to <finalName> setting in POM.

This name is taken directly from the name of the file as used during the build (thus POM would be most likely just pom.xml and artifacts would use their finalName if one is configured.) This is often different from canonicalName.

canonicalName

@Exported
public final String canonicalName

The canonical artifact file name, used by Maven in the repository. This is artifactId-version[-classifier].extension.

The reason we persist this is that the extension is only available through ArtifactHandler.

md5sum

@Exported
public final String md5sum

The md5sum for this artifact.

Constructor Detail

MavenArtifact

public MavenArtifact(org.apache.maven.artifact.Artifact a)
              throws IOException

Throws:

IOException

MavenArtifact

public MavenArtifact(String groupId,
                     String artifactId,
                     String version,
                     String classifier,
                     String type,
                     String fileName,
                     String md5sum)

Method Detail

create

public static MavenArtifact create(org.apache.maven.artifact.Artifact a)
                            throws IOException

Convenience method to check if the given Artifact object contains enough information suitable for recording, and if so, create MavenArtifact.

Throws:

IOException

isPOM

public boolean isPOM()

toArtifact

@Deprecated
public org.apache.maven.artifact.Artifact toArtifact(org.apache.maven.artifact.handler.manager.ArtifactHandlerManager handlerManager,
                                                                 org.apache.maven.artifact.factory.ArtifactFactory factory,
                                                                 MavenBuild build)
                                                          throws IOException

Deprecated. only works with StandardArtifactManager and subclasses; use toCloseableArtifact(org.apache.maven.artifact.handler.manager.ArtifactHandlerManager, org.apache.maven.artifact.factory.ArtifactFactory, hudson.maven.MavenBuild) instead

Throws:

IOException

toCloseableArtifact

public MavenArtifact.CloseableArtifact toCloseableArtifact(org.apache.maven.artifact.handler.manager.ArtifactHandlerManager handlerManager,
                                                           org.apache.maven.artifact.factory.ArtifactFactory factory,
                                                           MavenBuild build)
                                                    throws IOException

Creates a Maven Artifact back from the persisted data.

Throws:

IOException

getFile

@Deprecated
public File getFile(MavenBuild build)
                         throws IOException

Deprecated. only works with StandardArtifactManager and subclasses; use getTemporaryFile(hudson.maven.MavenBuild) instead

Obtains the File representing the archived artifact.

Throws:

FileNotFoundException - if the archived artifact was missing

IOException

getTemporaryFile

@Nonnull
public MavenArtifact.TemporaryFile getTemporaryFile(MavenBuild build)

Gets an archived artifact.

Parameters:

build - a Maven build that might have archived this

Returns:

a representation of the artifact

Since:

2.0.3

doFile

public org.kohsuke.stapler.HttpResponse doFile(@AncestorInPath
                                               MavenArtifactRecord parent)
                                        throws IOException

Serve the file. TODO: figure out how to make this URL more discoverable to the remote API.

Throws:

IOException

archive

public void archive(MavenBuildProxy build,
                    File file,
                    hudson.model.BuildListener listener)
             throws IOException,
                    InterruptedException

Called from within Maven to archive an artifact in Hudson.

Throws:

IOException

InterruptedException

getApi

public hudson.model.Api getApi()