Management API Reference for file-data-store

A JVM local file store that stores persistent Jakarta Enterprise Beans timers

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.ejb3.timer-service.timer-persistence-service	true	/subsystem=ejb3/service=timer-service/database-data-store=*

Attributes (2)

path - The directory to store persistent timer information in

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" : "The directory to store persistent timer information in", "expressions-allowed" : true, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

relative-to - The relative path that is used to resolve the timer data store location

Type	STRING
Is the attribute nillable?	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" : "The relative path that is used to resolve the timer data store location", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (3)

add - Adds a file data store

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
path	STRING	true	true		The directory to store persistent timer information in
relative-to	STRING	false	false		The relative path that is used to resolve the timer data store location

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a file data store",
    "request-properties" : {
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The directory to store persistent timer information in",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "stability" : "default"
        },
        "relative-to" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The relative path that is used to resolve the timer data store location",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

remove - "Removes a file data store

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "\"Removes a file data store",
    "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
}

Galleon Features

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

subsystem.ejb3.service.timer-service.file-data-store

        
<feature spec="subsystem.ejb3.service.timer-service.file-data-store">
  <param name="file-data-store" value="{resource name}"/>
  <param name="path" value="{value}"/>
  <param name="relative-to" value="{value}"/>
<feature/>