Built by Maven

wildscribe:generate-site

Full name:

org.jboss.wildscribe:wildscribe-maven-plugin:3.1.0.Final:generate-site

Description:

A simple plugin used to generate a Wildscribe site.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

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: wildscribe.jboss.home
Alias: 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: wildscribe.display.name
Alias: 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: wildscribe.display.version
Alias: display-version
<hostname> String - Specifies the host name for the management client.
Default: localhost
User Property: wildscribe.management.hostname
<javaOpts> String[] - The JVM options used for starting the server.
User Property: wildscribe.java.opts
Alias: java-opts
<modelDir> String - The target directory the model and message files will be written to.
Default: ${project.build.directory}/wildscribe
User Property: wildscribe.model.dir
Alias: model-dir
<port> int - Specifies the port number for the management client.
Default: 9990
User Property: wildscribe.management.port
<protocol> String - The protocol used to connect the management client.
User Property: wildscribe.management.protocol
<requiredExtensions> List<String> - 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: wildscribte.required.extensions
Alias: required-extensions
<serverConfig> String - The path to the server configuration to use.
Default: standalone-full-ha.xml
User Property: wildscribe.server.config
Alias: server-config
<siteDir> String - The target directory the site to be generated in.
Default: ${project.build.directory}/wildscribe
User Property: wildscribe.site.dir
Alias: site-dir
<skip> boolean - Set to true if you want this goal to be skipped, otherwise false.
Default: false
User Property: wildscribe.skip
<stability> String - The stability level of the server. already exist on the server then they will be added.
User Property: wildscribte.stability.level
Alias: stability
<timeout> int - The timeout, in seconds, to wait for a management connection.
Default: 60
User Property: wildscribe.timeout

Parameter Details

<displayName>

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

<displayVersion>

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

<hostname>

Specifies the host name for the management client.
  • Type: java.lang.String
  • Required: No
  • User Property: wildscribe.management.hostname
  • Default: localhost

<javaOpts>

The JVM options used for starting the server.
  • Type: java.lang.String[]
  • Required: No
  • User Property: wildscribe.java.opts
  • Alias: java-opts

<jbossHome>

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

<modelDir>

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

<protocol>

The protocol used to connect the management client.
  • Type: java.lang.String
  • Required: No
  • User Property: wildscribe.management.protocol

<requiredExtensions>

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<java.lang.String>
  • Required: No
  • User Property: wildscribte.required.extensions
  • Alias: required-extensions

<serverConfig>

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

<siteDir>

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

<stability>

The stability level of the server. already exist on the server then they will be added.
  • Type: java.lang.String
  • Required: No
  • User Property: wildscribte.stability.level
  • Alias: stability

<timeout>

The timeout, in seconds, to wait for a management connection.
  • Type: int
  • Required: No
  • User Property: wildscribe.timeout
  • Default: 60