JBoss EAP 6.0 Model Reference

  1. JBoss EAP 6.0
  2. deployment

A deployment represents anything that can be deployed (e.g. an application such as EJB-JAR, WAR, EAR, any kind of standard archive such as RAR or JBoss-specific deployment) into a server.

Children (2)

  • subdeployment Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear.
  • subsystem Runtime resources created when the deployment is deployed, organized by the subsystem responsible for the runtime resource.
    • web Runtime resources exposed by web components in the deployment.

Attributes (6)

  • content List of pieces of content that comprise the deployment.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • enabled Boolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.)
    • Attribute Value
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • name Unique identifier of the deployment. Must be unique across all deployments.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • persistent Boolean indicating whether the existence of the deployment should be recorded in the persistent server configuration. Only relevant to a standalone mode server. Default is 'true'. A deployment managed by a deployment scanner would have this set to 'false' to ensure the deployment is only deployed at server start if the scanner again detects the deployment.
    • Attribute Value
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • runtime-name Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of "foo.war") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • status The current runtime status of a deployment. Possible status modes are OK, FAILED, and STOPPED. FAILED indicates a dependency is missing or a service could not start. STOPPED indicates that the deployment was not enabled or was manually stopped.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric

Operations (5)

  • add Adds previously uploaded content to the list of content available for use. Does not actually deploy the content unless the 'enabled' parameter is 'true'.
    Request Parameter Type Required Expressions Allowed Default value Description
    runtime-name STRING false false Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of "foo.war") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.
    content LIST true false List of pieces of content that comprise the deployment.
    enabled BOOLEAN false false Boolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.)
  • deploy Deploy the specified deployment content into the runtime, optionally replacing existing content.
  • redeploy Undeploy existing content from the runtime and deploy it again.
  • remove Remove a deployment from the list of content available for use. If the deployment is currently deployed in the runtime it will first be undeployed.
  • undeploy Undeploy content from the runtime. The content remains in the list of content available for use.