Spring/spring-session-data-geode
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Edit Javadoc to include the configuraiton properties.

Browse Source
This commit is contained in:
John Blum
2018-08-10 16:05:44 -07:00
parent bd9db4a8c0
commit b7f90d84cf
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
spring-session-data-geode/src/main/java/org/springframework/session/data/gemfire/config/annotation/web/http/EnableGemFireHttpSession.java
View File

@@ -97,6 +97,9 @@ public @interface EnableGemFireHttpSession {
*
* Defaults to {@link ClientRegionShortcut#PROXY}.
*
* Use the {@literal spring.session.data.gemfire.cache.client.region.shortcut} in Spring Boot
* {@literal application.properties}.
*
* @return a {@link ClientRegionShortcut} used to configure the {@link ClientCache} {@link Region}
* data management policy.
* @see org.apache.geode.cache.client.ClientRegionShortcut
@@ -111,6 +114,9 @@ public @interface EnableGemFireHttpSession {
*
* Defaults to empty {@link String} array.
*
* Use the {@literal spring.session.data.gemfire.session.attributes.indexable} in Spring Boot
* {@literal application.properties}.
*
* @return an array of {@link String Strings} identifying the names of {@link Session} attributes to index.
*/
String[] indexableSessionAttributes() default {};
@@ -120,6 +126,9 @@ public @interface EnableGemFireHttpSession {
*
* Defaults to {@literal 1800} seconds, or {@literal 30} minutes.
*
* Use the {@literal spring.session.data.gemfire.session.expiration.max-inactive-interval-seconds} in Spring Boot
* {@literal application.properties}.
*
* @return an integer value defining the maximum inactive interval in seconds before the {@link Session} expires.
*/
int maxInactiveIntervalInSeconds() default 1800;
@@ -132,6 +141,9 @@ public @interface EnableGemFireHttpSession {
*
* Defaults to {@literal gemfirePool}.
*
* Use the {@literal spring.session.data.gemfire.cache.client.pool.name} in Spring Boot
* {@literal application.properties}.
*
* @return the name of the {@link Pool} used by the {@link ClientCache} {@link Region}
* to send {@link Session} state to the cluster of servers.
* @see org.springframework.session.data.gemfire.config.annotation.web.http.GemFireHttpSessionConfiguration#DEFAULT_POOL_NAME
@@ -143,6 +155,9 @@ public @interface EnableGemFireHttpSession {
*
* Defaults to {@literal ClusteredSpringSessions}.
*
* Use the {@literal spring.session.data.gemfire.session.region.name} in Spring Boot
* {@literal application.properties}.
*
* @return a {@link String} specifying the name of the (client)cache {@link Region}
* used to store {@link Session} state.
* @see org.springframework.session.data.gemfire.config.annotation.web.http.GemFireHttpSessionConfiguration#DEFAULT_SESSION_REGION_NAME
@@ -154,6 +169,9 @@ public @interface EnableGemFireHttpSession {
*
* Defaults to {@link RegionShortcut#PARTITION}.
*
* Use the {@literal spring.session.data.gemfire.cache.server.region.shortcut} in Spring Boot
* {@literal application.properties}.
*
* @return a {@link RegionShortcut} used to specify and configure the {@link Cache} {@link Region}
* data management policy.
* @see org.apache.geode.cache.RegionShortcut
@@ -168,6 +186,9 @@ public @interface EnableGemFireHttpSession {
*
* Defaults to {@literal SessionPdxSerializer}.
*
* Use the {@literal spring.session.data.gemfire.session.serializer.bean-name} in Spring Boot
* {@literal application.properties}.
*
* @return a {@link String} containing the bean name of the configured {@link SessionSerializer}.
* @see org.springframework.session.data.gemfire.serialization.pdx.provider.PdxSerializableSessionSerializer
* @see org.springframework.session.data.gemfire.serialization.SessionSerializer