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.
Attribute | Value |
---|---|
Type | LIST |
Nillable | false |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-only |
Attribute | Value |
---|---|
Type | LONG |
Nillable | true |
Expressions Allowed | false |
Unit | MILLISECONDS |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | false |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Default Value | false |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-only |
Attribute | Value |
---|---|
Type | LONG |
Nillable | true |
Expressions Allowed | false |
Unit | MILLISECONDS |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | false |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Type | BOOLEAN |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Type | STRING |
Nillable | false |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-only |
Attribute | Value |
---|---|
Type | OBJECT |
Nillable | true |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-only |
Attribute | Value |
---|---|
Type | BOOLEAN |
Nillable | false |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-only |
Attribute | Value |
---|---|
Type | STRING |
Nillable | false |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-only |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | false |
Storage | runtime |
Access Type | metric |
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.) |
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. |
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. |
{
"directory" => {
"type" => BOOLEAN,
"description" => "Indicates if the content is a folder or not.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"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
},
"file-size" => {
"type" => LONG,
"description" => "The size of the content if it is a file.",
"expressions-allowed" => false,
"required" => false,
"nillable" => true,
"unit" => "BYTES"
}
}
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 |
---|---|---|---|---|---|
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. |
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. |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
paths | LIST | true | true | List of paths of content to be removed from the deployment. |