uk.co.codezen.maven.redlinerpm.rpm

Class RpmPackage

java.lang.Object

uk.co.codezen.maven.redlinerpm.rpm.RpmPackage

public final class RpmPackage
extends Object

RPM package

Constructor Summary

Constructors

Constructor and Description
RpmPackage()

Method Summary

Modifier and Type	Method and Description
Set<String>	build() Build the package
org.redline_rpm.header.Architecture	getArchitecture() Get package architecture
String	getBuildHostName() Get package build host name.
String	getClassifier() Get the artifact classifier
List<RpmPackageAssociation>	getConflicts() Get package conflicts
List<RpmPackageAssociation>	getDependencies() Get package dependencies
String	getDescription() Get package description
String	getDistribution() Get package distribution
String	getFinalName() Get final name of the RPM artifact.
String	getGroup() Get package group
String	getLicense() Get package license
List<RpmLink>	getLinks() Get package links
org.apache.maven.plugin.logging.Log	getLog() Get the Maven logger
RpmMojo	getMojo() Get mojo in use by Maven
String	getName() Get package name
String	getNameOverride() Get override name
List<RpmPackageAssociation>	getObsoletes() Get package obsoletes
org.redline_rpm.header.Os	getOperatingSystem() Get package operating system.
String	getPackager() Get packager
String	getPostInstallProgram() Get post install program
File	getPostInstallScriptFile() Get post install script file
String	getPostTransactionProgram() Get post transaction program
File	getPostTransactionScriptFile() Get post transaction script file
String	getPostUninstallProgram() Get post uninstall program
File	getPostUninstallScriptFile() Get post uninstall script file
List<String>	getPrefixes() Get list of prefixes
String	getPreInstallProgram() Get pre install program
File	getPreInstallScriptFile() Get pre install script file
String	getPreTransactionProgram() Get pre transaction program
File	getPreTransactionScriptFile() Get pre transactions script file
String	getPreUninstallProgram() Get pre uninstall program
File	getPreUninstallScriptFile() Get pre uninstall script file
String	getProjectVersion() Get project version
String	getRelease() Get package release
List<RpmPackageRule>	getRules() Get package rules
String	getSigningKey() Get signing key
String	getSigningKeyId() Get signing key id
String	getSigningKeyPassPhrase() Get signing key pass phrase
String	getSourceRpm() Get source RPM name
String	getSummary() Get package summary
List<RpmTrigger>	getTriggers() Get triggers
String	getUrl() Get package url
String	getVersion() Get package version
boolean	isAttach() Get artifact attachment
Set<String>	listFiles() List files matched for the package
void	setArchitecture(String architecture) Set package architecture
void	setAttach(boolean attach) Set artifact attachment
void	setBuildHostName(String buildHostName) Set package build host name
void	setClassifier(String classifier) Set the artifact classifier
void	setConflicts(List<RpmPackageAssociation> conflicts) Set package conflicts
void	setDependencies(List<RpmPackageAssociation> dependencies) Set package dependencies
void	setDescription(String description) Set package description
void	setDistribution(String distribution) Set package distribution
void	setFinalName(String finalName) Set final name of RPM artifact
void	setGroup(String group) Set package group
void	setLicense(String license) Set package license
void	setLinks(List<RpmLink> links) Set package links
void	setMojo(RpmMojo mojo) Set mojo in use by Maven
void	setName(String name) Set package name
void	setNameOverride(String nameOverride) Set override name
void	setObsoletes(List<RpmPackageAssociation> obsoletes) Set package obsoletes
void	setOperatingSystem(String operatingSystem) Set package operating system
void	setPackager(String packager) Set package packager
void	setPostInstallProgram(String postInstallProgram) Set post install program
void	setPostInstallScriptFile(File postInstallScriptFile) Set post install script file
void	setPostTransactionProgram(String postTransactionProgram) Set post transaction program
void	setPostTransactionScriptFile(File postTransactionScriptFile) Set post transaction script file
void	setPostUninstallProgram(String postUninstallProgram) Set post uninstall program
void	setPostUninstallScriptFile(File postUninstallScriptFile) Set post uninstall script file
void	setPrefixes(List<String> prefixes) Set list of prefixes
void	setPreInstallProgram(String preInstallProgram) Set pre install program
void	setPreInstallScriptFile(File preInstallScriptFile) Set pre install script file
void	setPreTransactionProgram(String preTransactionProgram) Set pre transaction program
void	setPreTransactionScriptFile(File preTransactionScriptFile) Set pre transaction script file
void	setPreUninstallProgram(String preUninstallProgram) Set pre uninstall program
void	setPreUninstallScriptFile(File preUninstallScriptFile) Set pre uninstall script file
void	setRelease(String release) Set package release
void	setRules(List<RpmPackageRule> rules) Set package rules
void	setSigningKey(String signingKey) Set signing key
void	setSigningKeyId(String signingKeyId) Set signing key id
void	setSigningKeyPassPhrase(String signingKeyPassPhrase) Set signing key pass phrase
void	setSourceRpm(String sourceRpm) Set source RPM name
void	setSummary(String summary) Set package summary
void	setTriggers(List<RpmTrigger> triggers) Set triggers
void	setUrl(String url) Set package url
void	setVersion(String version) Set package version

Methods inherited from class java.lang.Object

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

Constructor Detail

RpmPackage

public RpmPackage()

Method Detail

setMojo

public void setMojo(RpmMojo mojo)

Set mojo in use by Maven

Parameters:

mojo - Current maven mojo

getMojo

public RpmMojo getMojo()

Get mojo in use by Maven

Returns:

Current maven mojo

setName

public void setName(String name)

Set package name

Parameters:

name - Package name

getName

public String getName()

Get package name

Returns:

Package name

setNameOverride

public void setNameOverride(String nameOverride)

Set override name

Parameters:

nameOverride - override name

getNameOverride

public String getNameOverride()

Get override name

Returns:

Override name

setVersion

public void setVersion(String version)

Set package version

Parameters:

version - Package version

getVersion

public String getVersion()

Get package version

Returns:

Package version

getProjectVersion

public String getProjectVersion()

Get project version

Returns:

Project version

setRelease

public void setRelease(String release)

Set package release

Parameters:

release - Package release

getRelease

public String getRelease()

Get package release

Returns:

Package release

setFinalName

public void setFinalName(String finalName)

Set final name of RPM artifact

Parameters:

finalName - Final name of RPM artifact

getFinalName

public String getFinalName()

Get final name of the RPM artifact. If a final name is not set, the final name will default to {name}-{version}-{release}.{architecture}.rpm

Returns:

Final name of RPM artifact

setDependencies

public void setDependencies(List<RpmPackageAssociation> dependencies)

Set package dependencies

Parameters:

dependencies - Package dependencies

getDependencies

public List<RpmPackageAssociation> getDependencies()

Get package dependencies

Returns:

Package dependencies

setObsoletes

public void setObsoletes(List<RpmPackageAssociation> obsoletes)

Set package obsoletes

Parameters:

obsoletes - Package obsoletes

getObsoletes

public List<RpmPackageAssociation> getObsoletes()

Get package obsoletes

Returns:

Package obsoletes

setConflicts

public void setConflicts(List<RpmPackageAssociation> conflicts)

Set package conflicts

Parameters:

conflicts - Package conflicts

getConflicts

public List<RpmPackageAssociation> getConflicts()

Get package conflicts

Returns:

Package conflicts

setLinks

public void setLinks(List<RpmLink> links)

Set package links

Parameters:

links - Package links

getLinks

public List<RpmLink> getLinks()

Get package links

Returns:

Package links

setUrl

public void setUrl(String url)

Set package url

Parameters:

url - Package url

getUrl

public String getUrl()

Get package url

Returns:

Package url

setGroup

public void setGroup(String group)

Set package group

Parameters:

group - Package group

getGroup

public String getGroup()

Get package group

Returns:

Package group

setLicense

public void setLicense(String license)

Set package license

Parameters:

license - Package license

getLicense

public String getLicense()

Get package license

Returns:

Package license

setSummary

public void setSummary(String summary)

Set package summary

Parameters:

summary - Package summary

getSummary

public String getSummary()

Get package summary

Returns:

Package summary

setDescription

public void setDescription(String description)

Set package description

Parameters:

description - Package description

getDescription

public String getDescription()

Get package description

Returns:

Package description

setDistribution

public void setDistribution(String distribution)

Set package distribution

Parameters:

distribution - Package distribution

getDistribution

public String getDistribution()

Get package distribution

Returns:

Package distribution

setArchitecture

public void setArchitecture(String architecture)
                     throws UnknownArchitectureException

Set package architecture

Parameters:

architecture - Package architecture

Throws:

UnknownArchitectureException - The architecture supplied is not recognised.

getArchitecture

public org.redline_rpm.header.Architecture getArchitecture()

Get package architecture

Returns:

Package architecture

setOperatingSystem

public void setOperatingSystem(String operatingSystem)
                        throws UnknownOperatingSystemException

Set package operating system

Parameters:

operatingSystem - Package operating system

Throws:

UnknownOperatingSystemException - The operating system supplied is not recognised.

getOperatingSystem

public org.redline_rpm.header.Os getOperatingSystem()

Get package operating system. Defaults to LINUX if not set.

Returns:

Package operating system

setBuildHostName

public void setBuildHostName(String buildHostName)

Set package build host name

Parameters:

buildHostName - Package build host name

getBuildHostName

public String getBuildHostName()
                        throws UnknownHostException

Get package build host name. If one is not supplied, the default hostname of the machine running the build is used.

Returns:

Package build host name

Throws:

UnknownHostException - The build host could not be retrieved automatically.

setPackager

public void setPackager(String packager)

Set package packager

Parameters:

packager - Package packager

getPackager

public String getPackager()

Get packager

Returns:

Packager

setSourceRpm

public void setSourceRpm(String sourceRpm)

Set source RPM name

Parameters:

sourceRpm - Package sourceRpm

getSourceRpm

public String getSourceRpm()

Get source RPM name

Returns:

sourceRpm

setAttach

public void setAttach(boolean attach)

Set artifact attachment

Parameters:

attach - Artifact attachment

isAttach

public boolean isAttach()

Get artifact attachment

Returns:

Artifact is attached

setClassifier

public void setClassifier(String classifier)

Set the artifact classifier

Parameters:

classifier - Artifact classifier

getClassifier

public String getClassifier()

Get the artifact classifier

Returns:

Artifact classifier

setPreTransactionScriptFile

public void setPreTransactionScriptFile(File preTransactionScriptFile)

Set pre transaction script file

Parameters:

preTransactionScriptFile - Pre transaction script file

getPreTransactionScriptFile

public File getPreTransactionScriptFile()

Get pre transactions script file

Returns:

Pre transaction script file

setPreTransactionProgram

public void setPreTransactionProgram(String preTransactionProgram)

Set pre transaction program

Parameters:

preTransactionProgram - Pre transaction program

getPreTransactionProgram

public String getPreTransactionProgram()

Get pre transaction program

Returns:

Pre transaction program

setPreInstallScriptFile

public void setPreInstallScriptFile(File preInstallScriptFile)

Set pre install script file

Parameters:

preInstallScriptFile - Pre install script file

getPreInstallScriptFile

public File getPreInstallScriptFile()

Get pre install script file

Returns:

Pre install script file

setPreInstallProgram

public void setPreInstallProgram(String preInstallProgram)

Set pre install program

Parameters:

preInstallProgram - Pre install program

getPreInstallProgram

public String getPreInstallProgram()

Get pre install program

Returns:

Pre install program

setPostInstallScriptFile

public void setPostInstallScriptFile(File postInstallScriptFile)

Set post install script file

Parameters:

postInstallScriptFile - Post install script file

getPostInstallScriptFile

public File getPostInstallScriptFile()

Get post install script file

Returns:

Post install script file

setPostInstallProgram

public void setPostInstallProgram(String postInstallProgram)

Set post install program

Parameters:

postInstallProgram - Post install program

getPostInstallProgram

public String getPostInstallProgram()

Get post install program

Returns:

Post install program

setPreUninstallScriptFile

public void setPreUninstallScriptFile(File preUninstallScriptFile)

Set pre uninstall script file

Parameters:

preUninstallScriptFile - Pre uninstall script file

getPreUninstallScriptFile

public File getPreUninstallScriptFile()

Get pre uninstall script file

Returns:

Pre uninstall script file

setPreUninstallProgram

public void setPreUninstallProgram(String preUninstallProgram)

Set pre uninstall program

Parameters:

preUninstallProgram - Pre uninstall program

getPreUninstallProgram

public String getPreUninstallProgram()

Get pre uninstall program

Returns:

Pre uninstall program

setPostUninstallScriptFile

public void setPostUninstallScriptFile(File postUninstallScriptFile)

Set post uninstall script file

Parameters:

postUninstallScriptFile - Post uninstall script file

getPostUninstallScriptFile

public File getPostUninstallScriptFile()

Get post uninstall script file

Returns:

Post uninstall script file

setPostUninstallProgram

public void setPostUninstallProgram(String postUninstallProgram)

Set post uninstall program

Parameters:

postUninstallProgram - Post uninstall program

getPostUninstallProgram

public String getPostUninstallProgram()

Get post uninstall program

Returns:

Post uninstall program

setPostTransactionScriptFile

public void setPostTransactionScriptFile(File postTransactionScriptFile)

Set post transaction script file

Parameters:

postTransactionScriptFile - Post transaction script file

getPostTransactionScriptFile

public File getPostTransactionScriptFile()

Get post transaction script file

Returns:

Post transaction script file

setPostTransactionProgram

public void setPostTransactionProgram(String postTransactionProgram)

Set post transaction program

Parameters:

postTransactionProgram - Post transaction program

getPostTransactionProgram

public String getPostTransactionProgram()

Get post transaction program

Returns:

Post transaction program

setTriggers

public void setTriggers(List<RpmTrigger> triggers)

Set triggers

Parameters:

triggers - Triggers

getTriggers

public List<RpmTrigger> getTriggers()

Get triggers

Returns:

Triggers

setSigningKey

public void setSigningKey(String signingKey)

Set signing key

Parameters:

signingKey - Signing key

getSigningKey

public String getSigningKey()

Get signing key

Returns:

Signing key

setSigningKeyId

public void setSigningKeyId(String signingKeyId)

Set signing key id

Parameters:

signingKeyId - Signing key id

getSigningKeyId

public String getSigningKeyId()

Get signing key id

Returns:

Signing key id

setSigningKeyPassPhrase

public void setSigningKeyPassPhrase(String signingKeyPassPhrase)

Set signing key pass phrase

Parameters:

signingKeyPassPhrase - Signing key pass phrase

getSigningKeyPassPhrase

public String getSigningKeyPassPhrase()

Get signing key pass phrase

Returns:

Signing key pass phrase

setPrefixes

public void setPrefixes(List<String> prefixes)

Set list of prefixes

Parameters:

prefixes - List of Prefixes

getPrefixes

public List<String> getPrefixes()

Get list of prefixes

Returns:

List of prefixes

setRules

public void setRules(List<RpmPackageRule> rules)

Set package rules

Parameters:

rules - Package rules

getRules

public List<RpmPackageRule> getRules()

Get package rules

Returns:

Package rules

getLog

public org.apache.maven.plugin.logging.Log getLog()

Get the Maven logger

Returns:

Maven logger

build

public Set<String> build()
                  throws IOException,
                         NoSuchAlgorithmException,
                         AbstractRpmException

Build the package

Returns:

Files included within the package

Throws:

IOException

NoSuchAlgorithmException

AbstractRpmException

listFiles

public Set<String> listFiles()
                      throws AbstractRpmException

List files matched for the package

Returns:

Files included within the package

Throws:

AbstractRpmException