hudson.maven.reporters

Class MavenArtifactRecord

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.TaskAction

hudson.maven.reporters.MavenAbstractArtifactRecord<MavenBuild>

hudson.maven.reporters.MavenArtifactRecord

All Implemented Interfaces:

AggregatableAction, hudson.model.Action, hudson.model.BuildBadgeAction, hudson.model.ModelObject, hudson.search.SearchableModelObject, hudson.search.SearchItem

@ExportedBean
public class MavenArtifactRecord
extends MavenAbstractArtifactRecord<MavenBuild>
implements AggregatableAction

Action that remembers artifacts that are built. Defines the methods and UIs to do (delayed) deployment and installation.

Author:

Kohsuke Kawaguchi

See Also:

MavenArtifactArchiver

Nested Class Summary

Nested classes/interfaces inherited from class hudson.maven.reporters.MavenAbstractArtifactRecord

MavenAbstractArtifactRecord.Record

Field Summary

Fields

Modifier and Type	Field and Description
List<MavenArtifact>	attachedArtifacts Attached artifacts.
MavenArtifact	mainArtifact The main artifact (like jar or war, but could be anything.) If this is a POM module, the main artifact contains the same value as pomArtifact.
MavenBuild	parent The build to which this record belongs.
MavenArtifact	pomArtifact POM artifact.
String	repositoryId The repository identifier (matching maven settings) used for credentials to deploy artifacts
String	repositoryUrl The repository URL used for credentials to deploy artifacts

Fields inherited from class hudson.maven.reporters.MavenAbstractArtifactRecord

debug, records, REDEPLOY

Fields inherited from class hudson.model.TaskAction

log, workerThread

Constructor Summary

Constructors

Constructor and Description
MavenArtifactRecord(MavenBuild parent, MavenArtifact pomArtifact, MavenArtifact mainArtifact, List<MavenArtifact> attachedArtifacts) Deprecated.
MavenArtifactRecord(MavenBuild parent, MavenArtifact pomArtifact, MavenArtifact mainArtifact, List<MavenArtifact> attachedArtifacts, String repositoryUrl, String repositoryId)

Method Summary

Modifier and Type	Method and Description
MavenAggregatedArtifactRecord	createAggregatedAction(MavenModuleSetBuild build, Map<MavenModule,List<MavenBuild>> moduleBuilds) Creates Action to be contributed to MavenModuleSetBuild.
void	deploy(hudson.maven.MavenEmbedder embedder, org.apache.maven.artifact.repository.ArtifactRepository deploymentRepository, hudson.model.TaskListener listener) Deploys the artifacts to the specified ArtifactRepository.
String	getAbsoluteUrl() Deprecated. This method shall NEVER be used during HTML page rendering, as it's too easy for misconfiguration to break this value, with network set up like Apache reverse proxy. This method is only intended for the remote API clients who cannot resolve relative references.
MavenBuild	getBuild() Gets the parent build object to which this record is registered.
String	getUrl() Returns the URL of this record relative to the context root of the application.
boolean	isPOM()

Methods inherited from class hudson.maven.reporters.MavenAbstractArtifactRecord

doRedeploy, getACL, getApi, getDisplayName, getDynamic, getHistoryWidget, getIconFileName, getPermission, getUrlName, hasBadge

Methods inherited from class hudson.model.TaskAction

doClearError, doProgressiveHtml, doProgressiveLog, getLog, getSearchUrl, getWorkerThread, obtainLog

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Action

getDisplayName, getIconFileName, getUrlName

Field Detail

parent

@Exported
public final MavenBuild parent

The build to which this record belongs.

pomArtifact

@Exported(inline=true)
public final MavenArtifact pomArtifact

POM artifact.

mainArtifact

@Exported(inline=true)
public final MavenArtifact mainArtifact

The main artifact (like jar or war, but could be anything.) If this is a POM module, the main artifact contains the same value as pomArtifact.

attachedArtifacts

@Exported(inline=true)
public final List<MavenArtifact> attachedArtifacts

Attached artifacts. Can be empty but never null.

repositoryId

public final String repositoryId

The repository identifier (matching maven settings) used for credentials to deploy artifacts

repositoryUrl

public final String repositoryUrl

The repository URL used for credentials to deploy artifacts

Constructor Detail

MavenArtifactRecord

@Deprecated
public MavenArtifactRecord(MavenBuild parent,
                                       MavenArtifact pomArtifact,
                                       MavenArtifact mainArtifact,
                                       List<MavenArtifact> attachedArtifacts)

Deprecated.

MavenArtifactRecord

public MavenArtifactRecord(MavenBuild parent,
                           MavenArtifact pomArtifact,
                           MavenArtifact mainArtifact,
                           List<MavenArtifact> attachedArtifacts,
                           String repositoryUrl,
                           String repositoryId)

Method Detail

getBuild

public MavenBuild getBuild()

Description copied from class: MavenAbstractArtifactRecord

Gets the parent build object to which this record is registered.

Specified by:

getBuild in class MavenAbstractArtifactRecord<MavenBuild>

getUrl

public String getUrl()

Returns the URL of this record relative to the context root of the application.

Returns:

URL that ends with '/'.

See Also:

for how to implement this.

getAbsoluteUrl

@Exported(visibility=2,
          name="url")
public String getAbsoluteUrl()

Deprecated. This method shall NEVER be used during HTML page rendering, as it's too easy for misconfiguration to break this value, with network set up like Apache reverse proxy. This method is only intended for the remote API clients who cannot resolve relative references.

Obtains the absolute URL to this build.

isPOM

public boolean isPOM()

createAggregatedAction

public MavenAggregatedArtifactRecord createAggregatedAction(MavenModuleSetBuild build,
                                                            Map<MavenModule,List<MavenBuild>> moduleBuilds)

Description copied from interface: AggregatableAction

Creates Action to be contributed to MavenModuleSetBuild.

Specified by:

createAggregatedAction in interface AggregatableAction

Parameters:

build - MavenModuleSetBuild for which the aggregated report is created.

moduleBuilds - The result of MavenModuleSetBuild.getModuleBuilds() provided for convenience and efficiency.

Returns:

null if the reporter provides no such action.

deploy

public void deploy(hudson.maven.MavenEmbedder embedder,
                   org.apache.maven.artifact.repository.ArtifactRepository deploymentRepository,
                   hudson.model.TaskListener listener)
            throws hudson.maven.MavenEmbedderException,
                   IOException,
                   org.codehaus.plexus.component.repository.exception.ComponentLookupException,
                   org.apache.maven.artifact.deployer.ArtifactDeploymentException

Description copied from class: MavenAbstractArtifactRecord

Deploys the artifacts to the specified ArtifactRepository.

Specified by:

deploy in class MavenAbstractArtifactRecord<MavenBuild>

Parameters:

embedder - This component hosts all the Maven components we need to do the work.

deploymentRepository - The remote repository to deploy to.

listener - The status and error goes to this listener.

Throws:

hudson.maven.MavenEmbedderException

IOException

org.codehaus.plexus.component.repository.exception.ComponentLookupException

org.apache.maven.artifact.deployer.ArtifactDeploymentException