org.springframework.roo.project.packaging

Class AbstractPackagingProvider

java.lang.Object

org.springframework.roo.project.packaging.AbstractPackagingProvider

All Implemented Interfaces:

PackagingProvider

Direct Known Subclasses:

EarPackaging, EsaPackaging, JarPackaging, PomPackaging, WarPackaging

public abstract class AbstractPackagingProvider
extends Object
implements PackagingProvider

Convenient superclass for core or third-party addons to implement a PackagingProvider. Uses the "Template Method" GoF pattern.

Since:

1.2.0

Author:

Andrew Swan, Paula Navarro, Juan Carlos García

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.roo.process.manager.FileManager	fileManager
protected static Logger	LOGGER
protected PathResolver	pathResolver
static String	ROO_PACKAGING_PROVIDER_PROPERTY The name of the POM property that stores the packaging provider's ID.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPackagingProvider(String id, String name, String pomTemplate) Constructor
protected	AbstractPackagingProvider(String id, String name, String pomTemplate, String pomModuleTemplate) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext cContext)
String	createArtifacts(org.springframework.roo.model.JavaPackage topLevelPackage, String nullableProjectName, String javaVersion, GAV parentPom, String module, ProjectOperations projectOperations) Creates the initial set of artifacts (files and directories) for a module with this type of packaging; this includes setting the POM's /project/packaging element to the desired value.
protected void	createOtherArtifacts(org.springframework.roo.model.JavaPackage topLevelPackage, String module, ProjectOperations projectOperations) Subclasses can override this method to create any other required files or directories (apart from the POM, which has previously been generated by createPom(org.springframework.roo.model.JavaPackage, java.lang.String, java.lang.String, org.springframework.roo.project.GAV, java.lang.String, org.springframework.roo.project.ProjectOperations)).
protected String	createPom(org.springframework.roo.model.JavaPackage topLevelPackage, String projectName, String javaVersion, GAV parentPom, String module, ProjectOperations projectOperations) Creates the Maven POM using the subclass' POM template as follows: sets the parent POM to the given parent (if any) sets the groupId to the result of getGroupId(org.springframework.roo.model.JavaPackage), omitting this element if it's the same as the parent's groupId (as per Maven best practice) sets the artifactId to the result of getArtifactId(java.lang.String, java.lang.String, org.springframework.roo.model.JavaPackage) sets the packaging to the result of #getName() sets the project name to the result of getProjectName(java.lang.String, java.lang.String, org.springframework.roo.model.JavaPackage) replaces all occurrences of JAVA_PRODUCT_VERSION_PLACEHOLDER with the given Java version This method makes as few assumptions about the POM template as possible, to make life easier for anyone writing a PackagingProvider.
protected String	getArtifactId(String nullableProjectName, String module, org.springframework.roo.model.JavaPackage topLevelPackage) Returns the text to be inserted into the POM's <artifactId> element.
org.springframework.roo.process.manager.FileManager	getFileManager()
protected String	getFullyQualifiedModuleName(String moduleName, ProjectOperations projectOperations) Returns the fully-qualified name of the given module, relative to the currently focused module.
protected String	getGroupId(org.springframework.roo.model.JavaPackage topLevelPackage) Returns the groupId of the project or module being created.
String	getId() Returns the unique identifier of this PackagingProvider, for use in the Roo user interface.
PathResolver	getPathResolver()
protected String	getProjectName(String nullableProjectName, String module, org.springframework.roo.model.JavaPackage topLevelPackage) Returns the text to be inserted into the POM's <name> element.
protected void	setGroupIdAndParent(String projectGroupId, GAV parentPom, Element root, Document pom) Sets the Maven groupIds of the parent and/or project as necessary
protected void	setPackagingProviderId(Document pom) Stores the ID of this PackagingProvider as a POM property called "roo.packaging.provider".

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.roo.project.packaging.PackagingProvider

getPaths, isDefault

Field Detail

LOGGER

protected static final Logger LOGGER

ROO_PACKAGING_PROVIDER_PROPERTY

public static final String ROO_PACKAGING_PROVIDER_PROPERTY

The name of the POM property that stores the packaging provider's ID.

See Also:

Constant Field Values

fileManager

protected org.springframework.roo.process.manager.FileManager fileManager

pathResolver

protected PathResolver pathResolver

Constructor Detail

AbstractPackagingProvider

protected AbstractPackagingProvider(String id,
                                    String name,
                                    String pomTemplate)

Constructor

Parameters:

id - the unique ID of this packaging type, see PackagingProvider.getId()

name - the name of this type of packaging as used in the POM (required)

pomTemplate - the path of this packaging type's POM template, relative to its own package, as per Class.getResourceAsStream(String); this template should contain a "parent" element with its own groupId, artifactId, and version elements; this parent element will be removed if not required

AbstractPackagingProvider

protected AbstractPackagingProvider(String id,
                                    String name,
                                    String pomTemplate,
                                    String pomModuleTemplate)

Constructor

Parameters:

id - the unique ID of this packaging type, see PackagingProvider.getId()

name - the name of this type of packaging as used in the POM (required)

pomTemplate - the path of this packaging type's POM template, relative to its own package, as per Class.getResourceAsStream(String); this template should contain a "parent" element with its own groupId, artifactId, and version elements; this parent element will be removed if not required

pomModuleTemplate - the path of this packaging type's POM module template, relative to its own package, as per Class.getResourceAsStream(String); this template should contain a "parent" element with its own groupId, artifactId, and version elements; can be null

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext cContext)

createArtifacts

public String createArtifacts(org.springframework.roo.model.JavaPackage topLevelPackage,
                              String nullableProjectName,
                              String javaVersion,
                              GAV parentPom,
                              String module,
                              ProjectOperations projectOperations)

Description copied from interface: PackagingProvider

Creates the initial set of artifacts (files and directories) for a module with this type of packaging; this includes setting the POM's /project/packaging element to the desired value.

Specified by:

createArtifacts in interface PackagingProvider

Parameters:

topLevelPackage - the top-level Java package for the new project or module (required)

javaVersion - the Java version for this project or module (required)

parentPom - the Maven coordinates of the parent POM (can be null for none)

module - the name of the module being created (blank for the root or only module)

projectOperations - in case it's required (never null)

Returns:

the path of the newly created POM

createOtherArtifacts

protected void createOtherArtifacts(org.springframework.roo.model.JavaPackage topLevelPackage,
                                    String module,
                                    ProjectOperations projectOperations)

Subclasses can override this method to create any other required files or directories (apart from the POM, which has previously been generated by createPom(org.springframework.roo.model.JavaPackage, java.lang.String, java.lang.String, org.springframework.roo.project.GAV, java.lang.String, org.springframework.roo.project.ProjectOperations)).

This implementation sets up the Log4j configuration file for the root module.

Parameters:

topLevelPackage -

module - the unqualified name of the module being created (empty means the root or only module)

projectOperations - can't be injected as it would create a circular dependency

createPom

protected String createPom(org.springframework.roo.model.JavaPackage topLevelPackage,
                           String projectName,
                           String javaVersion,
                           GAV parentPom,
                           String module,
                           ProjectOperations projectOperations)

Creates the Maven POM using the subclass' POM template as follows:

• sets the parent POM to the given parent (if any)
• sets the groupId to the result of getGroupId(org.springframework.roo.model.JavaPackage), omitting this element if it's the same as the parent's groupId (as per Maven best practice)
• sets the artifactId to the result of getArtifactId(java.lang.String, java.lang.String, org.springframework.roo.model.JavaPackage)
• sets the packaging to the result of #getName()
• sets the project name to the result of getProjectName(java.lang.String, java.lang.String, org.springframework.roo.model.JavaPackage)
• replaces all occurrences of JAVA_PRODUCT_VERSION_PLACEHOLDER with the given Java version

This method makes as few assumptions about the POM template as possible, to make life easier for anyone writing a PackagingProvider.

Parameters:

topLevelPackage - the new project or module's top-level Java package (required)

projectName - the project name provided by the user (can be blank)

javaVersion - the Java version to substitute into the POM (required)

parentPom - the Maven coordinates of the parent POM (can be null)

module - the unqualified name of the Maven module to which the new POM belongs

projectOperations - cannot be injected otherwise it's a circular dependency

Returns:

the path of the newly created POM

getArtifactId

protected String getArtifactId(String nullableProjectName,
                               String module,
                               org.springframework.roo.model.JavaPackage topLevelPackage)

Returns the text to be inserted into the POM's <artifactId> element. This implementation simply delegates to getProjectName(java.lang.String, java.lang.String, org.springframework.roo.model.JavaPackage). Subclasses can override this method to use a different strategy.

Parameters:

nullableProjectName - the project name entered by the user (can be blank)

module - the name of the module being created (blank for the root module)

topLevelPackage - the project or module's top level Java package (required)

Returns:

a non-blank artifactId

getFullyQualifiedModuleName

protected final String getFullyQualifiedModuleName(String moduleName,
                                                   ProjectOperations projectOperations)

Returns the fully-qualified name of the given module, relative to the currently focused module.

Parameters:

moduleName - can be blank for the root or only module

projectOperations -

Returns:

getGroupId

protected String getGroupId(org.springframework.roo.model.JavaPackage topLevelPackage)

Returns the groupId of the project or module being created. This implementation simply uses the fully-qualified name of the given Java package. Subclasses can override this method to use a different strategy.

Parameters:

topLevelPackage - the new project or module's top-level Java package (required)

Returns:

getId

public final String getId()

Description copied from interface: PackagingProvider

Returns the unique identifier of this PackagingProvider, for use in the Roo user interface.

The intent of this method is to allow third-party addons to provide alternative behaviour for a given Maven packaging type. For example, the core Roo WAR packaging type will have an ID of "war". If the user wants to customise how WAR modules are generated, they can implement their own PackagingProvider with an ID of (say) "custom-war". Then when the user adds a new module to their project, the shell will offer them the choice of "WAR" and "CUSTOM-WAR" for the packaging type.

Specified by:

getId in interface PackagingProvider

Returns:

a non-blank ID, unique when case is ignored

getProjectName

protected String getProjectName(String nullableProjectName,
                                String module,
                                org.springframework.roo.model.JavaPackage topLevelPackage)

Returns the text to be inserted into the POM's <name> element. This implementation uses the given project name if not blank, otherwise the last element of the given Java package. Subclasses can override this method to use a different strategy.

Parameters:

nullableProjectName - the project name entered by the user (can be blank)

module - the name of the module being created (blank for the root module)

topLevelPackage - the project or module's top level Java package (required)

Returns:

a blank name if none is required

setGroupIdAndParent

protected void setGroupIdAndParent(String projectGroupId,
                                   GAV parentPom,
                                   Element root,
                                   Document pom)

Sets the Maven groupIds of the parent and/or project as necessary

Parameters:

projectGroupId - the project's groupId (required)

parentPom - the Maven coordinates of the parent POM (can be null)

root - the root element of the POM document (required)

pom - the POM document (required)

setPackagingProviderId

protected void setPackagingProviderId(Document pom)

Stores the ID of this PackagingProvider as a POM property called "roo.packaging.provider". Subclasses can override this method, but be aware that Roo needs some way of working out from a given pom.xml file which PackagingProvider should be used.

Parameters:

pom - the DOM document for the POM being created

getFileManager

public org.springframework.roo.process.manager.FileManager getFileManager()

getPathResolver

public PathResolver getPathResolver()