Couchbase Audits

If you intend to use a Couchbase database for auditing functionality, enable the following module in your configuration:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-audit-couchbase</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-audit-couchbase:${project.'cas.version'}"

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

dependencies {
    implementation "org.apereo.cas:cas-server-support-audit-couchbase"
}

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-audit-couchbase"
}

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.audit.couchbase.addresses=

Node addresses.

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: 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.audit.couchbase.addresses=...

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: 
  audit: 
    couchbase: 
      addresses: "..."

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.audit.couchbase.addresses="..." -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_AUDIT_COUCHBASE_ADDRESSES="..."

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.audit.couchbase.addresses="..."

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.audit.couchbase.bucket=testbucket

Bucket name.

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.bucket=testbucket

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      bucket: "testbucket"

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.audit.couchbase.bucket="testbucket" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_BUCKET="testbucket"

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.audit.couchbase.bucket="testbucket"

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.audit.couchbase.cluster-password=

Cluster password.

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.cluster-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      cluster-password: "..."

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.audit.couchbase.cluster-password="..." -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_CLUSTER_PASSWORD="..."

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.audit.couchbase.cluster-password="..."

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.audit.couchbase.cluster-username=

Cluster username.

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.cluster-username=...

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      cluster-username: "..."

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.audit.couchbase.cluster-username="..." -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_CLUSTER_USERNAME="..."

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.audit.couchbase.cluster-username="..."

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. You should only include this field in your
configuration if you need to modify the default value.}

cas.audit.couchbase.asynchronous=false

Whether audit records should be executed asynchronously.

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.asynchronous=...

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      asynchronous: "..."

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.audit.couchbase.asynchronous="..." -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_ASYNCHRONOUS="..."

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.audit.couchbase.asynchronous="..."

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.audit.couchbase.connection-timeout=PT60S

String representation of connection timeout.

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

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.connection-timeout=PT60S

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      connection-timeout: "PT60S"

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.audit.couchbase.connection-timeout="PT60S" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_CONNECTION_TIMEOUT="PT60S"

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.audit.couchbase.connection-timeout="PT60S"

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.audit.couchbase.idle-connection-timeout=PT60S

String representation of idle connection timeout.

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

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.idle-connection-timeout=PT60S

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      idle-connection-timeout: "PT60S"

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.audit.couchbase.idle-connection-timeout="PT60S" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_IDLE_CONNECTION_TIMEOUT="PT60S"

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.audit.couchbase.idle-connection-timeout="PT60S"

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.audit.couchbase.kv-timeout=PT30S

String representation of KV timeout.

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

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.kv-timeout=PT30S

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      kv-timeout: "PT30S"

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.audit.couchbase.kv-timeout="PT30S" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_KV_TIMEOUT="PT30S"

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.audit.couchbase.kv-timeout="PT30S"

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.audit.couchbase.max-http-connections=5

Maximum number of connections made to the cluster.

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.max-http-connections=5

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      max-http-connections: "5"

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.audit.couchbase.max-http-connections="5" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_MAX_HTTP_CONNECTIONS="5"

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.audit.couchbase.max-http-connections="5"

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.audit.couchbase.max-num-requests-in-retry=32768

Allows to customize the maximum number of requests allowed in the retry timer.

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.max-num-requests-in-retry=32768

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      max-num-requests-in-retry: "32768"

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.audit.couchbase.max-num-requests-in-retry="32768" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_MAX_NUM_REQUESTS_IN_RETRY="32768"

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.audit.couchbase.max-num-requests-in-retry="32768"

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.audit.couchbase.max-parallelism=0

Maximum number of parallel threads made for queries.

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.max-parallelism=0

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      max-parallelism: "0"

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.audit.couchbase.max-parallelism="0" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_MAX_PARALLELISM="0"

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.audit.couchbase.max-parallelism="0"

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.audit.couchbase.query-timeout=PT30S

String representation of query timeout.

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

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.query-timeout=PT30S

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      query-timeout: "PT30S"

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.audit.couchbase.query-timeout="PT30S" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_QUERY_TIMEOUT="PT30S"

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.audit.couchbase.query-timeout="PT30S"

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.audit.couchbase.scan-consistency=NOT_BOUNDED

Query scan consistency.

By default, the query engine will return whatever is currently in the index at the time of query (this mode is also called NOT_BOUNDED). If you need to include everything that has just been written, a different scan consistency must be chosen. If REQUEST_PLUS is chosen, it will likely take a bit longer to return the results but the query engine will make sure that it is as up-to-date as possible.

Accepted values are: NOT_BOUNDED, REQUEST_PLUS.

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.scan-consistency=NOT_BOUNDED

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      scan-consistency: "NOT_BOUNDED"

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.audit.couchbase.scan-consistency="NOT_BOUNDED" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_SCAN_CONSISTENCY="NOT_BOUNDED"

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.audit.couchbase.scan-consistency="NOT_BOUNDED"

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.audit.couchbase.scan-wait-timeout=PT30S

String representation of scan timeout.

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

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.scan-wait-timeout=PT30S

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      scan-wait-timeout: "PT30S"

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.audit.couchbase.scan-wait-timeout="PT30S" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_SCAN_WAIT_TIMEOUT="PT30S"

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.audit.couchbase.scan-wait-timeout="PT30S"

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.audit.couchbase.search-timeout=PT30S

String representation of search timeout.

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

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.search-timeout=PT30S

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      search-timeout: "PT30S"

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.audit.couchbase.search-timeout="PT30S" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_SEARCH_TIMEOUT="PT30S"

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.audit.couchbase.search-timeout="PT30S"

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.audit.couchbase.view-timeout=PT30S

String representation of view timeout.

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

org.apereo.cas.configuration.model.core.audit.AuditCouchbaseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.audit.couchbase.view-timeout=PT30S

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    couchbase: 
      view-timeout: "PT30S"

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.audit.couchbase.view-timeout="PT30S" -jar build/libs/cas.war

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

export CAS_AUDIT_COUCHBASE_VIEW_TIMEOUT="PT30S"

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.audit.couchbase.view-timeout="PT30S"

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 audit records should be executed asynchronously.
# cas.audit.couchbase.asynchronous=false

# String representation of connection timeout.
# cas.audit.couchbase.connection-timeout=PT60S

# String representation of idle connection timeout.
# cas.audit.couchbase.idle-connection-timeout=PT60S

# String representation of KV timeout.
# cas.audit.couchbase.kv-timeout=PT30S

# Maximum number of connections made to the cluster.
# cas.audit.couchbase.max-http-connections=5

# Allows to customize the maximum number of requests allowed in the retry timer.
# cas.audit.couchbase.max-num-requests-in-retry=32768

# Maximum number of parallel threads made for queries.
# cas.audit.couchbase.max-parallelism=0

# String representation of query timeout.
# cas.audit.couchbase.query-timeout=PT30S

# Query scan consistency.
# cas.audit.couchbase.scan-consistency=NOT_BOUNDED

# String representation of scan timeout.
# cas.audit.couchbase.scan-wait-timeout=PT30S

# String representation of search timeout.
# cas.audit.couchbase.search-timeout=PT30S

# String representation of view timeout.
# cas.audit.couchbase.view-timeout=PT30S

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.

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. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. 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.