## Attributes (7)

- groups-path - The subdirectory within the path specified by relative-to in which to store passivated bean groups
  Deprecated Since 2.0.0
  Beans and bean groups are no longer stored in distinct directories

  Type | STRING
  Default Value | ejb3/groups
  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" : "STRING"
          },
          "description" : "The subdirectory within the path specified by relative-to in which to store passivated bean groups",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "ejb3/groups",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "deprecated" : {
              "since" : "2.0.0",
              "reason" : "Beans and bean groups are no longer stored in distinct directories"
          },
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- idle-timeout - The timeout in units specified by idle-timeout-unit, after which a bean will passivate

  Type | LONG
  Default Value | 300
  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
  Min | 1
  Max | 2147483647
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The timeout in units specified by idle-timeout-unit, after which a bean will passivate",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : 300,
          "min" : 1,
          "max" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- idle-timeout-unit - The unit of idle-timeout
  Deprecated Since 2.0.0
  SFSBs are no longer passivated eagerly, but only lazily as required by max-size

  Type | STRING
  Default Value | SECONDS
  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
  Allowed Values | MILLISECONDS MICROSECONDS HOURS SECONDS NANOSECONDS DAYS MINUTES
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The unit of idle-timeout",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "SECONDS",
          "allowed" : [
              "NANOSECONDS",
              "MICROSECONDS",
              "MILLISECONDS",
              "SECONDS",
              "MINUTES",
              "HOURS",
              "DAYS"
          ],
          "stability" : "default",
          "deprecated" : {
              "since" : "2.0.0",
              "reason" : "SFSBs are no longer passivated eagerly, but only lazily as required by max-size"
          },
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- max-size - The maximum number of beans this cache should store before forcing old beans to passivate

  Type | INT
  Default Value | 100000
  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
  Min | 1
  Max | 2147483647
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "INT"
          },
          "description" : "The maximum number of beans this cache should store before forcing old beans to passivate",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : 100000,
          "min" : 1,
          "max" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- relative-to - The root path used to store passivated beans
  Deprecated Since 2.0.0
  Use the relative-to attribute of the file-store of the relevant infinispan cache instead

  Type | STRING
  Default Value | jboss.server.data.dir
  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" : "STRING"
          },
          "description" : "The root path used to store passivated beans",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "jboss.server.data.dir",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "deprecated" : {
              "since" : "2.0.0",
              "reason" : "Use the relative-to attribute of the file-store of the relevant infinispan cache instead"
          },
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- sessions-path - The subdirectory within the path specified by relative-to in which to store passivated beans
  Deprecated Since 2.0.0
  Beans and bean groups are no longer stored in distinct directories

  Type | STRING
  Default Value | ejb3/sessions
  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" : "STRING"
          },
          "description" : "The subdirectory within the path specified by relative-to in which to store passivated beans",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "ejb3/sessions",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "deprecated" : {
              "since" : "2.0.0",
              "reason" : "Beans and bean groups are no longer stored in distinct directories"
          },
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- subdirectory-count - Specifies the number of subdirectories into which stored state should be divided, used to minimize the number of files created per directory
  Deprecated Since 2.0.0
  This is no longer configurable and will be ignored

  Type | LONG
  Default Value | 100
  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
  Min | 1
  Max | 2147483647
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "Specifies the number of subdirectories into which stored state should be divided, used to minimize the number of files created per directory",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : 100,
          "min" : 1,
          "max" : 2147483647,
          "stability" : "default",
          "deprecated" : {
              "since" : "2.0.0",
              "reason" : "This is no longer configurable and will be ignored"
          },
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

## Operations (2)

- add - Adds a file system based passivation store

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  groups-path | STRING | false | true | ejb3/groups | The subdirectory within the path specified by relative-to in which to store passivated bean groups
  idle-timeout | LONG | false | true | 300 | The timeout in units specified by idle-timeout-unit, after which a bean will passivate
  idle-timeout-unit | STRING | false | true | SECONDS | The unit of idle-timeout
  max-size | INT | false | true | 100000 | The maximum number of beans this cache should store before forcing old beans to passivate
  relative-to | STRING | false | true | jboss.server.data.dir | The root path used to store passivated beans
  sessions-path | STRING | false | true | ejb3/sessions | The subdirectory within the path specified by relative-to in which to store passivated beans
  subdirectory-count | LONG | false | true | 100 | Specifies the number of subdirectories into which stored state should be divided, used to minimize the number of files created per directory

  Raw DMR model |
      {
          "operation-name" : "add",
          "description" : "Adds a file system based passivation store",
          "request-properties" : {
              "groups-path" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The subdirectory within the path specified by relative-to in which to store passivated bean groups",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "ejb3/groups",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default",
                  "deprecated" : {
                      "since" : "2.0.0",
                      "reason" : "Beans and bean groups are no longer stored in distinct directories"
                  }
              },
              "idle-timeout" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The timeout in units specified by idle-timeout-unit, after which a bean will passivate",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : 300,
                  "min" : 1,
                  "max" : 2147483647,
                  "stability" : "default"
              },
              "idle-timeout-unit" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The unit of idle-timeout",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "SECONDS",
                  "allowed" : [
                      "NANOSECONDS",
                      "MICROSECONDS",
                      "MILLISECONDS",
                      "SECONDS",
                      "MINUTES",
                      "HOURS",
                      "DAYS"
                  ],
                  "stability" : "default",
                  "deprecated" : {
                      "since" : "2.0.0",
                      "reason" : "SFSBs are no longer passivated eagerly, but only lazily as required by max-size"
                  }
              },
              "max-size" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "INT"
                  },
                  "description" : "The maximum number of beans this cache should store before forcing old beans to passivate",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : 100000,
                  "min" : 1,
                  "max" : 2147483647,
                  "stability" : "default"
              },
              "relative-to" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The root path used to store passivated beans",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "jboss.server.data.dir",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default",
                  "deprecated" : {
                      "since" : "2.0.0",
                      "reason" : "Use the relative-to attribute of the file-store of the relevant infinispan cache instead"
                  }
              },
              "sessions-path" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The subdirectory within the path specified by relative-to in which to store passivated beans",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "ejb3/sessions",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default",
                  "deprecated" : {
                      "since" : "2.0.0",
                      "reason" : "Beans and bean groups are no longer stored in distinct directories"
                  }
              },
              "subdirectory-count" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "Specifies the number of subdirectories into which stored state should be divided, used to minimize the number of files created per directory",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : 100,
                  "min" : 1,
                  "max" : 2147483647,
                  "stability" : "default",
                  "deprecated" : {
                      "since" : "2.0.0",
                      "reason" : "This is no longer configurable and will be ignored"
                  }
              }
          },
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- remove - Removes a file system based passivation store

  Raw DMR model |
      {
          "operation-name" : "remove",
          "description" : "Removes a file system based passivation store",
          "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.ejb3.file-passivation-store

      <feature spec="subsystem.ejb3.file-passivation-store">
        <param name="file-passivation-store" value="{resource name}"/>
        <param name="groups-path" value="{value}"/>
        <param name="idle-timeout" value="{value}"/>
        <param name="idle-timeout-unit" value="{value}"/>
        <param name="max-size" value="{value}"/>
        <param name="relative-to" value="{value}"/>
        <param name="sessions-path" value="{value}"/>
        <param name="subdirectory-count" value="{value}"/>
      <feature/>