org.eclipse.m2e.core.internal.project

Class ProjectConfigurationManager

java.lang.Object

org.eclipse.m2e.core.internal.project.ProjectConfigurationManager

All Implemented Interfaces:

java.util.EventListener, org.eclipse.core.resources.IResourceChangeListener, IMavenProjectChangedListener, IProjectConfigurationManager

public class ProjectConfigurationManager
extends java.lang.Object
implements IProjectConfigurationManager, IMavenProjectChangedListener, org.eclipse.core.resources.IResourceChangeListener

import Maven projects update project configuration from Maven enable Maven nature create new project

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static org.slf4j.Logger	log
(package private) IMaven	maven
(package private) IMavenConfiguration	mavenConfiguration
(package private) IMavenMarkerManager	mavenMarkerManager
(package private) MavenModelManager	mavenModelManager
(package private) ProjectRegistryManager	projectManager

Constructor Summary

Constructors

Constructor and Description
ProjectConfigurationManager(IMaven maven, ProjectRegistryManager projectManager, MavenModelManager mavenModelManager, IMavenMarkerManager mavenMarkerManager, IMavenConfiguration mavenConfiguration)

Method Summary

Modifier and Type	Method and Description
boolean	addMavenBuilder(org.eclipse.core.resources.IProject project, org.eclipse.core.resources.IProjectDescription description, org.eclipse.core.runtime.IProgressMonitor monitor) Adds the maven builder to the specified project.
private void	addMavenNature(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor)
java.util.Set<MavenProjectInfo>	collectProjects(java.util.Collection<MavenProjectInfo> projects)
(package private) void	configureNewMavenProjects(java.util.List<org.eclipse.core.resources.IProject> projects, org.eclipse.core.runtime.IProgressMonitor monitor)
(package private) org.eclipse.core.resources.IProject	create(MavenProjectInfo projectInfo, ProjectImportConfiguration configuration, IProjectCreationListener listener, org.eclipse.core.runtime.IProgressMonitor monitor)
void	createArchetypeProject(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IPath location, org.apache.maven.archetype.catalog.Archetype archetype, java.lang.String groupId, java.lang.String artifactId, java.lang.String version, java.lang.String javaPackage, java.util.Properties properties, ProjectImportConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated. use createArchetypeProjects(IPath, Archetype, String, String, String, String, Properties, ProjectImportConfiguration, IProgressMonitor)
java.util.List<org.eclipse.core.resources.IProject>	createArchetypeProjects(org.eclipse.core.runtime.IPath location, org.apache.maven.archetype.catalog.Archetype archetype, java.lang.String groupId, java.lang.String artifactId, java.lang.String version, java.lang.String javaPackage, java.util.Properties properties, ProjectImportConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor) Creates project structure using Archetype and then imports created project(s)
java.util.List<org.eclipse.core.resources.IProject>	createArchetypeProjects(org.eclipse.core.runtime.IPath location, org.apache.maven.archetype.catalog.Archetype archetype, java.lang.String groupId, java.lang.String artifactId, java.lang.String version, java.lang.String javaPackage, java.util.Properties properties, ProjectImportConfiguration configuration, IProjectCreationListener listener, org.eclipse.core.runtime.IProgressMonitor monitor) Creates project structure using Archetype and then imports created project(s)
(package private) java.util.List<org.eclipse.core.resources.IProject>	createArchetypeProjects0(org.eclipse.core.runtime.IPath location, org.apache.maven.archetype.catalog.Archetype archetype, java.lang.String groupId, java.lang.String artifactId, java.lang.String version, java.lang.String javaPackage, java.util.Properties properties, ProjectImportConfiguration configuration, IProjectCreationListener listener, org.eclipse.core.runtime.IProgressMonitor monitor)
static void	createFolder(org.eclipse.core.resources.IFolder folder, boolean derived) Helper method which creates a folder and, recursively, all its parent folders.
void	createSimpleProject(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IPath location, org.apache.maven.model.Model model, java.lang.String[] directories, ProjectImportConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor)
void	createSimpleProject(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IPath location, org.apache.maven.model.Model model, java.lang.String[] directories, ProjectImportConfiguration configuration, IProjectCreationListener listener, org.eclipse.core.runtime.IProgressMonitor monitor) Creates simple Maven project
void	disableMavenNature(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor)
(package private) void	enableBasicMavenNature(org.eclipse.core.resources.IProject project, ResolverConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor)
void	enableMavenNature(org.eclipse.core.resources.IProject project, ResolverConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor)
(package private) java.util.List<org.eclipse.core.resources.IProject>	findExistingProjectsToHideFrom() Finds all existing Maven IProjects to hide from, if "hide folders of nested projects" preference is on, else, returns an empty list.
private org.eclipse.core.resources.IProject	findParentProject(org.apache.maven.model.Model model)
private org.apache.maven.archetype.ArchetypeManager	getArchetyper()
private java.io.File	getCanonicalPomFile(java.io.File projectDir)
ILifecycleMapping	getLifecycleMapping(IMavenProjectFacade projectFacade)
ResolverConfiguration	getResolverConfiguration(org.eclipse.core.resources.IProject project) PROVISIONAL
org.eclipse.core.runtime.jobs.ISchedulingRule	getRule()
(package private) void	hideNestedProjectsFromParents(java.util.List<org.eclipse.core.resources.IProject> projects, java.util.List<org.eclipse.core.resources.IProject> existingProjects, org.eclipse.core.runtime.IProgressMonitor monitor)
java.util.List<IMavenProjectImportResult>	importProjects(java.util.Collection<MavenProjectInfo> projectInfos, ProjectImportConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor)
java.util.List<IMavenProjectImportResult>	importProjects(java.util.Collection<MavenProjectInfo> projectInfos, ProjectImportConfiguration configuration, IProjectCreationListener listener, org.eclipse.core.runtime.IProgressMonitor monitor)
private boolean	isMavenBuilderCommand(org.eclipse.core.resources.IProject project, org.eclipse.core.resources.ICommand command)
void	mavenProjectChanged(MavenProjectChangedEvent[] events, org.eclipse.core.runtime.IProgressMonitor monitor) This method is called while holding workspace lock.
boolean	removeMavenBuilder(org.eclipse.core.resources.IProject project, org.eclipse.core.resources.IProjectDescription description, org.eclipse.core.runtime.IProgressMonitor monitor) Removes the maven builder from the specified project.
private org.apache.maven.artifact.Artifact	resolveArchetype(org.apache.maven.archetype.catalog.Archetype a, org.eclipse.core.runtime.IProgressMonitor monitor) Apparently, Archetype#generateProjectFromArchetype 2.0-alpha-4 does not attempt to resolve archetype from configured remote repositories.
void	resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)
private void	setHidden(org.eclipse.core.resources.IResource resource)
boolean	setResolverConfiguration(org.eclipse.core.resources.IProject project, ResolverConfiguration configuration) PROVISIONAL
void	sortProjects(java.util.List<IMavenProjectFacade> facades, org.eclipse.core.runtime.IProgressMonitor monitor)
void	updateProjectConfiguration(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor)
java.util.Map<java.lang.String,org.eclipse.core.runtime.IStatus>	updateProjectConfiguration(MavenUpdateRequest request, boolean updateConfiguration, boolean cleanProjects, boolean refreshFromLocal, org.eclipse.core.runtime.IProgressMonitor monitor) Returns project name to update status map.
java.util.Map<java.lang.String,org.eclipse.core.runtime.IStatus>	updateProjectConfiguration(MavenUpdateRequest request, boolean updateConfiguration, boolean cleanProjects, org.eclipse.core.runtime.IProgressMonitor monitor) Returns project name to update status map.
void	updateProjectConfiguration(MavenUpdateRequest request, org.eclipse.core.runtime.IProgressMonitor monitor)
private void	updateProjectConfiguration(ProjectConfigurationRequest request, org.eclipse.core.runtime.IProgressMonitor monitor)
(package private) java.util.Map<java.lang.String,org.eclipse.core.runtime.IStatus>	updateProjectConfiguration0(java.util.Collection<org.eclipse.core.resources.IFile> pomFiles, boolean updateConfiguration, boolean cleanProjects, boolean refreshFromLocal, org.eclipse.core.runtime.IProgressMonitor monitor)

Methods inherited from class java.lang.Object

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

Field Detail

log

static final org.slf4j.Logger log

projectManager

final ProjectRegistryManager projectManager

mavenModelManager

final MavenModelManager mavenModelManager

mavenMarkerManager

final IMavenMarkerManager mavenMarkerManager

maven

final IMaven maven

mavenConfiguration

final IMavenConfiguration mavenConfiguration

Constructor Detail

ProjectConfigurationManager

public ProjectConfigurationManager(IMaven maven,
                                   ProjectRegistryManager projectManager,
                                   MavenModelManager mavenModelManager,
                                   IMavenMarkerManager mavenMarkerManager,
                                   IMavenConfiguration mavenConfiguration)

Method Detail

importProjects

public java.util.List<IMavenProjectImportResult> importProjects(java.util.Collection<MavenProjectInfo> projectInfos,
                                                                ProjectImportConfiguration configuration,
                                                                org.eclipse.core.runtime.IProgressMonitor monitor)
                                                         throws org.eclipse.core.runtime.CoreException

Specified by:

importProjects in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

importProjects

public java.util.List<IMavenProjectImportResult> importProjects(java.util.Collection<MavenProjectInfo> projectInfos,
                                                                ProjectImportConfiguration configuration,
                                                                IProjectCreationListener listener,
                                                                org.eclipse.core.runtime.IProgressMonitor monitor)
                                                         throws org.eclipse.core.runtime.CoreException

Specified by:

importProjects in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

setHidden

private void setHidden(org.eclipse.core.resources.IResource resource)

hideNestedProjectsFromParents

void hideNestedProjectsFromParents(java.util.List<org.eclipse.core.resources.IProject> projects,
                                   java.util.List<org.eclipse.core.resources.IProject> existingProjects,
                                   org.eclipse.core.runtime.IProgressMonitor monitor)

configureNewMavenProjects

void configureNewMavenProjects(java.util.List<org.eclipse.core.resources.IProject> projects,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

sortProjects

public void sortProjects(java.util.List<IMavenProjectFacade> facades,
                         org.eclipse.core.runtime.IProgressMonitor monitor)
                  throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

updateProjectConfiguration

public void updateProjectConfiguration(org.eclipse.core.resources.IProject project,
                                       org.eclipse.core.runtime.IProgressMonitor monitor)
                                throws org.eclipse.core.runtime.CoreException

Specified by:

updateProjectConfiguration in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

updateProjectConfiguration

public void updateProjectConfiguration(MavenUpdateRequest request,
                                       org.eclipse.core.runtime.IProgressMonitor monitor)
                                throws org.eclipse.core.runtime.CoreException

Specified by:

updateProjectConfiguration in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

updateProjectConfiguration

public java.util.Map<java.lang.String,org.eclipse.core.runtime.IStatus> updateProjectConfiguration(MavenUpdateRequest request,
                                                                                                   boolean updateConfiguration,
                                                                                                   boolean cleanProjects,
                                                                                                   org.eclipse.core.runtime.IProgressMonitor monitor)

Returns project name to update status map.

TODO promote to API

Since:

1.1

updateProjectConfiguration

public java.util.Map<java.lang.String,org.eclipse.core.runtime.IStatus> updateProjectConfiguration(MavenUpdateRequest request,
                                                                                                   boolean updateConfiguration,
                                                                                                   boolean cleanProjects,
                                                                                                   boolean refreshFromLocal,
                                                                                                   org.eclipse.core.runtime.IProgressMonitor monitor)

Returns project name to update status map.

TODO promote to API. TODO decide if workspace or other lock is required during execution of this method.

Since:

1.4

updateProjectConfiguration0

java.util.Map<java.lang.String,org.eclipse.core.runtime.IStatus> updateProjectConfiguration0(java.util.Collection<org.eclipse.core.resources.IFile> pomFiles,
                                                                                             boolean updateConfiguration,
                                                                                             boolean cleanProjects,
                                                                                             boolean refreshFromLocal,
                                                                                             org.eclipse.core.runtime.IProgressMonitor monitor)

updateProjectConfiguration

private void updateProjectConfiguration(ProjectConfigurationRequest request,
                                        org.eclipse.core.runtime.IProgressMonitor monitor)
                                 throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

enableMavenNature

public void enableMavenNature(org.eclipse.core.resources.IProject project,
                              ResolverConfiguration configuration,
                              org.eclipse.core.runtime.IProgressMonitor monitor)
                       throws org.eclipse.core.runtime.CoreException

Specified by:

enableMavenNature in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

enableBasicMavenNature

void enableBasicMavenNature(org.eclipse.core.resources.IProject project,
                            ResolverConfiguration configuration,
                            org.eclipse.core.runtime.IProgressMonitor monitor)
                     throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

addMavenNature

private void addMavenNature(org.eclipse.core.resources.IProject project,
                            org.eclipse.core.runtime.IProgressMonitor monitor)
                     throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

disableMavenNature

public void disableMavenNature(org.eclipse.core.resources.IProject project,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws org.eclipse.core.runtime.CoreException

Specified by:

disableMavenNature in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

addMavenBuilder

public boolean addMavenBuilder(org.eclipse.core.resources.IProject project,
                               org.eclipse.core.resources.IProjectDescription description,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws org.eclipse.core.runtime.CoreException

Description copied from interface: IProjectConfigurationManager

Adds the maven builder to the specified project.

Specified by:

addMavenBuilder in interface IProjectConfigurationManager

Returns:

true if the maven builder was added or its position in the list of builders was changed

Throws:

org.eclipse.core.runtime.CoreException

removeMavenBuilder

public boolean removeMavenBuilder(org.eclipse.core.resources.IProject project,
                                  org.eclipse.core.resources.IProjectDescription description,
                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                           throws org.eclipse.core.runtime.CoreException

Description copied from interface: IProjectConfigurationManager

Removes the maven builder from the specified project.

Specified by:

removeMavenBuilder in interface IProjectConfigurationManager

Returns:

true if the maven builder was removed

Throws:

org.eclipse.core.runtime.CoreException

isMavenBuilderCommand

private boolean isMavenBuilderCommand(org.eclipse.core.resources.IProject project,
                                      org.eclipse.core.resources.ICommand command)

createSimpleProject

public void createSimpleProject(org.eclipse.core.resources.IProject project,
                                org.eclipse.core.runtime.IPath location,
                                org.apache.maven.model.Model model,
                                java.lang.String[] directories,
                                ProjectImportConfiguration configuration,
                                org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws org.eclipse.core.runtime.CoreException

Specified by:

createSimpleProject in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

createSimpleProject

public void createSimpleProject(org.eclipse.core.resources.IProject project,
                                org.eclipse.core.runtime.IPath location,
                                org.apache.maven.model.Model model,
                                java.lang.String[] directories,
                                ProjectImportConfiguration configuration,
                                IProjectCreationListener listener,
                                org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws org.eclipse.core.runtime.CoreException

Creates simple Maven project

The following steps are executed in the given order:

• Creates the workspace project
• Adds project to working set
• Creates the required folders
• Creates the POM
• Configures project

Specified by:

createSimpleProject in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

findParentProject

private org.eclipse.core.resources.IProject findParentProject(org.apache.maven.model.Model model)

createFolder

public static void createFolder(org.eclipse.core.resources.IFolder folder,
                                boolean derived)
                         throws org.eclipse.core.runtime.CoreException

Helper method which creates a folder and, recursively, all its parent folders.

Parameters:

folder - The folder to create.

derived - true if folder should be marked as derived

Throws:

org.eclipse.core.runtime.CoreException - if creating the given folder or any of its parents fails.

createArchetypeProject

@Deprecated
public void createArchetypeProject(org.eclipse.core.resources.IProject project,
                                               org.eclipse.core.runtime.IPath location,
                                               org.apache.maven.archetype.catalog.Archetype archetype,
                                               java.lang.String groupId,
                                               java.lang.String artifactId,
                                               java.lang.String version,
                                               java.lang.String javaPackage,
                                               java.util.Properties properties,
                                               ProjectImportConfiguration configuration,
                                               org.eclipse.core.runtime.IProgressMonitor monitor)
                                        throws org.eclipse.core.runtime.CoreException

Deprecated. use createArchetypeProjects(IPath, Archetype, String, String, String, String, Properties, ProjectImportConfiguration, IProgressMonitor)

Creates project structure using Archetype and then imports created project(s)

Specified by:

createArchetypeProject in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

createArchetypeProjects

public java.util.List<org.eclipse.core.resources.IProject> createArchetypeProjects(org.eclipse.core.runtime.IPath location,
                                                                                   org.apache.maven.archetype.catalog.Archetype archetype,
                                                                                   java.lang.String groupId,
                                                                                   java.lang.String artifactId,
                                                                                   java.lang.String version,
                                                                                   java.lang.String javaPackage,
                                                                                   java.util.Properties properties,
                                                                                   ProjectImportConfiguration configuration,
                                                                                   org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                            throws org.eclipse.core.runtime.CoreException

Creates project structure using Archetype and then imports created project(s)

Specified by:

createArchetypeProjects in interface IProjectConfigurationManager

Returns:

an unmodifiable list of created projects.

Throws:

org.eclipse.core.runtime.CoreException

Since:

1.1

createArchetypeProjects

public java.util.List<org.eclipse.core.resources.IProject> createArchetypeProjects(org.eclipse.core.runtime.IPath location,
                                                                                   org.apache.maven.archetype.catalog.Archetype archetype,
                                                                                   java.lang.String groupId,
                                                                                   java.lang.String artifactId,
                                                                                   java.lang.String version,
                                                                                   java.lang.String javaPackage,
                                                                                   java.util.Properties properties,
                                                                                   ProjectImportConfiguration configuration,
                                                                                   IProjectCreationListener listener,
                                                                                   org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                            throws org.eclipse.core.runtime.CoreException

Creates project structure using Archetype and then imports created project(s)

Specified by:

createArchetypeProjects in interface IProjectConfigurationManager

Returns:

an unmodifiable list of created projects.

Throws:

org.eclipse.core.runtime.CoreException

Since:

1.8

createArchetypeProjects0

java.util.List<org.eclipse.core.resources.IProject> createArchetypeProjects0(org.eclipse.core.runtime.IPath location,
                                                                             org.apache.maven.archetype.catalog.Archetype archetype,
                                                                             java.lang.String groupId,
                                                                             java.lang.String artifactId,
                                                                             java.lang.String version,
                                                                             java.lang.String javaPackage,
                                                                             java.util.Properties properties,
                                                                             ProjectImportConfiguration configuration,
                                                                             IProjectCreationListener listener,
                                                                             org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                      throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

resolveArchetype

private org.apache.maven.artifact.Artifact resolveArchetype(org.apache.maven.archetype.catalog.Archetype a,
                                                            org.eclipse.core.runtime.IProgressMonitor monitor)
                                                     throws org.eclipse.core.runtime.CoreException

Apparently, Archetype#generateProjectFromArchetype 2.0-alpha-4 does not attempt to resolve archetype from configured remote repositories. To compensate, we populate local repo with archetype pom/jar.

Throws:

org.eclipse.core.runtime.CoreException

getArchetyper

private org.apache.maven.archetype.ArchetypeManager getArchetyper()

collectProjects

public java.util.Set<MavenProjectInfo> collectProjects(java.util.Collection<MavenProjectInfo> projects)

Specified by:

collectProjects in interface IProjectConfigurationManager

getRule

public org.eclipse.core.runtime.jobs.ISchedulingRule getRule()

Specified by:

getRule in interface IProjectConfigurationManager

create

org.eclipse.core.resources.IProject create(MavenProjectInfo projectInfo,
                                           ProjectImportConfiguration configuration,
                                           IProjectCreationListener listener,
                                           org.eclipse.core.runtime.IProgressMonitor monitor)
                                    throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

getCanonicalPomFile

private java.io.File getCanonicalPomFile(java.io.File projectDir)
                                  throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

mavenProjectChanged

public void mavenProjectChanged(MavenProjectChangedEvent[] events,
                                org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IMavenProjectChangedListener

This method is called while holding workspace lock.

Specified by:

mavenProjectChanged in interface IMavenProjectChangedListener

getLifecycleMapping

public ILifecycleMapping getLifecycleMapping(IMavenProjectFacade projectFacade)
                                      throws org.eclipse.core.runtime.CoreException

Specified by:

getLifecycleMapping in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

resourceChanged

public void resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)

Specified by:

resourceChanged in interface org.eclipse.core.resources.IResourceChangeListener

getResolverConfiguration

public ResolverConfiguration getResolverConfiguration(org.eclipse.core.resources.IProject project)

Description copied from interface: IProjectConfigurationManager

PROVISIONAL

Specified by:

getResolverConfiguration in interface IProjectConfigurationManager

setResolverConfiguration

public boolean setResolverConfiguration(org.eclipse.core.resources.IProject project,
                                        ResolverConfiguration configuration)

Description copied from interface: IProjectConfigurationManager

PROVISIONAL

Specified by:

setResolverConfiguration in interface IProjectConfigurationManager

findExistingProjectsToHideFrom

java.util.List<org.eclipse.core.resources.IProject> findExistingProjectsToHideFrom()

Finds all existing Maven IProjects to hide from, if "hide folders of nested projects" preference is on, else, returns an empty list.