Package org.apereo.cas.configuration.model.support.mongo.ticketregistry

Class MongoDbTicketRegistryProperties

java.lang.Object

org.apereo.cas.configuration.model.support.mongo.BaseMongoDbProperties

org.apereo.cas.configuration.model.support.mongo.ticketregistry.MongoDbTicketRegistryProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-support-mongo-ticket-registry")
public class MongoDbTicketRegistryProperties
extends BaseMongoDbProperties

This is MongoDbTicketRegistryProperties.

Since:

5.1.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
MongoDbTicketRegistryProperties()

Method Summary

Modifier and Type	Method	Description
EncryptionRandomizedSigningJwtCryptographyProperties	getCrypto()	Crypto settings for the registry.
List<String>	getIndexes()	Index names to create.
boolean	isDropCollection()	Whether collections should be dropped on startup and re-created.
boolean	isDropIndexes()	When updating/creating indexes, decide if existing indexes should all be dropped once prior to creating/updating indexes.
boolean	isUpdateIndexes()	Whether CAS should attempt to create/update indexes automatically and figure out the differences between existing keys and new keys.
MongoDbTicketRegistryProperties	setCrypto(EncryptionRandomizedSigningJwtCryptographyProperties crypto)	Crypto settings for the registry.
MongoDbTicketRegistryProperties	setDropCollection(boolean dropCollection)	Whether collections should be dropped on startup and re-created.
MongoDbTicketRegistryProperties	setDropIndexes(boolean dropIndexes)	When updating/creating indexes, decide if existing indexes should all be dropped once prior to creating/updating indexes.
MongoDbTicketRegistryProperties	setIndexes(List<String> indexes)	Index names to create.
MongoDbTicketRegistryProperties	setUpdateIndexes(boolean updateIndexes)	Whether CAS should attempt to create/update indexes automatically and figure out the differences between existing keys and new keys.

Methods inherited from class org.apereo.cas.configuration.model.support.mongo.BaseMongoDbProperties

getAuthenticationDatabaseName, getClientUri, getDatabaseName, getHost, getPassword, getPool, getPort, getReadConcern, getReadPreference, getReplicaSet, getTimeout, getUserId, getWriteConcern, isRetryWrites, isSocketKeepAlive, isSslEnabled, setAuthenticationDatabaseName, setClientUri, setDatabaseName, setHost, setPassword, setPool, setPort, setReadConcern, setReadPreference, setReplicaSet, setRetryWrites, setSocketKeepAlive, setSslEnabled, setTimeout, setUserId, setWriteConcern

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

MongoDbTicketRegistryProperties

public MongoDbTicketRegistryProperties()

Method Details

isDropCollection

public boolean isDropCollection()

Whether collections should be dropped on startup and re-created.

isUpdateIndexes

public boolean isUpdateIndexes()

Whether CAS should attempt to create/update indexes automatically and figure out the differences between existing keys and new keys.

isDropIndexes

public boolean isDropIndexes()

When updating/creating indexes, decide if existing indexes should all be dropped once prior to creating/updating indexes. This may be useful to avoid conflicts between old and new indexes, in scenarios where CAS may be unable to locate the proper difference in index options or names during upgrades..

getIndexes

public List<String> getIndexes()

Index names to create. By default, all indexes are created. Supported indexes are:

• IDX_ID: index created for ticket identifiers.
• IDX_JSON_TYPE_ID: compound index for ticket body, type and id used for text queries.
• IDX_PRINCIPAL: index created for principal attached to the ticket.
• IDX_EXPIRATION: index created for ticket expiration date.

getCrypto

public EncryptionRandomizedSigningJwtCryptographyProperties getCrypto()

Crypto settings for the registry.

setDropCollection

public MongoDbTicketRegistryProperties setDropCollection(boolean dropCollection)

Whether collections should be dropped on startup and re-created.

Returns:

this.

setUpdateIndexes

public MongoDbTicketRegistryProperties setUpdateIndexes(boolean updateIndexes)

Whether CAS should attempt to create/update indexes automatically and figure out the differences between existing keys and new keys.

Returns:

this.

setDropIndexes

public MongoDbTicketRegistryProperties setDropIndexes(boolean dropIndexes)

When updating/creating indexes, decide if existing indexes should all be dropped once prior to creating/updating indexes. This may be useful to avoid conflicts between old and new indexes, in scenarios where CAS may be unable to locate the proper difference in index options or names during upgrades..

Returns:

this.

setIndexes

public MongoDbTicketRegistryProperties setIndexes(List<String> indexes)

Index names to create. By default, all indexes are created. Supported indexes are:

• IDX_ID: index created for ticket identifiers.
• IDX_JSON_TYPE_ID: compound index for ticket body, type and id used for text queries.
• IDX_PRINCIPAL: index created for principal attached to the ticket.
• IDX_EXPIRATION: index created for ticket expiration date.

Returns:

this.

setCrypto

public MongoDbTicketRegistryProperties setCrypto(EncryptionRandomizedSigningJwtCryptographyProperties crypto)

Crypto settings for the registry.

Returns:

this.