Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Developer's Guide

- Previous: steady-pool-size
- Next: stub-property

## store-properties

Specifies session persistence (storage) properties.

### Superelements

session-manager (`sun-web.xml`)

### Subelements

The following table describes subelements for the `store-properties` element.

Table A–111 `store-properties` Subelements

Element | Required | Description
--- | --- | ---
property (with attributes) | zero or more | Specifies a property, which has a name and a value.

### Properties

The following table describes properties for the `store-properties` element.

Table A–112 `store-properties` Properties

Property | Default | Description
--- | --- | ---
`directory` | domain-dir`/generated/jsp/j2ee-apps/`app-name`/`app-name`_war` | Specifies the absolute or relative pathname of the directory into which individual session files are written. A relative path is relative to the temporary work directory for this web application. Applicable only if the `persistence-type` attribute of the parent session-manager element is `file`.
`persistenceScope` | `session` | Specifies how much of the session state is stored. Allowed values are as follows: `session` - The entire session state is stored every time. This mode provides the best guarantee that your session data is correctly stored for any distributable web application. `modified-session` - The entire session state is stored if it has been modified. A session is considered to have been modified if `HttpSession.setAttribute()` or `HttpSession.removeAttribute()` was called. You must guarantee that `setAttribute()` is called every time an attribute is changed. This is not a J2EE specification requirement, but it is required for this mode to work properly. `modified-attribute` - Only modified session attributes are stored. For this mode to work properly, you must follow some guidelines, which are explained immediately following this table. Applicable only if the `persistence-type` attribute of the parent session-manager element is `ha`.

If the `persistenceScope` store property is set to `modified-attribute`, a web application must follow these guidelines:

- Call `setAttribute()` every time the session state is modified.

- Make sure there are no cross-references between attributes. The object graph under each distinct attribute key is serialized and stored separately. If there are any object cross references between the objects under each separate key, they are not serialized and deserialized correctly.

- Distribute the session state across multiple attributes, or at least between a read-only attribute and a modifiable attribute.

- Previous: steady-pool-size
- Next: stub-property

- © 2010, Oracle Corporation and/or its affiliates