aem:start

Full name:

com.unic.maven.plugins:aem-maven-plugin:2.0.17-SNAPSHOT:start

Description:

Starts a local AEM instance using a quickstart jar. The quickstart jar must have been provided before hand. Supports setting arbitrary VM parameters in addition to run modes, server port and various AEM settings. The startup AwaitInitialization awaits initialization of the AEM instance, i.e. makes sure that the AEM instance is ready ot use after successful execution of this mojo.

Attributes:

Optional Parameters

Name Type Since Description
<adminPassword> String - The password of the "admin" user.
Default value is: admin.
User property is: password.
<aemType> AemMojo$AemType - The instance type, e.g. "author" or "publish".
Default value is: author.
User property is: aem.type.
<baseUrl> String - The schema + hostname of the AEM instance, e.g. "http://localhost".
Default value is: http://localhost.
User property is: base.url.
<contextPath> String - The context path of the AEM instance.
User property is: context.path.
<debugEnabled> boolean - Whether remote debugging shall be available for the started instance via the configured port.
Default value is: true.
User property is: debug.enabled.
<debugPort> int - Use this debug port for remote debugging on the instance.
Default value is: 30303.
User property is: debug.port.
<followStdOutAndErrBeyondMojoExecution> boolean - Whether to keep following stderr and stdout of the started AEM instance beyond the execution of the startup mojo. If true, adds a shutdown hook to the JVM that will stop stderr and stdout monitoring when the JVM exits.
Default value is: true.
User property is: startup.keepFollowingStdErrAndOut.
<heapSize> String - Use this amount of heap. Example: 2048M.
Default value is: 2048M.
User property is: heap.size.
<httpPort> int - The AEM HTTP port. Defaults to 4502 for an author and 4503 for a publish AEM type.
Default value is: -1.
User property is: http.port.
<ignoreBundlesRegex> String[] - Ignores the defined bundles during initialization check by given regex checks. The regex is checked against the bundle's symbolic name.
User property is: ignore.bundlesRegex.
<initializationGracePeriod> int - Wait this amount of seconds before beginning state tests on the components.
Default value is: 5.
User property is: init.gracePeriod.
<initializationWaitTime> int - Wait up to this number of minutes for AEM to initialize, i.e. for all bundles and components to start.
Default value is: 2.
User property is: init.waitTime.
<javaHome> String - Use this JRE to start the AEM instance.
Default value is: ${java.home}.
User property is: java.home.
<runModes> String[] - The run modes for this instance, in addition to getAemType().
User property is: run.modes.
<silentStartup> boolean - Reduce console output to the minimum. For instance, the stdout and stderr messages by AEM will not be shown, unless the startup fails, in which event the recorded stdout / stderr output of the AEM process will be printed.
Default value is: false.
User property is: startup.silent.
<startupVmOptions> String[] - Use this for adding custom vmOptions to the AEM startup, e.g. agents for code analysis. Example: 
<configuration>
  <startupVmOptions>
    <vmOption>-Xms512m</vmOption>
    <vmOption>${failsafeArgLine}</vmOption>
  </aemStartupVmOptions>
</configuration>

User property is: startup.vmOptions.
<startupWaitTime> int - Wait up to this number of minutes for AEM to start
Default value is: 2.
User property is: startup.waitTime.
<useControlPort> boolean - If true the AEM Control Port feature is enabled and used for stopping the instance. If false the system console HTTP API is used to stop the AEM instance.
Default value is: true.
User property is: use.controlport.

Parameter Details

<adminPassword>

The password of the "admin" user.
  • Type: java.lang.String
  • Required: No
  • User Property: password
  • Default: admin

<aemType>

The instance type, e.g. "author" or "publish".
  • Type: com.unic.maven.plugins.aem.mojos.AemMojo$AemType
  • Required: No
  • User Property: aem.type
  • Default: author

<baseUrl>

The schema + hostname of the AEM instance, e.g. "http://localhost".
  • Type: java.lang.String
  • Required: No
  • User Property: base.url
  • Default: http://localhost

<contextPath>

The context path of the AEM instance.
  • Type: java.lang.String
  • Required: No
  • User Property: context.path

<debugEnabled>

Whether remote debugging shall be available for the started instance via the configured port.
  • Type: boolean
  • Required: No
  • User Property: debug.enabled
  • Default: true

<debugPort>

Use this debug port for remote debugging on the instance.
  • Type: int
  • Required: No
  • User Property: debug.port
  • Default: 30303

<followStdOutAndErrBeyondMojoExecution>

Whether to keep following stderr and stdout of the started AEM instance beyond the execution of the startup mojo. If true, adds a shutdown hook to the JVM that will stop stderr and stdout monitoring when the JVM exits.
  • Type: boolean
  • Required: No
  • User Property: startup.keepFollowingStdErrAndOut
  • Default: true

<heapSize>

Use this amount of heap. Example: 2048M.
  • Type: java.lang.String
  • Required: No
  • User Property: heap.size
  • Default: 2048M

<httpPort>

The AEM HTTP port. Defaults to 4502 for an author and 4503 for a publish AEM type.
  • Type: int
  • Required: No
  • User Property: http.port
  • Default: -1

<ignoreBundlesRegex>

Ignores the defined bundles during initialization check by given regex checks. The regex is checked against the bundle's symbolic name.
  • Type: java.lang.String[]
  • Required: No
  • User Property: ignore.bundlesRegex

<initializationGracePeriod>

Wait this amount of seconds before beginning state tests on the components.
  • Type: int
  • Required: No
  • User Property: init.gracePeriod
  • Default: 5

<initializationWaitTime>

Wait up to this number of minutes for AEM to initialize, i.e. for all bundles and components to start.
  • Type: int
  • Required: No
  • User Property: init.waitTime
  • Default: 2

<javaHome>

Use this JRE to start the AEM instance.
  • Type: java.lang.String
  • Required: No
  • User Property: java.home
  • Default: ${java.home}

<runModes>

The run modes for this instance, in addition to getAemType().
  • Type: java.lang.String[]
  • Required: No
  • User Property: run.modes

<silentStartup>

Reduce console output to the minimum. For instance, the stdout and stderr messages by AEM will not be shown, unless the startup fails, in which event the recorded stdout / stderr output of the AEM process will be printed.
  • Type: boolean
  • Required: No
  • User Property: startup.silent
  • Default: false

<startupVmOptions>

Use this for adding custom vmOptions to the AEM startup, e.g. agents for code analysis. Example: 
<configuration>
  <startupVmOptions>
    <vmOption>-Xms512m</vmOption>
    <vmOption>${failsafeArgLine}</vmOption>
  </aemStartupVmOptions>
</configuration>
  • Type: java.lang.String[]
  • Required: No
  • User Property: startup.vmOptions

<startupWaitTime>

Wait up to this number of minutes for AEM to start
  • Type: int
  • Required: No
  • User Property: startup.waitTime
  • Default: 2

<useControlPort>

If true the AEM Control Port feature is enabled and used for stopping the instance. If false the system console HTTP API is used to stop the AEM instance.
  • Type: boolean
  • Required: No
  • User Property: use.controlport
  • Default: true