Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
SessionStoreOptimized |
|
| 1.0;1 |
1 | // Copyright 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry; | |
16 | ||
17 | /** | |
18 | * <em>Optional</em> interface implemented by Application State Objects. This interface allows | |
19 | * Tapestry to optimize the storage of the objects into the | |
20 | * {@link org.apache.tapestry.web.WebSession session}, only storing the objects when they require | |
21 | * storage due to a change in internal state. | |
22 | * | |
23 | * @author Howard M. Lewis Ship | |
24 | * @since 4.0 | |
25 | */ | |
26 | public interface SessionStoreOptimized | |
27 | { | |
28 | /** | |
29 | * Queried by the {@link org.apache.tapestry.engine.state.StateObjectManager} to see if the | |
30 | * object actually needs to be stored. Objects that implement this interface should store an | |
31 | * internal flag. The flag should be set when any change to the object's internal state occurs. | |
32 | * The flag should be cleared when the object is stored into the session (typically, by | |
33 | * implementing {@link javax.servlet.http.HttpSessionBindingListener}. | |
34 | * | |
35 | * @return true if the object needs to be stored back into the session, false if the internal | |
36 | * state of the object is unchanged | |
37 | */ | |
38 | boolean isStoreToSessionNeeded(); | |
39 | ||
40 | } |