Management API Reference for file

File handler

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.extension.undertow.handler	true	/subsystem=undertow/configuration=handler/reverse-proxy=*

Attributes (7)

cache-buffer-size - Size of the buffers, in bytes.

Type	LONG
Default Value	1024
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Size of the buffers, in bytes.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1024, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

cache-buffers - Number of buffers

Type	LONG
Default Value	1024
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Number of buffers", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1024, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

case-sensitive - Use case sensitive file handling

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Use case sensitive file handling", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

directory-listing - Enable directory listing?

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable directory listing?", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

follow-symlink - Enable following symbolic links

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable following symbolic links", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

path - Path on filesystem from where file handler will serve resources

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Path on filesystem from where file handler will serve resources", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

safe-symlink-paths - Paths that are safe to be targets of symbolic links

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Paths that are safe to be targets of symbolic links", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Add file handler

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
cache-buffer-size	LONG	false	true	1024	Size of the buffers, in bytes.
cache-buffers	LONG	false	true	1024	Number of buffers
case-sensitive	BOOLEAN	false	true	true	Use case sensitive file handling
directory-listing	BOOLEAN	false	true	false	Enable directory listing?
follow-symlink	BOOLEAN	false	true	false	Enable following symbolic links
path	STRING	true	true		Path on filesystem from where file handler will serve resources
safe-symlink-paths	LIST	false	true		Paths that are safe to be targets of symbolic links

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add file handler",
    "request-properties" : {
        "cache-buffer-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Size of the buffers, in bytes.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1024,
            "stability" : "default"
        },
        "cache-buffers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Number of buffers",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1024,
            "stability" : "default"
        },
        "case-sensitive" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Use case sensitive file handling",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "directory-listing" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enable directory listing?",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "follow-symlink" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enable following symbolic links",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Path on filesystem from where file handler will serve resources",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "safe-symlink-paths" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "Paths that are safe to be targets of symbolic links",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - Remove file handler

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove file handler",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

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

subsystem.undertow.configuration.handler.file

        
<feature spec="subsystem.undertow.configuration.handler.file">
  <param name="file" value="{resource name}"/>
  <param name="cache-buffer-size" value="{value}"/>
  <param name="cache-buffers" value="{value}"/>
  <param name="case-sensitive" value="{value}"/>
  <param name="directory-listing" value="{value}"/>
  <param name="follow-symlink" value="{value}"/>
  <param name="path" value="{value}"/>
  <param name="safe-symlink-paths" value="{value}"/>
<feature/>