Management API Reference for scanner

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.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

auto-deploy-xml - Allows automatic deployment of XML content without requiring a .dodeploy marker file.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Allows automatic deployment of XML content without requiring a .dodeploy marker file.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

auto-deploy-zipped - Allows automatic deployment of zipped content without requiring a .dodeploy marker file.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Allows automatic deployment of zipped content without requiring a .dodeploy marker file.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

deployment-timeout - The time value in seconds for the deployment scanner to allow a deployment attempt before being cancelled.

Type	LONG
Default Value	600
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The time value in seconds for the deployment scanner to allow a deployment attempt before being cancelled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 600, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

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.

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "filesystem-path" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

relative-to - Reference to a filesystem path defined in the "paths" section of the server configuration.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reference to a filesystem path defined in the \"paths\" section of the server configuration.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.management.path", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }`

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.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

scan-enabled - Flag indicating if all scanning (including initial scanning at startup) is enabled.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Flag indicating if all scanning (including initial scanning at startup) is enabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

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.

Type	INT
Default Value	0
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

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.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new deployment scanner.",
    "request-properties" : {
        "auto-deploy-exploded" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "auto-deploy-xml" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Allows automatic deployment of XML content without requiring a .dodeploy marker file.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "auto-deploy-zipped" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Allows automatic deployment of zipped content without requiring a .dodeploy marker file.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "deployment-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The time value in seconds for the deployment scanner to allow a deployment attempt before being cancelled.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 600,
            "stability" : "default"
        },
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "filesystem-path" : true,
            "stability" : "default"
        },
        "relative-to" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to a filesystem path defined in the \"paths\" section of the server configuration.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.management.path",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "runtime-failure-causes-rollback" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "scan-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Flag indicating if all scanning (including initial scanning at startup) is enabled.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "scan-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

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" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "last-modified" => {
        "type" => STRING,
        "description" => "The last modified time of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "resolved-path" => {
        "type" => STRING,
        "description" => "The resolved filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1,
        "max-length" => 2147483647,
        "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"
    }
}

Raw DMR model


{
    "operation-name" : "path-info",
    "description" : "Obtain the informations for a filesystem path.",
    "request-properties" : {"unit" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "Disk space unit to display disk usage.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "default" : "BYTES",
        "min-length" : 1,
        "max-length" : 2147483647,
        "allowed" : [
            "BYTES",
            "KILOBYTES",
            "MEGABYTES",
            "GIGABYTES",
            "TERABYTES",
            "PETABYTES",
            "BITS",
            "KILOBITS",
            "MEGABITS",
            "GIGABITS",
            "TERABITS",
            "PETABITS"
        ],
        "stability" : "default"
    }},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "OBJECT"
        },
        "description" : "Filesystem path for which to obtain disk usage.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "stability" : "default",
        "value-type" : {
            "used-space" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "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" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The creation time of a filesystem path.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "last-modified" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The last modified time of a filesystem path.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "resolved-path" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The resolved filesystem path.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "available-space" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "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"
            }
        }
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

remove - Remove a deployment scanner.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a deployment scanner.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

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

Raw DMR model


{
    "operation-name" : "resolve-path",
    "description" : "Resolves a relative path of a previously named paths or one of the standard paths provided by the system.",
    "request-properties" : {"relative-to-only" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "BOOLEAN"
        },
        "description" : "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.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "stability" : "default"
    }},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The resolved path from the relative path attribute."
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

run-scan - The operation to run a single scan of the deployment scanner.

Raw DMR model


{
    "operation-name" : "run-scan",
    "description" : "The operation to run a single scan of the deployment scanner.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.deployment-scanner.scanner

        
<feature spec="subsystem.deployment-scanner.scanner">
  <param name="scanner" value="{resource name}"/>
  <param name="auto-deploy-exploded" value="{value}"/>
  <param name="auto-deploy-xml" value="{value}"/>
  <param name="auto-deploy-zipped" value="{value}"/>
  <param name="deployment-timeout" value="{value}"/>
  <param name="path" value="{value}"/>
  <param name="relative-to" value="{value}"/>
  <param name="runtime-failure-causes-rollback" value="{value}"/>
  <param name="scan-enabled" value="{value}"/>
  <param name="scan-interval" value="{value}"/>
<feature/>