Package org.apereo.cas.configuration.model.support.cookie

Class TicketGrantingCookieProperties

java.lang.Object

org.apereo.cas.configuration.model.support.cookie.CookieProperties

org.apereo.cas.configuration.model.support.cookie.PinnableCookieProperties

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-core-cookie",
                automated=true)
public class TicketGrantingCookieProperties
extends PinnableCookieProperties

Configuration properties class for tgc.

Since:

5.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

CasFeatureModule.FeatureCatalog

Constructor Summary

Constructors

Constructor	Description
TicketGrantingCookieProperties()

Method Summary

Modifier and Type	Method	Description
EncryptionJwtSigningJwtCryptographyProperties	getCrypto()	Crypto settings that determine how the cookie should be signed and encrypted.
String	getRememberMeMaxAge()	If remember-me is enabled, specifies the maximum age of the cookie.
boolean	isAutoConfigureCookiePath()	Decide if cookie paths should be automatically configured based on the application context path, when the cookie path is not configured.
TicketGrantingCookieProperties	setAutoConfigureCookiePath(boolean autoConfigureCookiePath)	Decide if cookie paths should be automatically configured based on the application context path, when the cookie path is not configured.
TicketGrantingCookieProperties	setCrypto(EncryptionJwtSigningJwtCryptographyProperties crypto)	Crypto settings that determine how the cookie should be signed and encrypted.
TicketGrantingCookieProperties	setRememberMeMaxAge(String rememberMeMaxAge)	If remember-me is enabled, specifies the maximum age of the cookie.

Methods inherited from class org.apereo.cas.configuration.model.support.cookie.PinnableCookieProperties

getAllowedIpAddressesPattern, isGeoLocateClientSession, isPinToSession, setAllowedIpAddressesPattern, setGeoLocateClientSession, setPinToSession

Methods inherited from class org.apereo.cas.configuration.model.support.cookie.CookieProperties

getDomain, getMaxAge, getName, getPath, getSameSitePolicy, isHttpOnly, isSecure, setDomain, setHttpOnly, setMaxAge, setName, setPath, setSameSitePolicy, setSecure

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

isDefined, isUndefined

Constructor Details

TicketGrantingCookieProperties

public TicketGrantingCookieProperties()

Method Details

getRememberMeMaxAge

public String getRememberMeMaxAge()

If remember-me is enabled, specifies the maximum age of the cookie.

isAutoConfigureCookiePath

public boolean isAutoConfigureCookiePath()

Decide if cookie paths should be automatically configured based on the application context path, when the cookie path is not configured.

getCrypto

public EncryptionJwtSigningJwtCryptographyProperties getCrypto()

Crypto settings that determine how the cookie should be signed and encrypted.

setRememberMeMaxAge

public TicketGrantingCookieProperties setRememberMeMaxAge(String rememberMeMaxAge)

If remember-me is enabled, specifies the maximum age of the cookie.

Returns:

this.

setAutoConfigureCookiePath

public TicketGrantingCookieProperties setAutoConfigureCookiePath(boolean autoConfigureCookiePath)

Decide if cookie paths should be automatically configured based on the application context path, when the cookie path is not configured.

Returns:

this.

setCrypto

public TicketGrantingCookieProperties setCrypto(EncryptionJwtSigningJwtCryptographyProperties crypto)

Crypto settings that determine how the cookie should be signed and encrypted.

Returns:

this.