uk.co.codezen.maven.redlinerpm.mojo

Class AbstractRpmMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

uk.co.codezen.maven.redlinerpm.mojo.AbstractRpmMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, RpmMojo

Direct Known Subclasses:

ListFilesRpmMojo, PackageRpmMojo

public abstract class AbstractRpmMojo
extends org.apache.maven.plugin.AbstractMojo
implements RpmMojo

Abstract RPM. Contains the properties needed for customising the build within the pom.xml.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	buildPath Build path
protected String	defaultDestination Default installation destination
protected int	defaultFileMode Default mode
protected String	defaultGroup Default group
protected String	defaultOwner Default owner
protected List<String>	excludes List of file exclude patterns
protected Set<String>	masterFiles Set of master files (all files in build path)
protected List<RpmPackage>	packages RPM package declarations from configuration
protected boolean	performCheckingForExtraFiles Perform checking for extra files not included within any packages, or excluded from all packages
protected org.apache.maven.project.MavenProject	project Maven project
protected RpmScriptTemplateRenderer	templateRenderer Event hook template renderer

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractRpmMojo()

Method Summary

Modifier and Type	Method and Description
void	addSecondaryArtifact(File artifactFile, String artifactId, String version, String classifier) Add a secondary artifact
String	getBuildDirectory() Get build output directory
String	getBuildPath() Get the build root path
String	getCollapsedProjectLicense() Get collapsed project licensing
String	getDefaultDestination() Get default destination
int	getDefaultFileMode() Get default mode
String	getDefaultGroup() Get default group
String	getDefaultOwner() Get default owner
protected org.apache.maven.project.MavenProject	getProject() Get Maven project
String	getProjectArtifactId() Get the project artifact id
String	getProjectPackagingType() Get project packaging type
String	getProjectUrl() Get the project url
String	getProjectVersion() Get the project version
RpmScriptTemplateRenderer	getTemplateRenderer() Get event hook template renderer
boolean	isPerformCheckingForExtraFiles() Get ignore extra files
protected void	scanMasterFiles() Scan the build path for all files for inclusion in an RPM.
void	setBuildPath(String buildPath) Set the build root path
void	setDefaultDestination(String defaultDestination) Set default destination
void	setDefaultFileMode(int defaultFileMode) Set default mode
void	setDefaultGroup(String defaultGroup) Set default group
void	setDefaultOwner(String defaultOwner) Set default owner
void	setExcludes(List<String> excludes) Set the list of file exclude patterns
void	setPackages(List<RpmPackage> packages) Set the RPM packages defined by the configuration
void	setPerformCheckingForExtraFiles(boolean performCheckingForExtraFiles) Set ignore extra files
void	setPrimaryArtifact(File artifactFile, String classifier) Set the primary artifact
void	setProject(org.apache.maven.project.MavenProject project) Set Maven project

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.co.codezen.maven.redlinerpm.mojo.RpmMojo

getLog

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

masterFiles

protected Set<String> masterFiles

Set of master files (all files in build path)

templateRenderer

protected RpmScriptTemplateRenderer templateRenderer

Event hook template renderer

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

Maven project

buildPath

@Parameter(defaultValue="${project.build.outputDirectory}")
protected String buildPath

Build path

packages

@Parameter
protected List<RpmPackage> packages

RPM package declarations from configuration

defaultFileMode

@Parameter
protected int defaultFileMode

Default mode

defaultOwner

@Parameter
protected String defaultOwner

Default owner

defaultGroup

@Parameter
protected String defaultGroup

Default group

defaultDestination

@Parameter
protected String defaultDestination

Default installation destination

excludes

@Parameter
protected List<String> excludes

List of file exclude patterns

performCheckingForExtraFiles

@Parameter
protected boolean performCheckingForExtraFiles

Perform checking for extra files not included within any packages, or excluded from all packages

Constructor Detail

AbstractRpmMojo

public AbstractRpmMojo()

Method Detail

setProject

public void setProject(org.apache.maven.project.MavenProject project)

Set Maven project

Parameters:

project - Maven project

getProject

protected org.apache.maven.project.MavenProject getProject()

Get Maven project

Returns:

Maven project

getTemplateRenderer

public RpmScriptTemplateRenderer getTemplateRenderer()

Get event hook template renderer

Specified by:

getTemplateRenderer in interface RpmMojo

Returns:

Event hook template renderer

getProjectArtifactId

public String getProjectArtifactId()

Get the project artifact id

Specified by:

getProjectArtifactId in interface RpmMojo

Returns:

Artifact id

getProjectVersion

public String getProjectVersion()

Get the project version

Specified by:

getProjectVersion in interface RpmMojo

Returns:

Project version

getProjectUrl

public String getProjectUrl()

Get the project url

Specified by:

getProjectUrl in interface RpmMojo

Returns:

Project url

getProjectPackagingType

public String getProjectPackagingType()

Get project packaging type

Specified by:

getProjectPackagingType in interface RpmMojo

Returns:

Packaging type

getCollapsedProjectLicense

public String getCollapsedProjectLicense()

Get collapsed project licensing

Specified by:

getCollapsedProjectLicense in interface RpmMojo

Returns:

Project licenses, collapsed in to a single line, separated by commas.

getBuildDirectory

public String getBuildDirectory()

Get build output directory

Specified by:

getBuildDirectory in interface RpmMojo

Returns:

Build output directory

setPrimaryArtifact

public void setPrimaryArtifact(File artifactFile,
                               String classifier)

Set the primary artifact

Specified by:

setPrimaryArtifact in interface RpmMojo

Parameters:

artifactFile - Primary artifact

classifier - Artifact classifier

addSecondaryArtifact

public void addSecondaryArtifact(File artifactFile,
                                 String artifactId,
                                 String version,
                                 String classifier)

Add a secondary artifact

Specified by:

addSecondaryArtifact in interface RpmMojo

Parameters:

artifactFile - Secondary artifact file

artifactId - Artifact Id

version - Artifact version

classifier - Artifact classifier

setBuildPath

public void setBuildPath(String buildPath)

Set the build root path

Parameters:

buildPath - Build root path

getBuildPath

public String getBuildPath()
                    throws InvalidPathException

Get the build root path

Specified by:

getBuildPath in interface RpmMojo

Returns:

Build root path

Throws:

InvalidPathException - Build path is invalid and could not be retrieved

setPackages

public void setPackages(List<RpmPackage> packages)

Set the RPM packages defined by the configuration

Parameters:

packages - List of RPM packages

setDefaultFileMode

public void setDefaultFileMode(int defaultFileMode)

Set default mode

Parameters:

defaultFileMode - Default mode

getDefaultFileMode

public int getDefaultFileMode()

Get default mode

Specified by:

getDefaultFileMode in interface RpmMojo

Returns:

Default mode

setDefaultOwner

public void setDefaultOwner(String defaultOwner)

Set default owner

Parameters:

defaultOwner - Default owner

getDefaultOwner

public String getDefaultOwner()

Get default owner

Specified by:

getDefaultOwner in interface RpmMojo

Returns:

Default owner

setDefaultGroup

public void setDefaultGroup(String defaultGroup)

Set default group

Parameters:

defaultGroup - Default group

getDefaultGroup

public String getDefaultGroup()

Get default group

Specified by:

getDefaultGroup in interface RpmMojo

Returns:

Default group

setDefaultDestination

public void setDefaultDestination(String defaultDestination)

Set default destination

Parameters:

defaultDestination - Default destination

getDefaultDestination

public String getDefaultDestination()

Get default destination

Specified by:

getDefaultDestination in interface RpmMojo

Returns:

Default destination

setExcludes

public void setExcludes(List<String> excludes)

Set the list of file exclude patterns

Parameters:

excludes - List of file exclude patterns

setPerformCheckingForExtraFiles

public void setPerformCheckingForExtraFiles(boolean performCheckingForExtraFiles)

Set ignore extra files

Parameters:

performCheckingForExtraFiles - Ignore extra files

isPerformCheckingForExtraFiles

public boolean isPerformCheckingForExtraFiles()

Get ignore extra files

Returns:

Ignore extra files

scanMasterFiles

protected void scanMasterFiles()

Scan the build path for all files for inclusion in an RPM. Excludes are applied also. This is because it doesn't matter if a file ends up being included within an RPM as the master list is only for us to know which files have been missed by a packaging rule.