org.apache.maven.shared.app.company
Interface CompanyPomHandler

All Known Implementing Classes:

DefaultCompanyPomHandler

public interface CompanyPomHandler

Holds a company POM to avoid re-reading it.

Author:

Brett Porter

Field Summary

static java.lang.String	ORGANIZATION_LOGO_PROPERTY
static java.lang.String	ROLE

Method Summary

org.apache.maven.model.Model	getCompanyPomModel(CompanyPom companyPom, org.apache.maven.artifact.repository.ArtifactRepository localRepository) Retrieve the company model (may be cached).
org.apache.maven.model.Model	getCompanyPomModel(CompanyPom companyPom, org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List remoteRepositories) Retrieve the company model (may be cached).
void	save(org.apache.maven.model.Model companyModel, org.apache.maven.artifact.repository.ArtifactRepository localRepository) Save a company POM in the repository.
void	save(org.apache.maven.model.Model companyModel, org.apache.maven.artifact.repository.ArtifactRepository localRepository, org.apache.maven.artifact.repository.ArtifactRepository deploymentRepository) Save a company POM in the repository.

Field Detail

ROLE

static final java.lang.String ROLE

ORGANIZATION_LOGO_PROPERTY

static final java.lang.String ORGANIZATION_LOGO_PROPERTY

See Also:

Constant Field Values

Method Detail

getCompanyPomModel

org.apache.maven.model.Model getCompanyPomModel(CompanyPom companyPom,
                                                org.apache.maven.artifact.repository.ArtifactRepository localRepository)
                                                throws org.apache.maven.project.ProjectBuildingException,
                                                       org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

Retrieve the company model (may be cached).

Parameters:

companyPom - the configuration holding the required group and artifact ID

localRepository - the local repository to use while resolving the POM

Returns:

the model

Throws:

org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException - if there is a problem locating the existing POM from the repository

org.apache.maven.project.ProjectBuildingException - if the existing POM in the repository is invalid

getCompanyPomModel

org.apache.maven.model.Model getCompanyPomModel(CompanyPom companyPom,
                                                org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                                java.util.List remoteRepositories)
                                                throws org.apache.maven.project.ProjectBuildingException,
                                                       org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

Retrieve the company model (may be cached).

Parameters:

companyPom - the configuration holding the required group and artifact ID

localRepository - the local repository to use while resolving the POM

remoteRepositories - the repositories to search for the POM. The default repositories from the super POM will also be used if necessary.

Returns:

the model

Throws:

org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException - if there is a problem locating the existing POM from the repository

org.apache.maven.project.ProjectBuildingException - if the existing POM in the repository is invalid

save

void save(org.apache.maven.model.Model companyModel,
          org.apache.maven.artifact.repository.ArtifactRepository localRepository)
          throws java.io.IOException,
                 org.apache.maven.artifact.installer.ArtifactInstallationException

Save a company POM in the repository. At present, it does not deploy it to any remote repositories. The version in the model will be incremented to the next sequential single digit.

Parameters:

companyModel - the company model to save. This is likely to be the same instance already cached, but will replace the cached version regardless

localRepository - the local repository to use while deploying the POM.

Throws:

java.io.IOException - if there is a problem saving the model to the local repository

org.apache.maven.artifact.installer.ArtifactInstallationException - if there is a problem saving to the local repository

save

void save(org.apache.maven.model.Model companyModel,
          org.apache.maven.artifact.repository.ArtifactRepository localRepository,
          org.apache.maven.artifact.repository.ArtifactRepository deploymentRepository)
          throws java.io.IOException,
                 org.apache.maven.artifact.installer.ArtifactInstallationException,
                 org.apache.maven.artifact.deployer.ArtifactDeploymentException

Save a company POM in the repository. At present, it does not deploy it to any remote repositories. The version in the model will be incremented to the next sequential single digit.

Parameters:

companyModel - the company model to save. This is likely to be the same instance already cached, but will replace the cached version regardless

localRepository - the local repository to use while deploying the POM.

deploymentRepository - the repository to deploy the final POM to. If null, the POM is not deployed.

Throws:

java.io.IOException - if there is a problem saving the model to the local repository

org.apache.maven.artifact.installer.ArtifactInstallationException - if there is a problem saving to the local repository

org.apache.maven.artifact.deployer.ArtifactDeploymentException - if there is a problem deploying to the remote repository