You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -45,11 +45,47 @@ For Maven, you can add the ScaleOut API Repository to your pom.xml by adding the
45
45
<dependency>
46
46
<groupId>com.scaleoutsoftware.spring</groupId>
47
47
<artifactId>session</artifactId>
48
-
<version>1.0</version>
48
+
<version>2.0</version>
49
49
</dependency>
50
50
</dependencies>
51
51
```
52
52
53
+
### Usage
54
+
55
+
ScaleOut can be used a SessionRepository by using the ``` EnableScaleoutHttpSession ``` attribute.
56
+
57
+
The attribute has six parameters:
58
+
59
+
##### cacheName
60
+
61
+
The ``` cacheName ``` parameter defines the ScaleOut namespace the ScaleoutSessionRepository will use for storing session objects.
62
+
63
+
Default Value: ``` SpringSessionRepo ```
64
+
65
+
#### maxInactiveTimeMinutes
66
+
67
+
The ``` maxInactiveTimeMinutes ``` parameter defines the maximum allowed time that a session can exist before expiring. The timeout used is sliding, such that after every access (``` findById(id) ``` or ``` save(session) ```) the timeout is reset.
68
+
69
+
Default value: ``` 30 ```
70
+
71
+
#### useLocking
72
+
73
+
The ``` useLocking ``` parameter tells the ScaleoutSessionRepository whether to lock Session's during access operations.
74
+
75
+
Note, locking required if GeoServer pull enabled.
76
+
77
+
Default value: ``` true ```
78
+
79
+
#### remoteStoreName
80
+
81
+
The ``` remoteStoreName ``` parameter tells the ScaleoutSessionRepository to create objects with the GeoServer notify coherency policy and push creates and updates to a remote store specified by the parameter name. When two ScaleOut StateServer stores are configured for bi-directional pull replication using ScaleOut GeoServer Pro, this enables object updates to be replicated between both stores while allowing synchronized access to the objects.
82
+
83
+
Note, the useLocking parameter must be set to true.
84
+
85
+
Note, ScaleOut GeoServer® Pro is licensed separately from ScaleOut StateServer.
86
+
87
+
Default value: ``` null (unused) ```
88
+
53
89
This library is open source and has dependencies on other ScaleOut
<divclass="block">Default inactive time in minutes for a session.</div>
97
96
</dd>
97
+
<dt><spanclass="memberNameLink"><ahref="org/springframework/session/soss/ScaleoutSessionRepository.html#DEF_REMOTE_READPENDING_RETRIES">DEF_REMOTE_READPENDING_RETRIES</a></span> - Static variable in class org.springframework.session.soss.<ahref="org/springframework/session/soss/ScaleoutSessionRepository.html" title="class in org.springframework.session.soss">ScaleoutSessionRepository</a></dt>
<dt><spanclass="memberNameLink"><ahref="org/springframework/session/soss/ScaleoutSessionRepository.html#DEF_REMOTE_READPENDING_RETRY_INTERVAL">DEF_REMOTE_READPENDING_RETRY_INTERVAL</a></span> - Static variable in class org.springframework.session.soss.<ahref="org/springframework/session/soss/ScaleoutSessionRepository.html" title="class in org.springframework.session.soss">ScaleoutSessionRepository</a></dt>
<dt><spanclass="memberNameLink"><ahref="org/springframework/session/soss/ScaleoutSessionRepository.html#DEF_USE_LOCKING">DEF_USE_LOCKING</a></span> - Static variable in class org.springframework.session.soss.<ahref="org/springframework/session/soss/ScaleoutSessionRepository.html" title="class in org.springframework.session.soss">ScaleoutSessionRepository</a></dt>
99
106
<dd>
100
107
<divclass="block">Default locking value.</div>
@@ -229,7 +236,7 @@ <h2 class="title">S</h2>
229
236
<divclass="block">A <code>SessionRepository</code> implementation that is backed by ScaleOut StateServer's
230
237
NamedCache API.</div>
231
238
</dd>
232
-
<dt><spanclass="memberNameLink"><ahref="org/springframework/session/soss/ScaleoutSessionRepository.html#ScaleoutSessionRepository-java.lang.String-java.time.Duration-boolean-">ScaleoutSessionRepository(String, Duration, boolean)</a></span> - Constructor for class org.springframework.session.soss.<ahref="org/springframework/session/soss/ScaleoutSessionRepository.html" title="class in org.springframework.session.soss">ScaleoutSessionRepository</a></dt>
239
+
<dt><spanclass="memberNameLink"><ahref="org/springframework/session/soss/ScaleoutSessionRepository.html#ScaleoutSessionRepository-java.lang.String-java.time.Duration-boolean-java.lang.String-int-int-">ScaleoutSessionRepository(String, Duration, boolean, String, int, int)</a></span> - Constructor for class org.springframework.session.soss.<ahref="org/springframework/session/soss/ScaleoutSessionRepository.html" title="class in org.springframework.session.soss">ScaleoutSessionRepository</a></dt>
233
240
<dd>
234
241
<divclass="block">Instantiates the ScaleOutSessionRepository.</div>
0 commit comments