Package org.apereo.cas.configuration.model.core.web.flow

Class WebflowServerSessionsProperties

java.lang.Object

org.apereo.cas.configuration.model.core.web.flow.WebflowServerSessionsProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-core-webflow")
public class WebflowServerSessionsProperties
extends Object
implements Serializable

This is WebflowServerSessionsProperties.

Since:

5.2.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebflowServerSessionsProperties()

Method Summary

Modifier and Type	Method	Description
BaseHazelcastProperties	getHazelcast()	If sessions are to be replicated via Hazelcast, controls and defines how state should be replicated.
String	getLockTimeout()	Sets the time period that can elapse before a timeout occurs on an attempt to acquire a conversation lock.
int	getMaxConversations()	Using the maxConversations property, you can limit the number of concurrently active conversations allowed in a single session.
boolean	isCompress()	Whether or not the snapshots should be compressed.
WebflowServerSessionsProperties	setCompress(boolean compress)	Whether or not the snapshots should be compressed.
WebflowServerSessionsProperties	setHazelcast(BaseHazelcastProperties hazelcast)	If sessions are to be replicated via Hazelcast, controls and defines how state should be replicated.
WebflowServerSessionsProperties	setLockTimeout(String lockTimeout)	Sets the time period that can elapse before a timeout occurs on an attempt to acquire a conversation lock.
WebflowServerSessionsProperties	setMaxConversations(int maxConversations)	Using the maxConversations property, you can limit the number of concurrently active conversations allowed in a single session.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebflowServerSessionsProperties

public WebflowServerSessionsProperties()

Method Details

getLockTimeout

public String getLockTimeout()

Sets the time period that can elapse before a timeout occurs on an attempt to acquire a conversation lock. The default is 30 seconds. Only relevant if session storage is done on the server.

getMaxConversations

public int getMaxConversations()

Using the maxConversations property, you can limit the number of concurrently active conversations allowed in a single session. If the maximum is exceeded, the conversation manager will automatically end the oldest conversation. The default is 5, which should be fine for most situations. Set it to -1 for no limit. Setting maxConversations to 1 allows easy resource cleanup in situations where there should only be one active conversation per session. Only relevant if session storage is done on the server.

isCompress

public boolean isCompress()

Whether or not the snapshots should be compressed. Only relevant if session storage is done on the server.

getHazelcast

public BaseHazelcastProperties getHazelcast()

If sessions are to be replicated via Hazelcast, controls and defines how state should be replicated. Only relevant if session storage is done on the server.

setLockTimeout

public WebflowServerSessionsProperties setLockTimeout(String lockTimeout)

Sets the time period that can elapse before a timeout occurs on an attempt to acquire a conversation lock. The default is 30 seconds. Only relevant if session storage is done on the server.

Returns:

this.

setMaxConversations

public WebflowServerSessionsProperties setMaxConversations(int maxConversations)

Using the maxConversations property, you can limit the number of concurrently active conversations allowed in a single session. If the maximum is exceeded, the conversation manager will automatically end the oldest conversation. The default is 5, which should be fine for most situations. Set it to -1 for no limit. Setting maxConversations to 1 allows easy resource cleanup in situations where there should only be one active conversation per session. Only relevant if session storage is done on the server.

Returns:

this.

setCompress

public WebflowServerSessionsProperties setCompress(boolean compress)

Whether or not the snapshots should be compressed. Only relevant if session storage is done on the server.

Returns:

this.

setHazelcast

public WebflowServerSessionsProperties setHazelcast(BaseHazelcastProperties hazelcast)

If sessions are to be replicated via Hazelcast, controls and defines how state should be replicated. Only relevant if session storage is done on the server.

Returns:

this.