AbstractRunMojo (Alfresco Maven Plugin 3.1.0 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.alfresco.maven.plugin.AbstractRunMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

BuildWarsMojo, IntegrationTestMojo, RunMojo
```
public abstract class AbstractRunMojo
extends org.apache.maven.plugin.AbstractMojo
```
Abstract runner component used by both the standard runner that blocks after startup and the integration test runner that stops container after each sub-project execution.

Since:

3.0

Version:

1.0

Author:

ole.hejlskov, martin.bergljung

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTIVITI_APP_WAR_PREFIX_NAME`
`protected String`	`activitiAdminWarArtifactId` Deprecated as of SDK 3.1
`protected String`	`activitiAppWarArtifactId` Deprecated as of SDK 3.1
`protected String`	`activitiGroupId` Deprecated as of SDK 3.1
`protected List<ModuleDependency>`	`activitiModules` Deprecated as of SDK 3.1 JARs that should be overlayed/applied to the Activiti App WAR (i.e.
`protected String`	`activitiVersion` Deprecated as of SDK 3.1
`static String`	`ALFRESCO_COMMUNITY_EDITION`
`static String`	`ALFRESCO_ENTERPRISE_EDITION`
`protected String`	`alfrescoApiExplorerArtifactId`
`protected String`	`alfrescoApiExplorerVersion`
`protected String`	`alfrescoEdition` Community Edition or Enterprise Edition? (i.e community or enterprise)
`protected String`	`alfrescoGroupId` Maven GAV properties for standard Alfresco web applications.
`protected String`	`alfrescoPlatformVersion`
`protected String`	`alfrescoPlatformWarArtifactId`
`protected String`	`alfrescoShareVersion`
`protected String`	`alfrescoShareWarArtifactId`
`protected String`	`alfrescoSolrArtifactId`
`protected boolean`	`copyHotswapAgentConfig` Enable or disable generation of Hotswap Agent configuration
`protected boolean`	`enableActivitiAdmin` Deprecated as of SDK 3.1 Switch to enable/disable Alfresco Activiti Admin (activiti-admin.war) when running embedded Tomcat.
`protected boolean`	`enableActivitiApp` Deprecated as of SDK 3.1 Switch to enable/disable Alfresco Activiti Workflow Engine (activiti-app.war) when running embedded Tomcat.
`protected boolean`	`enableApiExplorer` Switch to enable/disable the Alfresco REST API Explorer (api-explorer.war) when running embedded Tomcat.
`protected boolean`	`enableEnterpriseDb` Switch to enable/disable the Enterprise database (such as Oracle or MS SQL Server) when running embedded Tomcat.
`protected boolean`	`enableH2` Switch to enable/disable the H2 database when running embedded Tomcat.
`protected boolean`	`enableMySQL` Switch to enable/disable the MySQL database when running embedded Tomcat.
`protected boolean`	`enablePlatform` Switch to enable/disable the Platform/Repository (alfresco.war) when running embedded Tomcat.
`protected boolean`	`enablePostgreSQL` Switch to enable/disable the PostgreSQL database when running embedded Tomcat.
`protected boolean`	`enableShare` Switch to enable/disable the Share (share.war) when running embedded Tomcat.
`protected boolean`	`enableSolr` Switch to enable/disable the Apache Solr 4 web application when running embedded Tomcat.
`protected boolean`	`enableTestProperties` Switch to enable/disable test properties when running embedded Tomcat.
`protected org.twdata.maven.mojoexecutor.MojoExecutor.ExecutionEnvironment`	`execEnv` The Maven environment that this mojo is executed in
`static String`	`MAVEN_BUILD_HELPER_PLUGIN_VERSION`
`static String`	`MAVEN_DEPENDENCY_PLUGIN_VERSION`
`static String`	`MAVEN_INSTALL_PLUGIN_VERSION`
`static String`	`MAVEN_REPLACER_PLUGIN_VERSION`
`static String`	`MAVEN_RESOURCE_PLUGIN_VERSION`
`protected String`	`mavenTomcatPort` Legacy to be compatible with maven.tomcat.port
`static String`	`PLATFORM_WAR_PREFIX_NAME`
`protected String`	`platformCustomContextFile` Location of a custom context file to use in the deployment of the platform war in Tomcat.
`protected List<ModuleDependency>`	`platformModules` JARs and AMPs that should be overlayed/applied to the Platform/Repository WAR (i.e.
`protected org.apache.maven.plugin.BuildPluginManager`	`pluginManager`
`protected org.apache.maven.project.MavenProject`	`project`
`protected List<org.apache.maven.project.MavenProject>`	`reactorProjects`
`protected org.apache.maven.execution.MavenSession`	`session`
`static String`	`SHARE_WAR_PREFIX_NAME`
`protected String`	`shareContextPath` Enables the use of custom context path for the Share webapp.
`protected List<ModuleDependency>`	`shareModules` JARs and AMPs that should be overlayed/applied to the Share WAR (i.e.
`protected String`	`solrCron` Solr indexation frequency.
`protected String`	`solrHome` Directory that contains the Alfresco Solr 4 configuration
`protected boolean`	`startTomcat` Control if Tomcat 7 Plugin should be kicked off and start Apache Tomcat
`protected String`	`testFolder` Directory containing test files that should be used when running embedded Tomcat
`protected String`	`testInclude` Test files in testFolder that should be included when running embedded Tomcat
`protected List<TomcatWebapp>`	`tomcatCustomWebapps` Custom webapps that should be deployed to the embedded Tomcat engine.
`protected List<TomcatDependency>`	`tomcatDependencies` Tomcat Dependencies that should be added to the Embedded Tomcat configuration before start.
`protected String`	`tomcatMavenPluginVersion` Tomcat Maven Plugin version to be used when running the project.
`protected String`	`tomcatPort` Port to run Tomcat on
`protected Map<String,String>`	`tomcatSystemProperties` System Properties to feed the Tomcat plugin before start.
`protected String`	`tomcatVersion` Tomcat version to be used in the Maven Tomcat Plugin.
`protected boolean`	`useCustomShareLog4jConfig` Share Log4j.properties configuration cannot be customized via extension put on the classpath, like on the platform side.

Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE

Constructor Summary

Constructors
Constructor and Description

AbstractRunMojo()

Constructors
Constructor and Description
`AbstractRunMojo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`buildActivitiAppWar()` Build the customized Activiti App webapp (i.e.
`protected void`	`buildCustomWarInDir(String warName, List<ModuleDependency> modules, String originalWarGroupId, String originalWarArtifactId, String originalWarVersion)` Build a customized webapp in a directory, applying a number of AMPs and/or JARs from alfresco maven plugin configuration.
`protected void`	`buildPlatformWar()` Build the customized Platform webapp (i.e.
`protected void`	`buildShareWar()` Build the customized Share webapp (i.e.
`protected void`	`checkDatabaseConfig()` Check that a database configuration has been supplied correctly
`protected void`	`commentOutSecureCommsInPlatformWebXml()` Replaces web.xml where applicable in platform webapp (alfresco.war), commenting out the security-constraints.
`protected void`	`copyActivitiLog4JDevConfig()` Copy the Activiti Log4J Dev config into the activitiApp-war/WEB-INF/classes dir.
`protected void`	`copyAlfrescoGlobalProperties()` Copy the different alfresco-global-*.properties files (there are one for each open source db and one for enterprise db config) that will be used when running Alfresco.
`protected void`	`copyAlfrescoLicense()` Copy the Alfresco Enterprise license to its correct place in the Platform WAR, if it exists.
`protected void`	`copyHotswapAgentProperties(String warPrefix)` Copy and Build hotswap-agent.properties
`protected void`	`copyShareConfigCustom()` Copy Share Config Custom in order to have global overrides for development and dynamic port
`protected void`	`copyShareLog4jConfig()` Copy a custom Share Log4J config into the share-war/WEB-INF/classes dir.
`protected void`	`copySolrCustomConfig()` Copy custom solr configuration files over, so a developer can overwrite any files needed
`protected void`	`fixSolrHomePath()` For windows paths, convert single \ to / for the ${alfresco.solr.data.dir} path, by default it will be c:\bla\, we need forward slash or double backslash.
`protected String`	`getPort()` Get the Tomcat port.
`protected void`	`installSolr10InLocalRepo()` If we are in Alfresco version 4.2 or younger the Solr 1.0 WAR is not available as Maven artifact, just as part of a ZIP file, so install it locally so we can deploy from embedded tomcat
`protected String`	`packageAndInstallCustomWar(String warName)` Package customized war file and install it in local maven repo.
`protected void`	`renameAlfrescoGlobalProperties()` Rename the configured database specific alfresco-global-*.properties file to alfresco-global.properties so it will be used during Tomcat run.
`protected void`	`replaceSolrConfigProperties()` Replace property placeholders in configuration files for the cores, so the index files can be found for each core when Solr starts up.
`protected void`	`startTomcat(boolean fork)` Start up the embedded Tomcat server with the webapps that has been configured in the SDK project.
`protected boolean`	`tomcatIsRunning()` Check if Tomcat is already running.
`protected void`	`unpackSolrConfig()` Download and unpack the Solr 4 configuration as we don't have it in the project.

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.Mojo
execute

- Field Detail
  - MAVEN_DEPENDENCY_PLUGIN_VERSION
```
public static final String MAVEN_DEPENDENCY_PLUGIN_VERSION
```
    See Also:
    
    Constant Field Values
  - MAVEN_INSTALL_PLUGIN_VERSION
```
public static final String MAVEN_INSTALL_PLUGIN_VERSION
```
    See Also:
    
    Constant Field Values
  - MAVEN_REPLACER_PLUGIN_VERSION
```
public static final String MAVEN_REPLACER_PLUGIN_VERSION
```
    See Also:
    
    Constant Field Values
  - MAVEN_RESOURCE_PLUGIN_VERSION
```
public static final String MAVEN_RESOURCE_PLUGIN_VERSION
```
    See Also:
    
    Constant Field Values
  - MAVEN_BUILD_HELPER_PLUGIN_VERSION
```
public static final String MAVEN_BUILD_HELPER_PLUGIN_VERSION
```
    See Also:
    
    Constant Field Values
  - PLATFORM_WAR_PREFIX_NAME
```
public static final String PLATFORM_WAR_PREFIX_NAME
```
    See Also:
    
    Constant Field Values
  - SHARE_WAR_PREFIX_NAME
```
public static final String SHARE_WAR_PREFIX_NAME
```
    See Also:
    
    Constant Field Values
  - ACTIVITI_APP_WAR_PREFIX_NAME
```
public static final String ACTIVITI_APP_WAR_PREFIX_NAME
```
    See Also:
    
    Constant Field Values
  - ALFRESCO_ENTERPRISE_EDITION
```
public static final String ALFRESCO_ENTERPRISE_EDITION
```
    See Also:
    
    Constant Field Values
  - ALFRESCO_COMMUNITY_EDITION
```
public static final String ALFRESCO_COMMUNITY_EDITION
```
    See Also:
    
    Constant Field Values
  - project
```
@Component
protected org.apache.maven.project.MavenProject project
```
  - session
```
@Component
protected org.apache.maven.execution.MavenSession session
```
  - pluginManager
```
@Component
protected org.apache.maven.plugin.BuildPluginManager pluginManager
```
  - reactorProjects
```
@Parameter(property="reactorProjects",
           required=true,
           readonly=true)
protected List<org.apache.maven.project.MavenProject> reactorProjects
```
  - enableSolr
```
@Parameter(property="maven.alfresco.enableSolr",
           defaultValue="true")
protected boolean enableSolr
```
    Switch to enable/disable the Apache Solr 4 web application when running embedded Tomcat.
  - enableH2
```
@Parameter(property="maven.alfresco.enableH2",
           defaultValue="false")
protected boolean enableH2
```
    Switch to enable/disable the H2 database when running embedded Tomcat. This also brings in the needed H2 database scripts.
  - enableMySQL
```
@Parameter(property="maven.alfresco.enableMySQL",
           defaultValue="false")
protected boolean enableMySQL
```
    Switch to enable/disable the MySQL database when running embedded Tomcat.
  - enablePostgreSQL
```
@Parameter(property="maven.alfresco.enablePostgreSQL",
           defaultValue="false")
protected boolean enablePostgreSQL
```
    Switch to enable/disable the PostgreSQL database when running embedded Tomcat.
  - enableEnterpriseDb
```
@Parameter(property="maven.alfresco.enableEnterpriseDb",
           defaultValue="false")
protected boolean enableEnterpriseDb
```
    Switch to enable/disable the Enterprise database (such as Oracle or MS SQL Server) when running embedded Tomcat.
  - enablePlatform
```
@Parameter(property="maven.alfresco.enablePlatform",
           defaultValue="true")
protected boolean enablePlatform
```
    Switch to enable/disable the Platform/Repository (alfresco.war) when running embedded Tomcat.
  - copyHotswapAgentConfig
```
@Parameter(property="maven.alfresco.copyHotswapAgentConfig",
           defaultValue="true")
protected boolean copyHotswapAgentConfig
```
    Enable or disable generation of Hotswap Agent configuration
  - enableShare
```
@Parameter(property="maven.alfresco.enableShare",
           defaultValue="true")
protected boolean enableShare
```
    Switch to enable/disable the Share (share.war) when running embedded Tomcat.
  - shareContextPath
```
@Parameter(property="maven.alfresco.shareContextPath",
           defaultValue="/share")
protected String shareContextPath
```
    Enables the use of custom context path for the Share webapp. Some solution integrators uses a custom context path for Share in their projects. This property enables them to continue to do that in SDK 3 without having to completely override the Maven Tomcat plugin configuration, or not use it at all and go back the good old runner project again...
  - useCustomShareLog4jConfig
```
@Parameter(property="maven.alfresco.useCustomShareLog4jConfig",
           defaultValue="true")
protected boolean useCustomShareLog4jConfig
```
    Share Log4j.properties configuration cannot be customized via extension put on the classpath, like on the platform side. So we need to override the log4j.properties in share/WEB-INF/classes to be able to log from custom code. This property can be used to turn off this overriding, to produce a WAR with the standard Share log4j.properties file.
  - enableApiExplorer
```
@Parameter(property="maven.alfresco.enableApiExplorer",
           defaultValue="false")
protected boolean enableApiExplorer
```
    Switch to enable/disable the Alfresco REST API Explorer (api-explorer.war) when running embedded Tomcat.
  - enableActivitiApp
```
@Parameter(property="maven.alfresco.enableActivitiApp",
           defaultValue="false")
protected boolean enableActivitiApp
```
    Deprecated as of SDK 3.1 Switch to enable/disable Alfresco Activiti Workflow Engine (activiti-app.war) when running embedded Tomcat. This contains the Alfresco Activiti webapp, including the workflow engine. This webapp is also the user interface for people involved in the task and processes running in the Activiti engine. You also use this webapp to create and manage process definitions, and to display and define analytics reports on users' tasks and processes.
  - enableActivitiAdmin
```
@Parameter(property="maven.alfresco.enableActivitiAdmin",
           defaultValue="false")
protected boolean enableActivitiAdmin
```
    Deprecated as of SDK 3.1 Switch to enable/disable Alfresco Activiti Admin (activiti-admin.war) when running embedded Tomcat. This contains the Alfresco Activiti Administrator webapp. You use this to administer and monitor your Alfresco Activiti engines.
  - enableTestProperties
```
@Parameter(property="maven.alfresco.enableTestProperties",
           defaultValue="true")
protected boolean enableTestProperties
```
    Switch to enable/disable test properties when running embedded Tomcat.
  - startTomcat
```
@Parameter(property="maven.alfresco.startTomcat",
           defaultValue="true")
protected boolean startTomcat
```
    Control if Tomcat 7 Plugin should be kicked off and start Apache Tomcat
  - testFolder
```
@Parameter(property="maven.alfresco.testFolder",
           defaultValue="src/test/properties/${env}")
protected String testFolder
```
    Directory containing test files that should be used when running embedded Tomcat
  - testInclude
```
@Parameter(property="maven.alfresco.testInclude",
           defaultValue="**")
protected String testInclude
```
    Test files in testFolder that should be included when running embedded Tomcat
  - platformModules
```
@Parameter(property="maven.alfresco.platform.modules",
           defaultValue="")
protected List<ModuleDependency> platformModules
```
    JARs and AMPs that should be overlayed/applied to the Platform/Repository WAR (i.e. alfresco.war)
  - shareModules
```
@Parameter(property="maven.alfresco.share.modules",
           defaultValue="")
protected List<ModuleDependency> shareModules
```
    JARs and AMPs that should be overlayed/applied to the Share WAR (i.e. share.war)
  - activitiModules
```
@Parameter(property="maven.activiti.modules",
           defaultValue="")
protected List<ModuleDependency> activitiModules
```
    Deprecated as of SDK 3.1 JARs that should be overlayed/applied to the Activiti App WAR (i.e. activiti-app.war)
  - alfrescoEdition
```
@Parameter(property="maven.alfresco.edition",
           defaultValue="community")
protected String alfrescoEdition
```
    Community Edition or Enterprise Edition? (i.e community or enterprise)
  - tomcatDependencies
```
@Parameter(property="maven.alfresco.tomcat.dependencies",
           defaultValue="")
protected List<TomcatDependency> tomcatDependencies
```
    Tomcat Dependencies that should be added to the Embedded Tomcat configuration before start. Normally there would not be any extra dependencies, but could be if you run an Enterprise database such as Oracle, for which there's no quick config, such as enableH2, enableMySQL, or enablePostgreSQL.
  - tomcatSystemProperties
```
@Parameter(property="maven.alfresco.tomcat.system.properties",
           defaultValue="")
protected Map<String,String> tomcatSystemProperties
```
    System Properties to feed the Tomcat plugin before start. Normally there would not be any extra dependencies, but we could run a custom webapp that needed a custom sys prop set.
  - tomcatCustomWebapps
```
@Parameter(property="maven.alfresco.tomcat.custom.webapps",
           defaultValue="")
protected List<TomcatWebapp> tomcatCustomWebapps
```
    Custom webapps that should be deployed to the embedded Tomcat engine. Normally there would not be any extra webapps, but we could run a bigger project that uses some custom webapp.
  - tomcatPort
```
@Parameter(property="maven.alfresco.tomcat.port",
           defaultValue="8080")
protected String tomcatPort
```
    Port to run Tomcat on
  - mavenTomcatPort
```
@Parameter(property="maven.tomcat.port",
           defaultValue="")
protected String mavenTomcatPort
```
    Legacy to be compatible with maven.tomcat.port
  - alfrescoGroupId
```
@Parameter(property="alfresco.groupId",
           defaultValue="org.alfresco")
protected String alfrescoGroupId
```
    Maven GAV properties for standard Alfresco web applications.
  - activitiGroupId
```
@Parameter(property="activiti.groupId",
           defaultValue="com.activiti")
protected String activitiGroupId
```
    Deprecated as of SDK 3.1
  - alfrescoPlatformWarArtifactId
```
@Parameter(property="alfresco.platform.war.artifactId",
           defaultValue="alfresco-platform")
protected String alfrescoPlatformWarArtifactId
```
  - alfrescoShareWarArtifactId
```
@Parameter(property="alfresco.share.war.artifactId",
           defaultValue="share")
protected String alfrescoShareWarArtifactId
```
  - alfrescoSolrArtifactId
```
@Parameter(property="alfresco.solr.artifactId",
           defaultValue="alfresco-solr4")
protected String alfrescoSolrArtifactId
```
  - alfrescoApiExplorerArtifactId
```
@Parameter(property="alfresco.api.explorer.artifactId",
           defaultValue="api-explorer")
protected String alfrescoApiExplorerArtifactId
```
  - activitiAppWarArtifactId
```
@Parameter(property="activiti.app.war.artifactId",
           defaultValue="activiti-app")
protected String activitiAppWarArtifactId
```
    Deprecated as of SDK 3.1
  - activitiAdminWarArtifactId
```
@Parameter(property="activiti.admin.war.artifactId",
           defaultValue="activiti-admin")
protected String activitiAdminWarArtifactId
```
    Deprecated as of SDK 3.1
  - alfrescoPlatformVersion
```
@Parameter(property="alfresco.platform.version",
           defaultValue="5.2.f")
protected String alfrescoPlatformVersion
```
  - alfrescoShareVersion
```
@Parameter(property="alfresco.share.version",
           defaultValue="5.2.e")
protected String alfrescoShareVersion
```
  - alfrescoApiExplorerVersion
```
@Parameter(property="alfresco.api.explorer.version",
           defaultValue="5.2.e")
protected String alfrescoApiExplorerVersion
```
  - activitiVersion
```
@Parameter(property="activiti.version",
           defaultValue="1.5.3")
protected String activitiVersion
```
    Deprecated as of SDK 3.1
  - solrHome
```
@Parameter(property="solr.home",
           defaultValue="${project.basedir}/${alfresco.data.location}/solr")
protected String solrHome
```
    Directory that contains the Alfresco Solr 4 configuration
  - solrCron
```
@Parameter(property="solr.alfresco.cron",
           defaultValue="0/15 * * * * ? *")
protected String solrCron
```
    Solr indexation frequency. It is customizable to speed up integration tests execution.
  - tomcatVersion
```
@Parameter(property="maven.alfresco.tomcat.version")
protected String tomcatVersion
```
    Tomcat version to be used in the Maven Tomcat Plugin. If this parameter is not set, then the default Tomcat version will be used (it depends on the version of the Tomcat Maven Plugin).
  - tomcatMavenPluginVersion
```
@Parameter(property="maven.alfresco.tomcat.maven.plugin.version",
           defaultValue="2.2")
protected String tomcatMavenPluginVersion
```
    Tomcat Maven Plugin version to be used when running the project. If this parameter is not set, then the default Tomcat Maven Plugin version will be used (2.2).
  - platformCustomContextFile
```
@Parameter(property="maven.alfresco.platform.custom.context.file")
protected String platformCustomContextFile
```
    Location of a custom context file to use in the deployment of the platform war in Tomcat.
  - execEnv
```
protected org.twdata.maven.mojoexecutor.MojoExecutor.ExecutionEnvironment execEnv
```
    The Maven environment that this mojo is executed in
- Constructor Detail
  - AbstractRunMojo
```
public AbstractRunMojo()
```
- Method Detail
  - getPort
```
protected String getPort()
```
    Get the Tomcat port. By default the port is changed by using the maven.alfresco.tomcat.port property but for legacy and external configuration purposes maven.tomcat.port will override if defined
    
    Returns:
    
    the Tomcat port
  - tomcatIsRunning
```
protected boolean tomcatIsRunning()
```
    Check if Tomcat is already running.
    
    Returns:
    
    true if Tomcat is already running, false otherwise
  - unpackSolrConfig
```
protected void unpackSolrConfig()
                         throws org.apache.maven.plugin.MojoExecutionException
```
    Download and unpack the Solr 4 configuration as we don't have it in the project. It will reside under /alf_data_dev/solr
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears unpacking the Solr configuration
  - fixSolrHomePath
```
protected void fixSolrHomePath()
                        throws org.apache.maven.plugin.MojoExecutionException
```
    For windows paths, convert single \ to / for the ${alfresco.solr.data.dir} path, by default it will be c:\bla\, we need forward slash or double backslash.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears fixing the Solr home path
  - copySolrCustomConfig
```
protected void copySolrCustomConfig()
                             throws org.apache.maven.plugin.MojoExecutionException
```
    Copy custom solr configuration files over, so a developer can overwrite any files needed
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears copying the Solr custom configuration
  - replaceSolrConfigProperties
```
protected void replaceSolrConfigProperties()
                                    throws org.apache.maven.plugin.MojoExecutionException
```
    Replace property placeholders in configuration files for the cores, so the index files can be found for each core when Solr starts up.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears replacing the Solr configuration properties
  - installSolr10InLocalRepo
```
protected void installSolr10InLocalRepo()
                                 throws org.apache.maven.plugin.MojoExecutionException
```
    If we are in Alfresco version 4.2 or younger the Solr 1.0 WAR is not available as Maven artifact, just as part of a ZIP file, so install it locally so we can deploy from embedded tomcat
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears installing Solr10 in the local repository
  - commentOutSecureCommsInPlatformWebXml
```
protected void commentOutSecureCommsInPlatformWebXml()
                                              throws org.apache.maven.plugin.MojoExecutionException
```
    Replaces web.xml where applicable in platform webapp (alfresco.war), commenting out the security-constraints.
    This is only needed for 4.2, 5.0 (5.1 handles it automatically when turning off ssl via props)
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears commenting out the security configuration
  - copyAlfrescoGlobalProperties
```
protected void copyAlfrescoGlobalProperties()
                                     throws org.apache.maven.plugin.MojoExecutionException
```
    Copy the different alfresco-global-*.properties files (there are one for each open source db and one for enterprise db config) that will be used when running Alfresco. It contains database connection parameters and other general configuration for Alfresco Repository (alfresco.war)
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears copying the Alfresco global properties file
  - renameAlfrescoGlobalProperties
```
protected void renameAlfrescoGlobalProperties()
                                       throws org.apache.maven.plugin.MojoExecutionException
```
    Rename the configured database specific alfresco-global-*.properties file to alfresco-global.properties so it will be used during Tomcat run.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears renaming the alfresco global properties
  - copyAlfrescoLicense
```
protected void copyAlfrescoLicense()
                            throws org.apache.maven.plugin.MojoExecutionException
```
    Copy the Alfresco Enterprise license to its correct place in the Platform WAR, if it exists. It is not enough to have it on the test classpath, then it will start up as Trial license...
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears copying the Alfresco license
  - copyActivitiLog4JDevConfig
```
protected void copyActivitiLog4JDevConfig()
                                   throws org.apache.maven.plugin.MojoExecutionException
```
    Copy the Activiti Log4J Dev config into the activitiApp-war/WEB-INF/classes dir.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears copying the activity Log4J dev configuration
  - copyShareConfigCustom
```
protected void copyShareConfigCustom()
                              throws org.apache.maven.plugin.MojoExecutionException
```
    Copy Share Config Custom in order to have global overrides for development and dynamic port
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears copying share config custom file
  - copyShareLog4jConfig
```
protected void copyShareLog4jConfig()
                             throws org.apache.maven.plugin.MojoExecutionException
```
    Copy a custom Share Log4J config into the share-war/WEB-INF/classes dir. There is no custom classpath resolve mechanism for Share log4j, to log custom stuff overriding standard log4j.properties is needed.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears copying the share log4j configuration
  - copyHotswapAgentProperties
```
protected void copyHotswapAgentProperties(String warPrefix)
                                   throws org.apache.maven.plugin.MojoExecutionException
```
    Copy and Build hotswap-agent.properties
    
    Parameters:
    
    warPrefix - path to the war root directory
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears copying hotswap agent properties
  - buildPlatformWar
```
protected void buildPlatformWar()
                         throws org.apache.maven.plugin.MojoExecutionException
```
    Build the customized Platform webapp (i.e. the Repository, alfresco.war) that should be deployed by Tomcat by applying all AMPs and JARs from the <platformModules> configuration.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears building the platform war
  - buildShareWar
```
protected void buildShareWar()
                      throws org.apache.maven.plugin.MojoExecutionException
```
    Build the customized Share webapp (i.e. the share.war) that should be deployed by Tomcat by applying all AMPs and JARs from the <shareModules> configuration.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears building the share war
  - buildActivitiAppWar
```
protected void buildActivitiAppWar()
                            throws org.apache.maven.plugin.MojoExecutionException
```
    Build the customized Activiti App webapp (i.e. the activiti-app.war) that should be deployed by Tomcat by applying all JARs from the <activitiModules> configuration.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears building the activity war
  - buildCustomWarInDir
```
protected void buildCustomWarInDir(String warName,
                                   List<ModuleDependency> modules,
                                   String originalWarGroupId,
                                   String originalWarArtifactId,
                                   String originalWarVersion)
                            throws org.apache.maven.plugin.MojoExecutionException
```
    Build a customized webapp in a directory, applying a number of AMPs and/or JARs from alfresco maven plugin configuration.
    
    Parameters:
    
    warName - the name of the custom war
    
    modules - the modules that should be applied to the custom war
    
    originalWarGroupId - the Maven groupId for the original war file that should be customized
    
    originalWarArtifactId - the Maven artifactId for the original war file that should be customized
    
    originalWarVersion - the Maven version for the original war file that should be customized
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears building the custom war
  - packageAndInstallCustomWar
```
protected String packageAndInstallCustomWar(String warName)
                                     throws org.apache.maven.plugin.MojoExecutionException
```
    Package customized war file and install it in local maven repo.
    
    Parameters:
    
    warName - the name of the custom war
    
    Returns:
    
    the customized war file artifactId, to be used by the tomcat7 plugin
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears packaging or installing the custom war
  - checkDatabaseConfig
```
protected void checkDatabaseConfig()
                            throws org.apache.maven.plugin.MojoExecutionException
```
    Check that a database configuration has been supplied correctly
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears checking the database configuration
  - startTomcat
```
protected void startTomcat(boolean fork)
                    throws org.apache.maven.plugin.MojoExecutionException
```
    Start up the embedded Tomcat server with the webapps that has been configured in the SDK project.
    
    Parameters:
    
    fork - true if tomcat process should be forked
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - when any problem appears starting tomcat

Class AbstractRunMojo

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.maven.plugin.Mojo

Field Detail

MAVEN_DEPENDENCY_PLUGIN_VERSION

MAVEN_INSTALL_PLUGIN_VERSION

MAVEN_REPLACER_PLUGIN_VERSION

MAVEN_RESOURCE_PLUGIN_VERSION

MAVEN_BUILD_HELPER_PLUGIN_VERSION

PLATFORM_WAR_PREFIX_NAME

SHARE_WAR_PREFIX_NAME

ACTIVITI_APP_WAR_PREFIX_NAME

ALFRESCO_ENTERPRISE_EDITION

ALFRESCO_COMMUNITY_EDITION

project

session

pluginManager

reactorProjects

enableSolr

enableH2

enableMySQL

enablePostgreSQL

enableEnterpriseDb

enablePlatform

copyHotswapAgentConfig

enableShare

shareContextPath

useCustomShareLog4jConfig

enableApiExplorer

enableActivitiApp

enableActivitiAdmin

enableTestProperties

startTomcat

testFolder

testInclude

platformModules

shareModules

activitiModules

alfrescoEdition

tomcatDependencies

tomcatSystemProperties

tomcatCustomWebapps

tomcatPort

mavenTomcatPort

alfrescoGroupId

activitiGroupId

alfrescoPlatformWarArtifactId

alfrescoShareWarArtifactId

alfrescoSolrArtifactId

alfrescoApiExplorerArtifactId

activitiAppWarArtifactId

activitiAdminWarArtifactId

alfrescoPlatformVersion

alfrescoShareVersion

alfrescoApiExplorerVersion

activitiVersion

solrHome

solrCron

tomcatVersion

tomcatMavenPluginVersion

platformCustomContextFile

execEnv

Constructor Detail

AbstractRunMojo

Method Detail

getPort

tomcatIsRunning

unpackSolrConfig

fixSolrHomePath

copySolrCustomConfig

replaceSolrConfigProperties

installSolr10InLocalRepo

commentOutSecureCommsInPlatformWebXml

copyAlfrescoGlobalProperties

renameAlfrescoGlobalProperties