WildFly 34 Model Reference

The configuration of the deployment scanner subsystem.

Provided capabilities(1)

Name Dynamic Other provider points
org.wildfly.management.deployment-scanner true

none

Attributes (9)

  • auto-deploy-exploded Allows the automatic deployment of exploded content without requiring a .dodeploy marker file. Recommended for only basic development scenarios to prevent exploded application deployment from occurring during changes by the developer or operating system.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • auto-deploy-xml Allows automatic deployment of XML content without requiring a .dodeploy marker file.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • auto-deploy-zipped Allows automatic deployment of zipped content without requiring a .dodeploy marker file.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • deployment-timeout The time value in seconds for the deployment scanner to allow a deployment attempt before being cancelled.
    • Attribute Value
    Default Value 600
    Type LONG
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • path The actual filesystem path to be scanned. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • relative-to Reference to a filesystem path defined in the "paths" section of the server configuration.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • runtime-failure-causes-rollback Flag indicating whether a runtime failure of a deployment causes a rollback of the deployment as well as all other (maybe unrelated) deployments as part of the scan operation.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • scan-enabled Flag indicating if all scanning (including initial scanning at startup) is enabled.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • scan-interval Periodic interval, in milliseconds, at which the repository should be scanned for changes. A value of less than 1 indicates the repository should only be scanned at initial startup.
    • Attribute Value
    Default Value 0
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default

Operations (5)

  • add Add a new deployment scanner.
    Request Parameter Type Required Expressions Allowed Default value Description
    auto-deploy-exploded BOOLEAN false true false Allows the automatic deployment of exploded content without requiring a .dodeploy marker file. Recommended for only basic development scenarios to prevent exploded application deployment from occurring during changes by the developer or operating system.
    auto-deploy-xml BOOLEAN false true true Allows automatic deployment of XML content without requiring a .dodeploy marker file.
    auto-deploy-zipped BOOLEAN false true true Allows automatic deployment of zipped content without requiring a .dodeploy marker file.
    deployment-timeout LONG false true 600 The time value in seconds for the deployment scanner to allow a deployment attempt before being cancelled.
    path STRING true true The actual filesystem path to be scanned. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.
    relative-to STRING false false Reference to a filesystem path defined in the "paths" section of the server configuration.
    runtime-failure-causes-rollback BOOLEAN false true false Flag indicating whether a runtime failure of a deployment causes a rollback of the deployment as well as all other (maybe unrelated) deployments as part of the scan operation.
    scan-enabled BOOLEAN false true true Flag indicating if all scanning (including initial scanning at startup) is enabled.
    scan-interval INT false true 0 Periodic interval, in milliseconds, at which the repository should be scanned for changes. A value of less than 1 indicates the repository should only be scanned at initial startup.
  • path-info Obtain the informations for a filesystem path.
    Request Parameter Type Required Expressions Allowed Default value Description
    unit STRING false false BYTES Disk space unit to display disk usage.

    Reply properties

    Filesystem path for which to obtain disk usage.
    type
    OBJECT
    Value Type
    {
    "used-space" => {
        "type" => DOUBLE,
        "description" => "The total size of the contents of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "unit" => "BYTES",
        "stability" => "default"
    },
    "creation-time" => {
        "type" => STRING,
        "description" => "The creation time of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L,
        "stability" => "default"
    },
    "last-modified" => {
        "type" => STRING,
        "description" => "The last modified time of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L,
        "stability" => "default"
    },
    "resolved-path" => {
        "type" => STRING,
        "description" => "The resolved filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L,
        "stability" => "default"
    },
    "available-space" => {
        "type" => DOUBLE,
        "description" => "The total size of available space for the partition containing a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "unit" => "BYTES",
        "stability" => "default"
    }
}
  • remove Remove a deployment scanner.
  • resolve-path Resolves a relative path of a previously named paths or one of the standard paths provided by the system.
    Request Parameter Type Required Expressions Allowed Default value Description
    relative-to-only BOOLEAN false false Indicates whether only the relative-to attribute should be resolved or the full path should be resolved. The default is false meaning the entire path will be resolved.

    Reply properties

    The resolved path from the relative path attribute.
    type
    STRING
  • run-scan The operation to run a single scan of the deployment scanner.