Package org.apereo.cas.configuration

Class CasConfigurationProperties

java.lang.Object

org.apereo.cas.configuration.CasConfigurationProperties

All Implemented Interfaces:

Serializable

@ConfigurationProperties("cas")
@RequiresModule(name="cas-server-core-api",
                automated=true)
@Validated
public class CasConfigurationProperties
extends Object
implements Serializable

This is CasConfigurationProperties.

Since:

5.0.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	Prefix used for all CAS-specific settings.

Constructor Summary

Constructors

Constructor	Description
CasConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
AcceptableUsagePolicyProperties	getAcceptableUsagePolicy()	AUP settings.
AccessStrategyProperties	getAccessStrategy()	Access Strategy and authorization-related functionality.
AccountManagementRegistrationProperties	getAccountRegistration()	Account registration settings.
AcmeProperties	getAcme()	ACME functionality.
AmazonSecurityTokenServiceProperties	getAmazonSts()	Integration settings for amazon sts.
AuditProperties	getAudit()	Authentication audit functionality.
AuthenticationProperties	getAuthn()	General settings for authentication.
ClearpassProperties	getClearpass()	Clearpass settings.
ConsentProperties	getConsent()	Attribute consent functionality.
CasServerCoreProperties	getCore()	Core internal settings.
CasCustomProperties	getCustom()	Custom properties.
EventsProperties	getEvents()	Authentication events functionality.
GeoLocationProperties	getGeoLocation()	GeoLocation settings.
GoogleAnalyticsProperties	getGoogleAnalytics()	Google Analytics functionality.
GoogleFirebaseCloudMessagingProperties	getGoogleFirebaseMessaging()	Google Firebase Cloud Messaging functionality.
GoogleRecaptchaProperties	getGoogleRecaptcha()	Google reCAPTCHA settings.
CasServerHostProperties	getHost()	Settings that define this CAS host.
HttpClientProperties	getHttpClient()	Http client and outgoing connections settings.
HttpRequestProperties	getHttpWebRequest()	Settings that control filtering of the incoming http requests.
long	getInitializationTime()	Timestamp that indicates the initialization time.
InterruptProperties	getInterrupt()	Interrupt/notification functionality.
DatabaseProperties	getJdbc()	General database and hibernate settings.
LocaleProperties	getLocale()	Locale and internationalization settings.
LoggingProperties	getLogging()	Logging functionality.
LogoutProperties	getLogout()	Logout functionality.
MessageBundleProperties	getMessageBundle()	Message bundles and internationalization functionality.
MonitorProperties	getMonitor()	Monitoring functionality.
PersonDirectoryPrincipalResolverProperties	getPersonDirectory()	Person directory and principal resolution functionality.
RestProperties	getRest()	REST API functionality.
SamlCoreProperties	getSamlCore()	SAML Core functionality and settings.
SamlMetadataUIProperties	getSamlMetadataUi()	SAML Metadata UI settings and parsing.
SamlServiceProviderProperties	getSamlSp()	SAML SP integration settings.
ScimProperties	getScim()	SCIM functionality.
CasServerProperties	getServer()	Settings that define this CAS server instance.
ServiceRegistryProperties	getServiceRegistry()	Service registry functionality.
SlackMessagingProperties	getSlackMessaging()	Slack Messaging functionality.
SingleLogoutProperties	getSlo()	SLO functionality.
SmsProvidersProperties	getSmsProvider()	SMS and Text messaging settings.
SpringCloudConfigurationProperties	getSpring()	Spring cloud configuration settings.
SingleSignOnProperties	getSso()	SSO functionality.
StandaloneConfigurationProperties	getStandalone()	Standalone configuration settings.
TicketGrantingCookieProperties	getTgc()	Ticket-granting cookie settings.
ThemeProperties	getTheme()	UI and theme settings.
TicketProperties	getTicket()	Ticketing functionality.
ViewProperties	getView()	Views and UI functionality.
WarningCookieProperties	getWarningCookie()	Warning cookie settings.
WebflowProperties	getWebflow()	Spring Webflow functionality.
CasConfigurationProperties	setAcceptableUsagePolicy(AcceptableUsagePolicyProperties acceptableUsagePolicy)	AUP settings.
CasConfigurationProperties	setAccessStrategy(AccessStrategyProperties accessStrategy)	Access Strategy and authorization-related functionality.
CasConfigurationProperties	setAccountRegistration(AccountManagementRegistrationProperties accountRegistration)	Account registration settings.
CasConfigurationProperties	setAcme(AcmeProperties acme)	ACME functionality.
CasConfigurationProperties	setAmazonSts(AmazonSecurityTokenServiceProperties amazonSts)	Integration settings for amazon sts.
CasConfigurationProperties	setAudit(AuditProperties audit)	Authentication audit functionality.
CasConfigurationProperties	setAuthn(AuthenticationProperties authn)	General settings for authentication.
CasConfigurationProperties	setClearpass(ClearpassProperties clearpass)	Clearpass settings.
CasConfigurationProperties	setConsent(ConsentProperties consent)	Attribute consent functionality.
CasConfigurationProperties	setCore(CasServerCoreProperties core)	Core internal settings.
CasConfigurationProperties	setCustom(CasCustomProperties custom)	Custom properties.
CasConfigurationProperties	setEvents(EventsProperties events)	Authentication events functionality.
CasConfigurationProperties	setGeoLocation(GeoLocationProperties geoLocation)	GeoLocation settings.
CasConfigurationProperties	setGoogleAnalytics(GoogleAnalyticsProperties googleAnalytics)	Google Analytics functionality.
CasConfigurationProperties	setGoogleFirebaseMessaging(GoogleFirebaseCloudMessagingProperties googleFirebaseMessaging)	Google Firebase Cloud Messaging functionality.
CasConfigurationProperties	setGoogleRecaptcha(GoogleRecaptchaProperties googleRecaptcha)	Google reCAPTCHA settings.
CasConfigurationProperties	setHost(CasServerHostProperties host)	Settings that define this CAS host.
CasConfigurationProperties	setHttpClient(HttpClientProperties httpClient)	Http client and outgoing connections settings.
CasConfigurationProperties	setHttpWebRequest(HttpRequestProperties httpWebRequest)	Settings that control filtering of the incoming http requests.
CasConfigurationProperties	setInitializationTime(long initializationTime)	Timestamp that indicates the initialization time.
CasConfigurationProperties	setInterrupt(InterruptProperties interrupt)	Interrupt/notification functionality.
CasConfigurationProperties	setJdbc(DatabaseProperties jdbc)	General database and hibernate settings.
CasConfigurationProperties	setLocale(LocaleProperties locale)	Locale and internationalization settings.
CasConfigurationProperties	setLogging(LoggingProperties logging)	Logging functionality.
CasConfigurationProperties	setLogout(LogoutProperties logout)	Logout functionality.
CasConfigurationProperties	setMessageBundle(MessageBundleProperties messageBundle)	Message bundles and internationalization functionality.
CasConfigurationProperties	setMonitor(MonitorProperties monitor)	Monitoring functionality.
CasConfigurationProperties	setPersonDirectory(PersonDirectoryPrincipalResolverProperties personDirectory)	Person directory and principal resolution functionality.
CasConfigurationProperties	setRest(RestProperties rest)	REST API functionality.
CasConfigurationProperties	setSamlCore(SamlCoreProperties samlCore)	SAML Core functionality and settings.
CasConfigurationProperties	setSamlMetadataUi(SamlMetadataUIProperties samlMetadataUi)	SAML Metadata UI settings and parsing.
CasConfigurationProperties	setSamlSp(SamlServiceProviderProperties samlSp)	SAML SP integration settings.
CasConfigurationProperties	setScim(ScimProperties scim)	SCIM functionality.
CasConfigurationProperties	setServer(CasServerProperties server)	Settings that define this CAS server instance.
CasConfigurationProperties	setServiceRegistry(ServiceRegistryProperties serviceRegistry)	Service registry functionality.
CasConfigurationProperties	setSlackMessaging(SlackMessagingProperties slackMessaging)	Slack Messaging functionality.
CasConfigurationProperties	setSlo(SingleLogoutProperties slo)	SLO functionality.
CasConfigurationProperties	setSmsProvider(SmsProvidersProperties smsProvider)	SMS and Text messaging settings.
CasConfigurationProperties	setSpring(SpringCloudConfigurationProperties spring)	Spring cloud configuration settings.
CasConfigurationProperties	setSso(SingleSignOnProperties sso)	SSO functionality.
CasConfigurationProperties	setStandalone(StandaloneConfigurationProperties standalone)	Standalone configuration settings.
CasConfigurationProperties	setTgc(TicketGrantingCookieProperties tgc)	Ticket-granting cookie settings.
CasConfigurationProperties	setTheme(ThemeProperties theme)	UI and theme settings.
CasConfigurationProperties	setTicket(TicketProperties ticket)	Ticketing functionality.
CasConfigurationProperties	setView(ViewProperties view)	Views and UI functionality.
CasConfigurationProperties	setWarningCookie(WarningCookieProperties warningCookie)	Warning cookie settings.
CasConfigurationProperties	setWebflow(WebflowProperties webflow)	Spring Webflow functionality.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

Prefix used for all CAS-specific settings.

See Also:

• Constant Field Values

Constructor Details

CasConfigurationProperties

public CasConfigurationProperties()

Method Details

getInitializationTime

public long getInitializationTime()

Timestamp that indicates the initialization time.

getLogging

public LoggingProperties getLogging()

Logging functionality.

getInterrupt

public InterruptProperties getInterrupt()

Interrupt/notification functionality.

getConsent

public ConsentProperties getConsent()

Attribute consent functionality.

getAccessStrategy

public AccessStrategyProperties getAccessStrategy()

Access Strategy and authorization-related functionality.

getAcme

public AcmeProperties getAcme()

ACME functionality.

getScim

public ScimProperties getScim()

SCIM functionality.

getAuthn

public AuthenticationProperties getAuthn()

General settings for authentication.

getAudit

public AuditProperties getAudit()

Authentication audit functionality.

getHttpClient

public HttpClientProperties getHttpClient()

Http client and outgoing connections settings.

getPersonDirectory

public PersonDirectoryPrincipalResolverProperties getPersonDirectory()

Person directory and principal resolution functionality.

getEvents

public EventsProperties getEvents()

Authentication events functionality.

getMonitor

public MonitorProperties getMonitor()

Monitoring functionality.

getHost

public CasServerHostProperties getHost()

Settings that define this CAS host.

getLogout

public LogoutProperties getLogout()

Logout functionality.

getRest

public RestProperties getRest()

REST API functionality.

getServer

public CasServerProperties getServer()

Settings that define this CAS server instance.

getServiceRegistry

public ServiceRegistryProperties getServiceRegistry()

Service registry functionality.

getSlo

public SingleLogoutProperties getSlo()

SLO functionality.

getSso

public SingleSignOnProperties getSso()

SSO functionality.

getTicket

public TicketProperties getTicket()

Ticketing functionality.

getMessageBundle

public MessageBundleProperties getMessageBundle()

Message bundles and internationalization functionality.

getHttpWebRequest

public HttpRequestProperties getHttpWebRequest()

Settings that control filtering of the incoming http requests.

getView

public ViewProperties getView()

Views and UI functionality.

getGoogleAnalytics

public GoogleAnalyticsProperties getGoogleAnalytics()

Google Analytics functionality.

getGoogleFirebaseMessaging

public GoogleFirebaseCloudMessagingProperties getGoogleFirebaseMessaging()

Google Firebase Cloud Messaging functionality.

getSlackMessaging

public SlackMessagingProperties getSlackMessaging()

Slack Messaging functionality.

getGoogleRecaptcha

public GoogleRecaptchaProperties getGoogleRecaptcha()

Google reCAPTCHA settings.

getSmsProvider

public SmsProvidersProperties getSmsProvider()

SMS and Text messaging settings.

getAcceptableUsagePolicy

public AcceptableUsagePolicyProperties getAcceptableUsagePolicy()

AUP settings.

getClearpass

public ClearpassProperties getClearpass()

Clearpass settings.

getTgc

public TicketGrantingCookieProperties getTgc()

Ticket-granting cookie settings.

getWarningCookie

public WarningCookieProperties getWarningCookie()

Warning cookie settings.

getGeoLocation

public GeoLocationProperties getGeoLocation()

GeoLocation settings.

getSamlSp

public SamlServiceProviderProperties getSamlSp()

SAML SP integration settings.

getJdbc

public DatabaseProperties getJdbc()

General database and hibernate settings.

getAmazonSts

public AmazonSecurityTokenServiceProperties getAmazonSts()

Integration settings for amazon sts.

getSamlMetadataUi

public SamlMetadataUIProperties getSamlMetadataUi()

SAML Metadata UI settings and parsing.

getSamlCore

public SamlCoreProperties getSamlCore()

SAML Core functionality and settings.

getTheme

public ThemeProperties getTheme()

UI and theme settings.

getLocale

public LocaleProperties getLocale()

Locale and internationalization settings.

getWebflow

public WebflowProperties getWebflow()

Spring Webflow functionality.

getCustom

public CasCustomProperties getCustom()

Custom properties.

getStandalone

public StandaloneConfigurationProperties getStandalone()

Standalone configuration settings.

getSpring

public SpringCloudConfigurationProperties getSpring()

Spring cloud configuration settings.

getAccountRegistration

public AccountManagementRegistrationProperties getAccountRegistration()

Account registration settings.

getCore

public CasServerCoreProperties getCore()

Core internal settings.

setInitializationTime

public CasConfigurationProperties setInitializationTime(long initializationTime)

Timestamp that indicates the initialization time.

Returns:

this.

setLogging

public CasConfigurationProperties setLogging(LoggingProperties logging)

Logging functionality.

Returns:

this.

setInterrupt

public CasConfigurationProperties setInterrupt(InterruptProperties interrupt)

Interrupt/notification functionality.

Returns:

this.

setConsent

public CasConfigurationProperties setConsent(ConsentProperties consent)

Attribute consent functionality.

Returns:

this.

setAccessStrategy

public CasConfigurationProperties setAccessStrategy(AccessStrategyProperties accessStrategy)

Access Strategy and authorization-related functionality.

Returns:

this.

setAcme

public CasConfigurationProperties setAcme(AcmeProperties acme)

ACME functionality.

Returns:

this.

setScim

public CasConfigurationProperties setScim(ScimProperties scim)

SCIM functionality.

Returns:

this.

setAuthn

public CasConfigurationProperties setAuthn(AuthenticationProperties authn)

General settings for authentication.

Returns:

this.

setAudit

public CasConfigurationProperties setAudit(AuditProperties audit)

Authentication audit functionality.

Returns:

this.

setHttpClient

public CasConfigurationProperties setHttpClient(HttpClientProperties httpClient)

Http client and outgoing connections settings.

Returns:

this.

setPersonDirectory

public CasConfigurationProperties setPersonDirectory(PersonDirectoryPrincipalResolverProperties personDirectory)

Person directory and principal resolution functionality.

Returns:

this.

setEvents

public CasConfigurationProperties setEvents(EventsProperties events)

Authentication events functionality.

Returns:

this.

setMonitor

public CasConfigurationProperties setMonitor(MonitorProperties monitor)

Monitoring functionality.

Returns:

this.

setHost

public CasConfigurationProperties setHost(CasServerHostProperties host)

Settings that define this CAS host.

Returns:

this.

setLogout

public CasConfigurationProperties setLogout(LogoutProperties logout)

Logout functionality.

Returns:

this.

setRest

public CasConfigurationProperties setRest(RestProperties rest)

REST API functionality.

Returns:

this.

setServer

public CasConfigurationProperties setServer(CasServerProperties server)

Settings that define this CAS server instance.

Returns:

this.

setServiceRegistry

public CasConfigurationProperties setServiceRegistry(ServiceRegistryProperties serviceRegistry)

Service registry functionality.

Returns:

this.

setSlo

public CasConfigurationProperties setSlo(SingleLogoutProperties slo)

SLO functionality.

Returns:

this.

setSso

public CasConfigurationProperties setSso(SingleSignOnProperties sso)

SSO functionality.

Returns:

this.

setTicket

public CasConfigurationProperties setTicket(TicketProperties ticket)

Ticketing functionality.

Returns:

this.

setMessageBundle

public CasConfigurationProperties setMessageBundle(MessageBundleProperties messageBundle)

Message bundles and internationalization functionality.

Returns:

this.

setHttpWebRequest

public CasConfigurationProperties setHttpWebRequest(HttpRequestProperties httpWebRequest)

Settings that control filtering of the incoming http requests.

Returns:

this.

setView

public CasConfigurationProperties setView(ViewProperties view)

Views and UI functionality.

Returns:

this.

setGoogleAnalytics

public CasConfigurationProperties setGoogleAnalytics(GoogleAnalyticsProperties googleAnalytics)

Google Analytics functionality.

Returns:

this.

setGoogleFirebaseMessaging

public CasConfigurationProperties setGoogleFirebaseMessaging(GoogleFirebaseCloudMessagingProperties googleFirebaseMessaging)

Google Firebase Cloud Messaging functionality.

Returns:

this.

setSlackMessaging

public CasConfigurationProperties setSlackMessaging(SlackMessagingProperties slackMessaging)

Slack Messaging functionality.

Returns:

this.

setGoogleRecaptcha

public CasConfigurationProperties setGoogleRecaptcha(GoogleRecaptchaProperties googleRecaptcha)

Google reCAPTCHA settings.

Returns:

this.

setSmsProvider

public CasConfigurationProperties setSmsProvider(SmsProvidersProperties smsProvider)

SMS and Text messaging settings.

Returns:

this.

setAcceptableUsagePolicy

public CasConfigurationProperties setAcceptableUsagePolicy(AcceptableUsagePolicyProperties acceptableUsagePolicy)

AUP settings.

Returns:

this.

setClearpass

public CasConfigurationProperties setClearpass(ClearpassProperties clearpass)

Clearpass settings.

Returns:

this.

setTgc

public CasConfigurationProperties setTgc(TicketGrantingCookieProperties tgc)

Ticket-granting cookie settings.

Returns:

this.

setWarningCookie

public CasConfigurationProperties setWarningCookie(WarningCookieProperties warningCookie)

Warning cookie settings.

Returns:

this.

setGeoLocation

public CasConfigurationProperties setGeoLocation(GeoLocationProperties geoLocation)

GeoLocation settings.

Returns:

this.

setSamlSp

public CasConfigurationProperties setSamlSp(SamlServiceProviderProperties samlSp)

SAML SP integration settings.

Returns:

this.

setJdbc

public CasConfigurationProperties setJdbc(DatabaseProperties jdbc)

General database and hibernate settings.

Returns:

this.

setAmazonSts

public CasConfigurationProperties setAmazonSts(AmazonSecurityTokenServiceProperties amazonSts)

Integration settings for amazon sts.

Returns:

this.

setSamlMetadataUi

public CasConfigurationProperties setSamlMetadataUi(SamlMetadataUIProperties samlMetadataUi)

SAML Metadata UI settings and parsing.

Returns:

this.

setSamlCore

public CasConfigurationProperties setSamlCore(SamlCoreProperties samlCore)

SAML Core functionality and settings.

Returns:

this.

setTheme

public CasConfigurationProperties setTheme(ThemeProperties theme)

UI and theme settings.

Returns:

this.

setLocale

public CasConfigurationProperties setLocale(LocaleProperties locale)

Locale and internationalization settings.

Returns:

this.

setWebflow

public CasConfigurationProperties setWebflow(WebflowProperties webflow)

Spring Webflow functionality.

Returns:

this.

setCustom

public CasConfigurationProperties setCustom(CasCustomProperties custom)

Custom properties.

Returns:

this.

setStandalone

public CasConfigurationProperties setStandalone(StandaloneConfigurationProperties standalone)

Standalone configuration settings.

Returns:

this.

setSpring

public CasConfigurationProperties setSpring(SpringCloudConfigurationProperties spring)

Spring cloud configuration settings.

Returns:

this.

setAccountRegistration

public CasConfigurationProperties setAccountRegistration(AccountManagementRegistrationProperties accountRegistration)

Account registration settings.

Returns:

this.

setCore

public CasConfigurationProperties setCore(CasServerCoreProperties core)

Core internal settings.

Returns:

this.