WildFly 34 Model Reference

A deployment represents anything that can be deployed (e.g. an application such as Jakarta Enterprise Beans-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.

batch-jberet Information about the batch subsystem for the deployment.
datasources The data-sources subsystem, used to declare JDBC data-sources
ejb3 Runtime resources exposed by Jakarta Enterprise Beans components included in this deployment.
jaxrs The configuration of the Jakarta RESTful Web Services subsystem.
jpa The configuration of the Jakarta Persistence subsystem.
logging Information about the logging configuration for this deployment. Note that this may not be accurate if the deployment is using some other means of configuring a log manager such as logback. The resolved configuration is what loggers not covered by the deployments specific log manager would use.
messaging-activemq Runtime resources exposed by messaging resources included in this deployment.
resource-adapters Runtime statistics provided by the resource adapter.
undertow Information about the web container handling of this deployment
webservices Runtime resources exposed by web service components in the deployment.

Attributes (12)

content List of pieces of content that comprise the deployment.

Attribute	Value
Type	LIST
Nillable	false
Expressions Allowed	false
Storage	configuration
Access Type	read-only
Stability	default

disabled-time Last time the application was disabled

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Unit	MILLISECONDS
Storage	runtime
Access Type	read-only
Stability	default

disabled-timestamp Last timestamp the application was disabled. Format is yyyy-MM-dd HH:mm:ss,SSS zzz.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only
Stability	default

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
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-only
Stability	default

enabled-time Last time the application was enabled

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Unit	MILLISECONDS
Storage	runtime
Access Type	read-only
Stability	default

enabled-timestamp Last timestamp the application was enabled. Format is yyyy-MM-dd HH:mm:ss,SSS zzz.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only
Stability	default

managed Indicates if the deployment is managed (aka uses the ContentRepository).

Attribute	Value
Type	BOOLEAN
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only
Stability	default

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
Stability	default

owner Address of a resource that has indicated it controls the lifecycle of this deployment (e.g. a deployment scanner resource.) Will be undefined if no resource claimed ownership when the deployment was added.

Attribute	Value
Type	OBJECT
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-only
Stability	default

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	false
Expressions Allowed	false
Storage	configuration
Access Type	read-only
Stability	default

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
Stability	default

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
Stability	default

Operations (11)

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	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.)

add-content Add contents to an existing deployment.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
content	LIST	true	false		List of pieces of content to be added to the deployment.
overwrite	BOOLEAN	false	false	true	Indicates if added content should overwrite existing content.

browse-content List the pieces of content of a deployment.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
path	STRING	false	false		The relative path from a deployment to list the contents of.
archive	BOOLEAN	false	false	false	If set to true, only the relative paths to archive files will be returned.
depth	INT	false	false	-1	The depth to browse.

Reply properties

The pieces of content of a deployment and some information about them.

type

OBJECT

Value Type

{
    "directory" => {
        "type" => BOOLEAN,
        "description" => "Indicates if the content is a folder or not.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "stability" => "default"
    },
    "path" => {
        "type" => STRING,
        "description" => "Path (relative or absolute) to unmanaged content that is part of the deployment.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L,
        "stability" => "default"
    },
    "file-size" => {
        "type" => LONG,
        "description" => "The size of the content if it is a file.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "unit" => "BYTES",
        "stability" => "default"
    }
}

deploy Deploy the specified deployment content into the runtime, optionally replacing existing content.
explode Convert zip format managed deployment content to exploded format.

Request Parameter Type Required Expressions Allowed Default value Description

path STRING false false Relative path to an archive in a deployment to be exploded.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
path	STRING	false	false		Relative path to an archive in a deployment to be exploded.

list-modules List all module dependencies of the current deployment.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
verbose	BOOLEAN	false	false	false	Optional, default is false and results in brief info about the module dependencies, true to include detailed information about the module dependencies added to the current deployment.

read-content Read the content of an existing deployment.

Request Parameter Type Required Expressions Allowed Default value Description

path STRING false false The relative path of the content to be read from an existing deployment.

Reply properties

The uuid of the attached stream.

type

STRING
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.
remove-content Remove contents from an existing deployment.

Request Parameter Type Required Expressions Allowed Default value Description

paths LIST true true List of paths of content to be removed from the deployment.
undeploy Undeploy content from the runtime. The content remains in the list of content available for use.