org.apache.maven.plugin.eclipse.reader

Class ReadWorkspaceLocations

java.lang.Object

org.apache.maven.plugin.eclipse.reader.ReadWorkspaceLocations

public class ReadWorkspaceLocations
extends java.lang.Object

Scan the eclipse workspace and create a array with IdeDependency for all found artefacts.

Version:

$Id: ReadWorkspaceLocations.java 825429 2009-10-15 08:07:26Z nicolas $

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	ARTEFACT_ID
static java.lang.String	BINARY_LOCATION_FILE
private static java.lang.String	CLASSPATHENTRY_DEFAULT
private static java.lang.String	CLASSPATHENTRY_FORMAT
private static java.lang.String	CLASSPATHENTRY_STANDARD
private static java.lang.String[]	GROUP_ID
static java.lang.String	METADATA_PLUGINS_ORG_ECLIPSE_CORE_RESOURCES_PROJECTS
private static java.lang.String	METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_LAUNCHING_PREFS
private static java.lang.String	METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_PREFS_RUNTIMES_KEY
private static java.lang.String	METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_PREFS_VM_KEY
private static java.lang.String	METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_SERVER_PREFS
private static java.lang.String[]	PACKAGING
private static java.lang.String[]	PARENT_GROUP_ID
private static java.lang.String[]	PARENT_VERSION
private static java.lang.String[]	VERSION

Constructor Summary

Constructors

Constructor and Description
ReadWorkspaceLocations()

Method Summary

Modifier and Type	Method and Description
private void	detectDefaultJREContainer(WorkspaceConfiguration workspaceConfiguration, org.apache.maven.project.MavenProject project, org.apache.maven.plugin.logging.Log logger) Search the default JREContainer from eclipse for the current MavenProject
private void	detectWTPDefaultServer(WorkspaceConfiguration workspaceConfiguration, java.lang.String wtpDefaultServer, org.apache.maven.plugin.logging.Log log) Detect WTP Default Server.
private java.lang.String	getContainerFromExecutable(java.lang.String rawExecutable, java.util.Map jreMap, org.apache.maven.plugin.logging.Log logger) Take the compiler executable and try to find a JRE that contains that compiler.
(package private) java.io.File	getProjectLocation(java.io.File workspaceLocation, java.io.File project) Get the project location for a project in the eclipse metadata.
private java.lang.String	getValue(org.codehaus.plexus.util.xml.Xpp3Dom element, java.lang.String[] elementNames, java.lang.String defaultValue) get a value from a dom element.
void	init(org.apache.maven.plugin.logging.Log log, WorkspaceConfiguration workspaceConfiguration, org.apache.maven.project.MavenProject project, java.lang.String wtpDefaultServer)
private IdeDependency	readArtefact(java.io.File projectLocation, org.apache.maven.plugin.logging.Log logger) Read the artefact information from the pom in the project location and the eclipse project name from the .project file.
private java.util.HashMap	readAvailableJREs(java.io.File workspaceLocation, org.apache.maven.plugin.logging.Log logger) Read the JRE definition configured in the workspace.
(package private) java.util.HashMap	readDefinedServers(WorkspaceConfiguration workspaceConfiguration, org.apache.maven.plugin.logging.Log logger)
private void	readWorkspace(WorkspaceConfiguration workspaceConfiguration, org.apache.maven.plugin.logging.Log logger) Scan the eclipse workspace and create a array with IdeDependency for all found artifacts.

Methods inherited from class java.lang.Object

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

Field Detail

BINARY_LOCATION_FILE

public static final java.lang.String BINARY_LOCATION_FILE

See Also:

Constant Field Values

METADATA_PLUGINS_ORG_ECLIPSE_CORE_RESOURCES_PROJECTS

public static final java.lang.String METADATA_PLUGINS_ORG_ECLIPSE_CORE_RESOURCES_PROJECTS

See Also:

Constant Field Values

PARENT_VERSION

private static final java.lang.String[] PARENT_VERSION

PARENT_GROUP_ID

private static final java.lang.String[] PARENT_GROUP_ID

PACKAGING

private static final java.lang.String[] PACKAGING

VERSION

private static final java.lang.String[] VERSION

GROUP_ID

private static final java.lang.String[] GROUP_ID

ARTEFACT_ID

private static final java.lang.String[] ARTEFACT_ID

METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_LAUNCHING_PREFS

private static final java.lang.String METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_LAUNCHING_PREFS

See Also:

Constant Field Values

METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_PREFS_VM_KEY

private static final java.lang.String METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_PREFS_VM_KEY

See Also:

Constant Field Values

METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_SERVER_PREFS

private static final java.lang.String METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_SERVER_PREFS

See Also:

Constant Field Values

METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_PREFS_RUNTIMES_KEY

private static final java.lang.String METADATA_PLUGINS_ORG_ECLIPSE_CORE_RUNTIME_PREFS_RUNTIMES_KEY

See Also:

Constant Field Values

CLASSPATHENTRY_DEFAULT

private static final java.lang.String CLASSPATHENTRY_DEFAULT

See Also:

Constant Field Values

CLASSPATHENTRY_STANDARD

private static final java.lang.String CLASSPATHENTRY_STANDARD

See Also:

Constant Field Values

CLASSPATHENTRY_FORMAT

private static final java.lang.String CLASSPATHENTRY_FORMAT

See Also:

Constant Field Values

Constructor Detail

ReadWorkspaceLocations

public ReadWorkspaceLocations()

Method Detail

init

public void init(org.apache.maven.plugin.logging.Log log,
                 WorkspaceConfiguration workspaceConfiguration,
                 org.apache.maven.project.MavenProject project,
                 java.lang.String wtpDefaultServer)

detectWTPDefaultServer

private void detectWTPDefaultServer(WorkspaceConfiguration workspaceConfiguration,
                                    java.lang.String wtpDefaultServer,
                                    org.apache.maven.plugin.logging.Log log)

Detect WTP Default Server. Do nothing if tehre are no defined servers in the settings.

Parameters:

workspaceConfiguration -

wtpDefaultServer -

log -

getContainerFromExecutable

private java.lang.String getContainerFromExecutable(java.lang.String rawExecutable,
                                                    java.util.Map jreMap,
                                                    org.apache.maven.plugin.logging.Log logger)

Take the compiler executable and try to find a JRE that contains that compiler.

Parameters:

rawExecutable - the executable with the complete path.

jreMap - the map with defined JRE's.

logger - the logger to log the error's

Returns:

the found container or null if non found.

detectDefaultJREContainer

private void detectDefaultJREContainer(WorkspaceConfiguration workspaceConfiguration,
                                       org.apache.maven.project.MavenProject project,
                                       org.apache.maven.plugin.logging.Log logger)

Search the default JREContainer from eclipse for the current MavenProject

Parameters:

workspaceLocation - the location of the workspace.

project - the maven project the get the configuration

logger - the logger for errors

getProjectLocation

java.io.File getProjectLocation(java.io.File workspaceLocation,
                                java.io.File project)
                         throws java.io.IOException,
                                java.net.URISyntaxException

Get the project location for a project in the eclipse metadata.

Parameters:

workspaceLocation - the location of the workspace

project - the project subdirectory in the metadata

Returns:

the full path to the project.

Throws:

java.io.IOException - failures to read location file

java.net.URISyntaxException - failures to read location file

getValue

private java.lang.String getValue(org.codehaus.plexus.util.xml.Xpp3Dom element,
                                  java.lang.String[] elementNames,
                                  java.lang.String defaultValue)

get a value from a dom element.

Parameters:

element - the element to get a value from

elementNames - the sub elements to get

defaultValue - teh default value if the value was null or empty

Returns:

the value of the dome element.

readArtefact

private IdeDependency readArtefact(java.io.File projectLocation,
                                   org.apache.maven.plugin.logging.Log logger)
                            throws java.io.FileNotFoundException,
                                   org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                                   java.io.IOException

Read the artefact information from the pom in the project location and the eclipse project name from the .project file.

Parameters:

projectLocation - the location of the project

logger - the logger to report errors and debug info.

Returns:

an IdeDependency or null.

Throws:

java.io.FileNotFoundException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

java.io.IOException

readDefinedServers

java.util.HashMap readDefinedServers(WorkspaceConfiguration workspaceConfiguration,
                                     org.apache.maven.plugin.logging.Log logger)

readAvailableJREs

private java.util.HashMap readAvailableJREs(java.io.File workspaceLocation,
                                            org.apache.maven.plugin.logging.Log logger)

Read the JRE definition configured in the workspace. They will be put in a HashMap with as key there path and as value the JRE constant. a second key is included with the JRE version as a key.

Parameters:

workspaceLocation - the workspace location

logger - the logger to error messages

Returns:

the map with found jre's

readWorkspace

private void readWorkspace(WorkspaceConfiguration workspaceConfiguration,
                           org.apache.maven.plugin.logging.Log logger)

Scan the eclipse workspace and create a array with IdeDependency for all found artifacts.

Parameters:

workspaceLocation - the location of the eclipse workspace.

logger - the logger to report errors and debug info.