WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

CosmosDb Service Registry

Stores registered service data in an Azure CosmosDb instance.

Support is enabled by adding the following module into the overlay:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-cosmosdb-service-registry</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-cosmosdb-service-registry:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-cosmosdb-service-registry"
}

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-cosmosdb-service-registry"
}

Configuration

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

cas.service-registry.cosmos-db.container=CasCosmosDbServiceRegistry

Collection to store CAS service definitions.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

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.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.container=CasCosmosDbServiceRegistry

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      container: "CasCosmosDbServiceRegistry"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.container="CasCosmosDbServiceRegistry" -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as 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.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_CONTAINER="CasCosmosDbServiceRegistry"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.container="CasCosmosDbServiceRegistry"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.database=

Database name.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.database=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      database: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.database="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_DATABASE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.database="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.key=

Document Db master key.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.uri=

Document Db host address (i.e. https://localhost:8081).

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.uri=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      uri: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.uri="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_URI="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.uri="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

cas.service-registry.cosmos-db.allow-telemetry=false

Whether telemetry should be enabled by default. Sets the flag to enable client telemetry which will periodically collect database operations aggregation statistics, system information like cpu/memory and send it to cosmos monitoring service, which will be helpful during debugging.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.allow-telemetry=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      allow-telemetry: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.allow-telemetry="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_ALLOW_TELEMETRY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.allow-telemetry="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.consistency-level=SESSION

Document Db consistency level. Azure Cosmos DB is designed from the ground up with global distribution in mind for every data model. It is designed to offer predictable low latency guarantees, a 99.99% availability SLA, and multiple well-defined relaxed consistency models. Currently, Azure Cosmos DB provides five consistency levels: strong, bounded-staleness, session, consistent prefix, and eventual. Besides strong and eventual consistency models commonly offered by distributed databases, Azure Cosmos DB offers three more carefully codified and operationalized consistency models, and has validated their usefulness against real world use cases. These are the bounded staleness, session, and consistent prefix consistency levels. Collectively these five consistency levels enable you to make well-reasoned trade-offs between consistency, availability, and latency. Accepted values are:

STRONG: Linearizability
SESSION: Consistent Prefix. Monotonic reads, monotonic writes, read-your-writes, write-follows-reads
EVENTUAL: Out of order reads
BOUNDED_STALENESS: Consistent Prefix. Reads lag behind writes by k prefixes or t interval
CONSISTENT_PREFIX: Updates returned are some prefix of all the updates, with no gaps

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.consistency-level=SESSION

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      consistency-level: "SESSION"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.consistency-level="SESSION" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_CONSISTENCY_LEVEL="SESSION"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.consistency-level="SESSION"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.create-container=false

Whether collections should be created on startup.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.create-container=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      create-container: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.create-container="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_CREATE_CONTAINER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.create-container="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.database-throughput=4000

The max auto scale throughput.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.database-throughput=4000

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      database-throughput: "4000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.database-throughput="4000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_DATABASE_THROUGHPUT="4000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.database-throughput="4000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.endpoint-discovery-enabled=true

Sets the flag to enable endpoint discovery for geo-replicated database accounts. When EnableEndpointDiscovery is true, the SDK will automatically discover the current write and read regions to ensure requests are sent to the correct region based on the capability of the region and the user's preference.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.endpoint-discovery-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      endpoint-discovery-enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.endpoint-discovery-enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_ENDPOINT_DISCOVERY_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.endpoint-discovery-enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.indexing-mode=NONE

Specifies the supported indexing modes in the Azure Cosmos DB database service. Accepted values are:

CONSISTENT: Index is updated synchronously with a create or update operation. With consistent indexing, query behavior is the same as the default consistency level for the collection. The index is always kept up to date with the data.
LAZY: Index is updated asynchronously with respect to a create or update operation. With lazy indexing, queries are eventually consistent. The index is updated when the collection is idle.
NONE: No index is provided. Setting IndexingMode to "None" drops the index. Use this if you don't want to maintain the index for a document collection, to save the storage cost or improve the write throughput. Your queries will degenerate to scans of the entire collection.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.indexing-mode=NONE

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      indexing-mode: "NONE"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.indexing-mode="NONE" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_INDEXING_MODE="NONE"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.indexing-mode="NONE"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.max-retry-attempts-on-throttled-requests=4

Sets the maximum number of retries in the case where the request fails because the service has applied rate limiting on the client.

When a client is sending requests faster than the allowed rate, the service will return HttpStatusCode 429 (Too Many Request) to throttle the client. The current implementation in the SDK will then wait for the amount of time the service tells it to wait and retry after the time has elapsed.

The default value is 4. This means in the case where the request is throttled, the same request will be issued for a maximum of 5 times to the server before an error is returned to the application.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.max-retry-attempts-on-throttled-requests=4

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      max-retry-attempts-on-throttled-requests: "4"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.max-retry-attempts-on-throttled-requests="4" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_MAX_RETRY_ATTEMPTS_ON_THROTTLED_REQUESTS="4"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.max-retry-attempts-on-throttled-requests="4"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.max-retry-wait-time=PT10S

Sets the maximum retry time in seconds. When a request fails due to a throttle error, the service sends back a response that contains a value indicating the client should not retry before the time period has elapsed (Retry-After). The MaxRetryWaitTime flag allows the application to set a maximum wait time for all retry attempts. If the cumulative wait time exceeds the MaxRetryWaitTime, the SDK will stop retrying and return the error to the application.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.max-retry-wait-time=PT10S

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      max-retry-wait-time: "PT10S"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.max-retry-wait-time="PT10S" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_MAX_RETRY_WAIT_TIME="PT10S"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.max-retry-wait-time="PT10S"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.preferred-regions=

Sets the preferred regions for geo-replicated database accounts. For example, "East US" as the preferred region. When EnableEndpointDiscovery is true and PreferredRegions is non-empty, the SDK will prefer to use the regions in the container in the order they are specified to perform operations.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.preferred-regions=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      preferred-regions: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.preferred-regions="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_PREFERRED_REGIONS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.preferred-regions="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.cosmos-db.user-agent-suffix=

Sets the value of the user-agent suffix.

org.apereo.cas.configuration.model.support.cosmosdb.CosmosDbServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.cosmos-db.user-agent-suffix=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    cosmos-db: 
      user-agent-suffix: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.cosmos-db.user-agent-suffix="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_COSMOS_DB_USER_AGENT_SUFFIX="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.cosmos-db.user-agent-suffix="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

# Whether telemetry should be enabled by default.
# cas.service-registry.cosmos-db.allow-telemetry=false

# Document Db consistency level.
# cas.service-registry.cosmos-db.consistency-level=SESSION

# Whether collections should be created on startup.
# cas.service-registry.cosmos-db.create-container=false

# The max auto scale throughput.
# cas.service-registry.cosmos-db.database-throughput=4000

# Sets the flag to enable endpoint discovery for geo-replicated database accounts.
# cas.service-registry.cosmos-db.endpoint-discovery-enabled=true

# Specifies the supported indexing modes in the Azure Cosmos DB database service.
# cas.service-registry.cosmos-db.indexing-mode=NONE

# Sets the maximum number of retries in the case where the request fails because the service has applied rate limiting on the client.
# cas.service-registry.cosmos-db.max-retry-attempts-on-throttled-requests=4

# Sets the maximum retry time in seconds.
# cas.service-registry.cosmos-db.max-retry-wait-time=PT10S

# Sets the preferred regions for geo-replicated database accounts.
# cas.service-registry.cosmos-db.preferred-regions=

# Sets the value of the user-agent suffix.
# cas.service-registry.cosmos-db.user-agent-suffix=

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.

Note

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.

Troubleshooting

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="com.azure.cosmos" level="debug" additivity="false">
    <AppenderRef ref="casConsole"/>
    <AppenderRef ref="casFile"/>
</Logger>

Auto Initialization

Upon startup and configuration permitting, the registry is able to auto initialize itself from default JSON service definitions available to CAS. See this guide for more info.