wildscribe:generate-site
Full name:
org.jboss.wildscribe:wildscribe-maven-plugin:2.0.0.Final:generate-site
Description:
A simple plugin used to generate a Wildscribe site.
Attributes:
- Requires a Maven project to be executed.
Required Parameters
Name | Type | Since | Description |
---|---|---|---|
jbossHome | String | - | The application server's home directory. This is a required
parameter and must point to a valid server directory. The server
must include the module JAR's in order to get the log messages for
the generated site. User property is: wildscribe.jboss.home. Alias is: jboss-home. |
Optional Parameters
Name | Type | Since | Description |
---|---|---|---|
displayName | String | - | This is only used for a single version and will be used for the
displayed name. If left null the name will be resolved
from the running server. User property is: wildscribe.display.name. Alias is: display-name. |
displayVersion | String | - | This is only used for a single version and will be used for the
displayed version. If left null the version will be
resolved from the running server. User property is: wildscribe.display.version. Alias is: display-version. |
hostname | String | - | Specifies the host name for the management client. Default value is: localhost. User property is: wildscribe.management.hostname. |
javaOpts | String[] | - | The JVM options used for starting the server. User property is: wildscribe.java.opts. Alias is: java-opts. |
modelDir | String | - | The target directory the model and message files will be written
to. Default value is: ${project.build.directory}/wildscribe. User property is: wildscribe.model.dir. Alias is: model-dir. |
port | int | - | Specifies the port number for the management client. Default value is: 9990. User property is: wildscribe.management.port. |
protocol | String | - | The protocol used to connect the management client. User property is: wildscribe.management.protocol. |
requiredExtensions | List | - | The extensions that are required to be installed before the model
is dumped. If any of these extensions do not already exist on the
server then they will be added. User property is: wildscribte.required.extensions. Alias is: required-extensions. |
serverConfig | String | - | The path to the server configuration to use. Default value is: standalone-full-ha.xml. User property is: wildscribe.server.config. Alias is: server-config. |
siteDir | String | - | The target directory the site to be generated in. Default value is: ${project.build.directory}/wildscribe. User property is: wildscribe.site.dir. Alias is: site-dir. |
skip | boolean | - | Set to true if you want this goal to be skipped,
otherwise false. Default value is: false. User property is: wildscribe.skip. |
timeout | int | - | The timeout, in seconds, to wait for a management connection. Default value is: 60. User property is: wildscribe.timeout. |
Parameter Details
This is only used for a single version and will be used for the
displayed name. If left null the name will be resolved
from the running server.
- Type: java.lang.String
- Required: No
- User Property: wildscribe.display.name
- Alias: display-name
This is only used for a single version and will be used for the
displayed version. If left null the version will be
resolved from the running server.
- Type: java.lang.String
- Required: No
- User Property: wildscribe.display.version
- Alias: display-version
Specifies the host name for the management client.
- Type: java.lang.String
- Required: No
- User Property: wildscribe.management.hostname
- Default: localhost
The JVM options used for starting the server.
- Type: java.lang.String[]
- Required: No
- User Property: wildscribe.java.opts
- Alias: java-opts
The application server's home directory. This is a required
parameter and must point to a valid server directory. The server
must include the module JAR's in order to get the log messages for
the generated site.
- Type: java.lang.String
- Required: Yes
- User Property: wildscribe.jboss.home
- Alias: jboss-home
The target directory the model and message files will be written
to.
- Type: java.lang.String
- Required: No
- User Property: wildscribe.model.dir
- Default: ${project.build.directory}/wildscribe
- Alias: model-dir
port:
Specifies the port number for the management client.
- Type: int
- Required: No
- User Property: wildscribe.management.port
- Default: 9990
The protocol used to connect the management client.
- Type: java.lang.String
- Required: No
- User Property: wildscribe.management.protocol
The extensions that are required to be installed before the model
is dumped. If any of these extensions do not already exist on the
server then they will be added.
- Type: java.util.List
- Required: No
- User Property: wildscribte.required.extensions
- Alias: required-extensions
The path to the server configuration to use.
- Type: java.lang.String
- Required: No
- User Property: wildscribe.server.config
- Default: standalone-full-ha.xml
- Alias: server-config
The target directory the site to be generated in.
- Type: java.lang.String
- Required: No
- User Property: wildscribe.site.dir
- Default: ${project.build.directory}/wildscribe
- Alias: site-dir
skip:
Set to true if you want this goal to be skipped,
otherwise false.
- Type: boolean
- Required: No
- User Property: wildscribe.skip
- Default: false
The timeout, in seconds, to wait for a management connection.
- Type: int
- Required: No
- User Property: wildscribe.timeout
- Default: 60