Package org.apereo.cas.configuration.model.core.ticket

Class RememberMeAuthenticationProperties

java.lang.Object

org.apereo.cas.configuration.model.core.ticket.RememberMeAuthenticationProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-core-tickets",
                automated=true)
public class RememberMeAuthenticationProperties
extends Object
implements Serializable

This is RememberMeAuthenticationProperties.

Since:

6.4.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RememberMeAuthenticationProperties()

Method Summary

Modifier and Type	Method	Description
String	getSupportedIpAddresses()	Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current client ip (remote) address matches this pattern.
String	getSupportedUserAgents()	Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current user-agent matches this pattern.
String	getTimeToKillInSeconds()	Time in seconds after which remember-me enabled SSO session will be destroyed.
boolean	isEnabled()	Flag to indicate whether remember-me facility is enabled.
RememberMeAuthenticationProperties	setEnabled(boolean enabled)	Flag to indicate whether remember-me facility is enabled.
RememberMeAuthenticationProperties	setSupportedIpAddresses(String supportedIpAddresses)	Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current client ip (remote) address matches this pattern.
RememberMeAuthenticationProperties	setSupportedUserAgents(String supportedUserAgents)	Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current user-agent matches this pattern.
RememberMeAuthenticationProperties	setTimeToKillInSeconds(String timeToKillInSeconds)	Time in seconds after which remember-me enabled SSO session will be destroyed.

Methods inherited from class java.lang.Object

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

Constructor Details

RememberMeAuthenticationProperties

public RememberMeAuthenticationProperties()

Method Details

isEnabled

public boolean isEnabled()

Flag to indicate whether remember-me facility is enabled.

getTimeToKillInSeconds

public String getTimeToKillInSeconds()

Time in seconds after which remember-me enabled SSO session will be destroyed.

getSupportedUserAgents

public String getSupportedUserAgents()

Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current user-agent matches this pattern. If a match is not found, remember-me is ignored. If left undefined, remember-me authentication will proceed with the default CAS behavior.

getSupportedIpAddresses

public String getSupportedIpAddresses()

Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current client ip (remote) address matches this pattern. If a match is not found, remember-me is ignored. If left undefined, remember-me authentication will proceed with the default CAS behavior.

setEnabled

public RememberMeAuthenticationProperties setEnabled(boolean enabled)

Flag to indicate whether remember-me facility is enabled.

Returns:

this.

setTimeToKillInSeconds

public RememberMeAuthenticationProperties setTimeToKillInSeconds(String timeToKillInSeconds)

Time in seconds after which remember-me enabled SSO session will be destroyed.

Returns:

this.

setSupportedUserAgents

public RememberMeAuthenticationProperties setSupportedUserAgents(String supportedUserAgents)

Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current user-agent matches this pattern. If a match is not found, remember-me is ignored. If left undefined, remember-me authentication will proceed with the default CAS behavior.

Returns:

this.

setSupportedIpAddresses

public RememberMeAuthenticationProperties setSupportedIpAddresses(String supportedIpAddresses)

Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current client ip (remote) address matches this pattern. If a match is not found, remember-me is ignored. If left undefined, remember-me authentication will proceed with the default CAS behavior.

Returns:

this.