Management API Reference for path

A named filesystem path.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.management.path	true	none

Attributes (4)

name - The name of the path. Cannot be one of the standard fixed paths provided by the system: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance. Note that the system provides other standard paths that can be overridden by declaring them in the configuration file. See the 'relative-to' attribute documentation for a complete list of standard paths.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the path. Cannot be one of the standard fixed paths provided by the system: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance. Note that the system provides other standard paths that can be overridden by declaring them in the configuration file. See the 'relative-to' attribute documentation for a complete list of standard paths.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

path - The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path. If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows: If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

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. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path. If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows: If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.", "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 }

read-only - True if added by the system, false if configured by user. If true, the path cannot be removed or modified.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "True if added by the system, false if configured by user. If true, the path cannot be removed or modified.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

relative-to - The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances.

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" : "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances.", "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" }

Operations (3)

add - Add a new path.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
path	STRING	true	true		The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path. If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows: If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.
relative-to	STRING	false	false		The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new path.",
    "request-properties" : {
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path. If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows: If this value is already absolute, then the value is directly used.  Otherwise the runtime pathname is resolved in a system-dependent way.  On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.",
            "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" : "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.management.path",
            "min-length" : 1,
            "max-length" : 2147483647,
            "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 path

Raw DMR model


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

Galleon Features

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

path

        
<feature spec="path">
  <param name="path" value="{resource name}"/>
  <param name="path-feature" value="{value}"/>
  <param name="relative-to" value="{value}"/>
<feature/>