MongoDb Authentication Events
Stores authentication events into a MongoDb NoSQL database.
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-events-mongo</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-events-mongo:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-events-mongo"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-events-mongo"
}
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.events.mongo.client-uri=
The connection uri to the mongodb instance. This typically takes on the form of
CAS Property:
|
1 |
cas.events.mongo.client-uri=... |
1
cas:
events:
mongo:
client-uri: "..."
1
java -Dcas.events.mongo.client-uri="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_CLIENT_URI="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.client-uri="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.collection=
MongoDb database collection name to fetch and/or create.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.collection
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.collection=...
1
cas:
events:
mongo:
collection: "..."
1
java -Dcas.events.mongo.collection="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_COLLECTION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.collection="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.database-name=
MongoDb database instance name.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.database-name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.database-name=...
1
cas:
events:
mongo:
database-name: "..."
1
java -Dcas.events.mongo.database-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_DATABASE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.database-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.host=localhost
MongoDb database host for authentication. Multiple host addresses may be defined, separated by comma. If more than one host is defined, it is assumed that each host contains the port as well, if any. Otherwise the configuration may fallback onto the port defined.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.host
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.host=localhost
1
cas:
events:
mongo:
host: "localhost"
1
java -Dcas.events.mongo.host="localhost" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_HOST="localhost"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.host="localhost"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.password=
MongoDb database password for authentication.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.password
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.password=...
1
cas:
events:
mongo:
password: "..."
1
java -Dcas.events.mongo.password="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_PASSWORD="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.port=27017
MongoDb database port.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.port
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.port=27017
1
cas:
events:
mongo:
port: "27017"
1
java -Dcas.events.mongo.port="27017" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_PORT="27017"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.port="27017"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.user-id=
MongoDb database user for authentication.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.user-id
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.user-id=...
1
cas:
events:
mongo:
user-id: "..."
1
java -Dcas.events.mongo.user-id="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_USER_ID="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.user-id="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.authentication-database-name=
Name of the database to use for authentication.
CAS Property:
|
1 |
cas.events.mongo.authentication-database-name=... |
1
cas:
events:
mongo:
authentication-database-name: "..."
1
java -Dcas.events.mongo.authentication-database-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_AUTHENTICATION_DATABASE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.authentication-database-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.drop-collection=false
Whether collections should be dropped on startup and re-created.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.drop-collection
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.drop-collection=...
1
cas:
events:
mongo:
drop-collection: "..."
1
java -Dcas.events.mongo.drop-collection="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_DROP_COLLECTION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.drop-collection="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.read-concern=AVAILABLE
Read concern. Accepted values are:
LOCAL
MAJORITY
LINEARIZABLE
SNAPSHOT
AVAILABLE
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.read-concern
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.read-concern=AVAILABLE
1
cas:
events:
mongo:
read-concern: "AVAILABLE"
1
java -Dcas.events.mongo.read-concern="AVAILABLE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_READ_CONCERN="AVAILABLE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.read-concern="AVAILABLE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.read-preference=PRIMARY
Read preference. Accepted values are:
PRIMARY
SECONDARY
SECONDARY_PREFERRED
PRIMARY_PREFERRED
NEAREST
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.read-preference
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.read-preference=PRIMARY
1
cas:
events:
mongo:
read-preference: "PRIMARY"
1
java -Dcas.events.mongo.read-preference="PRIMARY" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_READ_PREFERENCE="PRIMARY"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.read-preference="PRIMARY"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.replica-set=
A replica set in MongoDB is a group of mongod
processes that maintain the same data set. Replica sets provide redundancy and high availability, and are the basis for all production deployments.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.replica-set
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.replica-set=...
1
cas:
events:
mongo:
replica-set: "..."
1
java -Dcas.events.mongo.replica-set="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_REPLICA_SET="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.replica-set="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.retry-writes=false
Sets whether writes should be retried if they fail due to a network error.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.retry-writes
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.retry-writes=...
1
cas:
events:
mongo:
retry-writes: "..."
1
java -Dcas.events.mongo.retry-writes="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_RETRY_WRITES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.retry-writes="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.socket-keep-alive=false
Whether the database socket connection should be tagged with keep-alive.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.socket-keep-alive
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.socket-keep-alive=...
1
cas:
events:
mongo:
socket-keep-alive: "..."
1
java -Dcas.events.mongo.socket-keep-alive="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_SOCKET_KEEP_ALIVE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.socket-keep-alive="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.ssl-enabled=false
Whether connections require SSL.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.ssl-enabled
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.ssl-enabled=...
1
cas:
events:
mongo:
ssl-enabled: "..."
1
java -Dcas.events.mongo.ssl-enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_SSL_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.ssl-enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.timeout=PT5S
MongoDb database connection timeout.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.timeout
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.timeout=PT5S
1
cas:
events:
mongo:
timeout: "PT5S"
1
java -Dcas.events.mongo.timeout="PT5S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_TIMEOUT="PT5S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.timeout="PT5S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.write-concern=ACKNOWLEDGED
Write concern describes the level of acknowledgement requested from MongoDB for write operations to a standalone mongo db or to replica sets or to sharded clusters. In sharded clusters, mongo db instances will pass the write concern on to the shards.
org.apereo.cas.configuration.model.core.events.MongoDbEventsProperties.
CAS Property: cas.events.mongo.write-concern
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.write-concern=ACKNOWLEDGED
1
cas:
events:
mongo:
write-concern: "ACKNOWLEDGED"
1
java -Dcas.events.mongo.write-concern="ACKNOWLEDGED" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_WRITE_CONCERN="ACKNOWLEDGED"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.write-concern="ACKNOWLEDGED"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.pool.idle-time=PT30S
The maximum idle time of a pooled connection. A zero value indicates no limit to the idle time. A pooled connection that has exceeded its idle time will be closed and replaced when necessary by a new connection.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
CAS Property: cas.events.mongo.pool.idle-time
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.pool.idle-time=PT30S
1
cas:
events:
mongo:
pool:
idle-time: "PT30S"
1
java -Dcas.events.mongo.pool.idle-time="PT30S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_POOL_IDLE_TIME="PT30S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.pool.idle-time="PT30S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.pool.life-time=PT60S
The maximum time a pooled connection can live for. A zero value indicates no limit to the life time. A pooled connection that has exceeded its life time will be closed and replaced when necessary by a new connection.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
CAS Property: cas.events.mongo.pool.life-time
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.pool.life-time=PT60S
1
cas:
events:
mongo:
pool:
life-time: "PT60S"
1
java -Dcas.events.mongo.pool.life-time="PT60S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_POOL_LIFE_TIME="PT60S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.pool.life-time="PT60S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.pool.max-size=10
Maximum number of connections to keep around.
org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
CAS Property: cas.events.mongo.pool.max-size
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.pool.max-size=10
1
cas:
events:
mongo:
pool:
max-size: "10"
1
java -Dcas.events.mongo.pool.max-size="10" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_POOL_MAX_SIZE="10"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.pool.max-size="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.pool.max-wait-time=PT60S
The maximum time that a thread may wait for a connection to become available.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
CAS Property: cas.events.mongo.pool.max-wait-time
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.pool.max-wait-time=PT60S
1
cas:
events:
mongo:
pool:
max-wait-time: "PT60S"
1
java -Dcas.events.mongo.pool.max-wait-time="PT60S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_POOL_MAX_WAIT_TIME="PT60S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.pool.max-wait-time="PT60S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.pool.min-size=1
Minimum number of connections to keep around.
org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
CAS Property: cas.events.mongo.pool.min-size
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.pool.min-size=1
1
cas:
events:
mongo:
pool:
min-size: "1"
1
java -Dcas.events.mongo.pool.min-size="1" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_POOL_MIN_SIZE="1"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.pool.min-size="1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.events.mongo.pool.per-host=10
Total number of connections allowed per host.
org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
CAS Property: cas.events.mongo.pool.per-host
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.events.mongo.pool.per-host=10
1
cas:
events:
mongo:
pool:
per-host: "10"
1
java -Dcas.events.mongo.pool.per-host="10" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_EVENTS_MONGO_POOL_PER_HOST="10"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.events.mongo.pool.per-host="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.