aem:stop

Full name:

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

Description:

Stops running AEM instances conflicting with the current AEM instance. Running AEM instances can be shut down gracefully if they were started in the same module the stop task is executed in, provided their installation directory still exists.
Otherwise, conflicting AEM processes - i.e. AEM processes started by the same system user this mojo was started with running on either the same HTTP port or debug port - are terminated (killed). This is since orphaned AEM instances in arbitrary state may have be left over by abnormally terminated previous builds.

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.
<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.
<javaHome> String - Use this JRE to start the AEM instance.
Default value is: ${java.home}.
User property is: java.home.
<killGracePeriod> int - After terminating an AEM process, wait for this amount of seconds to make sure that process resources - such as files or network ports - are freed.
Default value is: 5.
User property is: kill.gracePeriod.
<shutdownGracePeriod> int - After terminating an AEM process, wait for this amount of seconds to make sure that process resources - such as files or network ports - are freed.
Default value is: 5.
User property is: shutdown.gracePeriod.
<shutdownWaitTime> int - Wait up to this number of minutes for AEM to stop
Default value is: 2.
User property is: shutdown.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

<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

<javaHome>

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

<killGracePeriod>

After terminating an AEM process, wait for this amount of seconds to make sure that process resources - such as files or network ports - are freed.
  • Type: int
  • Required: No
  • User Property: kill.gracePeriod
  • Default: 5

<shutdownGracePeriod>

After terminating an AEM process, wait for this amount of seconds to make sure that process resources - such as files or network ports - are freed.
  • Type: int
  • Required: No
  • User Property: shutdown.gracePeriod
  • Default: 5

<shutdownWaitTime>

Wait up to this number of minutes for AEM to stop
  • Type: int
  • Required: No
  • User Property: shutdown.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