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.

Apache Pulsar Ticket Registry

The Apache Pulsar ticket registry is very much an extension of the default ticket registry. The difference is that ticket operations applied to the registry are broadcasted using Pulsar topics to other listening CAS nodes. Each node keeps copies of ticket state on its own and only instructs others to keep their copy accurate by broadcasting messages and data associated with each. Each message and ticket registry instance running inside a CAS node in the cluster is tagged with a unique identifier in order to avoid endless looping behavior and recursive needless inbound operations.

The broadcast and pub/sub mechanism is backed by Apache Pulsar. Apache Pulsar is an open-source, distributed messaging and streaming platform built for the cloud.

In Apache Pulsar, topics do not need to be created beforehand. They are created automatically on first use, as long as:

The namespace exists, and
Auto-creation is enabled in the broker configuration (it is enabled by default in most local/docker setups).

Support is enabled by including the following dependency in the overlay:

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

implementation "org.apereo.cas:cas-server-support-pulsar-ticket-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-pulsar-ticket-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-pulsar-ticket-registry"
}

CAS 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.ticket.registry.in-memory.crypto.encryption.key=

The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

_{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.ticket.registry.in-memory.crypto.encryption.key=...

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: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          encryption: 
            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.ticket.registry.in-memory.crypto.encryption.key="..." -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_TICKET_REGISTRY_IN_MEMORY_CRYPTO_ENCRYPTION_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.ticket.registry.in-memory.crypto.encryption.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.ticket.registry.in-memory.crypto.signing.key=

The signing key is a string whose length is defined by the signing key size setting.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{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.ticket.registry.in-memory.crypto.signing.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          signing: 
            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.ticket.registry.in-memory.crypto.signing.key="..." -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_SIGNING_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.ticket.registry.in-memory.crypto.signing.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.

_{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.ticket.registry.in-memory.concurrency=20

The estimated number of concurrently updating threads. The implementation performs internal sizing to try to accommodate this many threads.

org.apereo.cas.configuration.model.core.ticket.registry.InMemoryTicketRegistryProperties.

_{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.ticket.registry.in-memory.concurrency=20

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        concurrency: "20"

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.ticket.registry.in-memory.concurrency="20" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CONCURRENCY="20"

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.ticket.registry.in-memory.concurrency="20"

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.ticket.registry.in-memory.initial-capacity=1000

The initial capacity of the underlying memory store. The implementation performs internal sizing to accommodate this many elements.

org.apereo.cas.configuration.model.core.ticket.registry.InMemoryTicketRegistryProperties.

_{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.ticket.registry.in-memory.initial-capacity=1000

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        initial-capacity: "1000"

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.ticket.registry.in-memory.initial-capacity="1000" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_INITIAL_CAPACITY="1000"

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.ticket.registry.in-memory.initial-capacity="1000"

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.ticket.registry.in-memory.load-factor=1

The load factor threshold, used to control resizing. Resizing may be performed when the average number of elements per bin exceeds this threshold.

org.apereo.cas.configuration.model.core.ticket.registry.InMemoryTicketRegistryProperties.

_{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.ticket.registry.in-memory.load-factor=1

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        load-factor: "1"

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.ticket.registry.in-memory.load-factor="1" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_LOAD_FACTOR="1"

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.ticket.registry.in-memory.load-factor="1"

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.ticket.registry.in-memory.crypto.alg=AES

The signing/encryption algorithm to use.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{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.ticket.registry.in-memory.crypto.alg=AES

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          alg: "AES"

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.ticket.registry.in-memory.crypto.alg="AES" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_ALG="AES"

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.ticket.registry.in-memory.crypto.alg="AES"

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.ticket.registry.in-memory.crypto.enabled=true

Whether crypto operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{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.ticket.registry.in-memory.crypto.enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          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.ticket.registry.in-memory.crypto.enabled="true" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_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.ticket.registry.in-memory.crypto.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.ticket.registry.in-memory.crypto.encryption.key-size=16

Encryption key size.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

_{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.ticket.registry.in-memory.crypto.encryption.key-size=16

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          encryption: 
            key-size: "16"

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.ticket.registry.in-memory.crypto.encryption.key-size="16" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_ENCRYPTION_KEY_SIZE="16"

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.ticket.registry.in-memory.crypto.encryption.key-size="16"

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.ticket.registry.in-memory.crypto.signing-enabled=true

Whether signing encryption operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{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.ticket.registry.in-memory.crypto.signing-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          signing-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.ticket.registry.in-memory.crypto.signing-enabled="true" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_SIGNING_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.ticket.registry.in-memory.crypto.signing-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.ticket.registry.in-memory.crypto.signing.key-size=512

The signing key size.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{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.ticket.registry.in-memory.crypto.signing.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          signing: 
            key-size: "512"

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.ticket.registry.in-memory.crypto.signing.key-size="512" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_SIGNING_KEY_SIZE="512"

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.ticket.registry.in-memory.crypto.signing.key-size="512"

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.ticket.registry.pulsar.concurrency=1

org.apereo.cas.configuration.model.support.pulsar.PulsarTicketRegistryProperties.

_{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.ticket.registry.pulsar.concurrency=1

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      pulsar: 
        concurrency: "1"

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.ticket.registry.pulsar.concurrency="1" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_PULSAR_CONCURRENCY="1"

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.ticket.registry.pulsar.concurrency="1"

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.ticket.registry.pulsar.subscription-name=cas-pulsar-ticket-registry-subscription

org.apereo.cas.configuration.model.support.pulsar.PulsarTicketRegistryProperties.

_{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.ticket.registry.pulsar.subscription-name=cas-pulsar-ticket-registry-subscription

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      pulsar: 
        subscription-name: "cas-pulsar-ticket-registry-subscription"

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.ticket.registry.pulsar.subscription-name="cas-pulsar-ticket-registry-subscription" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_PULSAR_SUBSCRIPTION_NAME="cas-pulsar-ticket-registry-subscription"

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.ticket.registry.pulsar.subscription-name="cas-pulsar-ticket-registry-subscription"

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 Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.}

spring.pulsar.admin.authentication.param=

Authentication parameter(s) as a map of parameter names to parameter values.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Authentication.

_{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:

spring.pulsar.admin.authentication.param=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    admin: 
      authentication: 
        param: "..."

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 -Dspring.pulsar.admin.authentication.param="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_ADMIN_AUTHENTICATION_PARAM="..."

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 --spring.pulsar.admin.authentication.param="..."

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.

spring.pulsar.admin.authentication.plugin-class-name=

Fully qualified class name of the authentication plugin.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Authentication.

_{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:

spring.pulsar.admin.authentication.plugin-class-name=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    admin: 
      authentication: 
        plugin-class-name: "..."

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 -Dspring.pulsar.admin.authentication.plugin-class-name="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_ADMIN_AUTHENTICATION_PLUGIN_CLASS_NAME="..."

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 --spring.pulsar.admin.authentication.plugin-class-name="..."

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.

spring.pulsar.admin.connection-timeout=1m

Duration to wait for a connection to server to be established.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Admin.

_{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:

spring.pulsar.admin.connection-timeout=1m

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    admin: 
      connection-timeout: "1m"

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 -Dspring.pulsar.admin.connection-timeout="1m" -jar build/libs/cas.war

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

export SPRING_PULSAR_ADMIN_CONNECTION_TIMEOUT="1m"

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 --spring.pulsar.admin.connection-timeout="1m"

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.

spring.pulsar.admin.read-timeout=1m

Server response read time out for any request.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Admin.

_{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:

spring.pulsar.admin.read-timeout=1m

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    admin: 
      read-timeout: "1m"

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 -Dspring.pulsar.admin.read-timeout="1m" -jar build/libs/cas.war

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

export SPRING_PULSAR_ADMIN_READ_TIMEOUT="1m"

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 --spring.pulsar.admin.read-timeout="1m"

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.

spring.pulsar.admin.request-timeout=5m

Server request time out for any request.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Admin.

_{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:

spring.pulsar.admin.request-timeout=5m

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    admin: 
      request-timeout: "5m"

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 -Dspring.pulsar.admin.request-timeout="5m" -jar build/libs/cas.war

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

export SPRING_PULSAR_ADMIN_REQUEST_TIMEOUT="5m"

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 --spring.pulsar.admin.request-timeout="5m"

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.

spring.pulsar.admin.service-url=http://localhost:8080

Pulsar web URL for the admin endpoint in the format '(http|https)://host:port'.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Admin.

_{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:

spring.pulsar.admin.service-url=http://localhost:8080

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    admin: 
      service-url: "http://localhost:8080"

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 -Dspring.pulsar.admin.service-url="http://localhost:8080" -jar build/libs/cas.war

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

export SPRING_PULSAR_ADMIN_SERVICE_URL="http://localhost:8080"

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 --spring.pulsar.admin.service-url="http://localhost:8080"

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.

spring.pulsar.client.authentication.param=

Authentication parameter(s) as a map of parameter names to parameter values.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Authentication.

_{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:

spring.pulsar.client.authentication.param=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      authentication: 
        param: "..."

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 -Dspring.pulsar.client.authentication.param="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_AUTHENTICATION_PARAM="..."

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 --spring.pulsar.client.authentication.param="..."

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.

spring.pulsar.client.authentication.plugin-class-name=

Fully qualified class name of the authentication plugin.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Authentication.

_{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:

spring.pulsar.client.authentication.plugin-class-name=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      authentication: 
        plugin-class-name: "..."

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 -Dspring.pulsar.client.authentication.plugin-class-name="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_AUTHENTICATION_PLUGIN_CLASS_NAME="..."

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 --spring.pulsar.client.authentication.plugin-class-name="..."

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.

spring.pulsar.client.connection-timeout=10s

Duration to wait for a connection to a broker to be established.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Client.

_{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:

spring.pulsar.client.connection-timeout=10s

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      connection-timeout: "10s"

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 -Dspring.pulsar.client.connection-timeout="10s" -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_CONNECTION_TIMEOUT="10s"

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 --spring.pulsar.client.connection-timeout="10s"

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.

spring.pulsar.client.failover.backup-clusters=

List of backup clusters. The backup cluster is chosen in the sequence of the given list. If all backup clusters are available, the Pulsar client chooses the first backup cluster.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Failover.

_{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:

spring.pulsar.client.failover.backup-clusters=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      failover: 
        backup-clusters: "..."

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 -Dspring.pulsar.client.failover.backup-clusters="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_FAILOVER_BACKUP_CLUSTERS="..."

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 --spring.pulsar.client.failover.backup-clusters="..."

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.

spring.pulsar.client.failover.check-interval=

Frequency of performing a probe task.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Failover.

_{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:

spring.pulsar.client.failover.check-interval=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      failover: 
        check-interval: "..."

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 -Dspring.pulsar.client.failover.check-interval="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_FAILOVER_CHECK_INTERVAL="..."

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 --spring.pulsar.client.failover.check-interval="..."

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.

spring.pulsar.client.failover.delay=

Delay before the Pulsar client switches from the primary cluster to the backup cluster.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Failover.

_{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:

spring.pulsar.client.failover.delay=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      failover: 
        delay: "..."

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 -Dspring.pulsar.client.failover.delay="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_FAILOVER_DELAY="..."

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 --spring.pulsar.client.failover.delay="..."

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.

spring.pulsar.client.failover.policy=order

Cluster failover policy.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Failover.

_{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:

spring.pulsar.client.failover.policy=order

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      failover: 
        policy: "order"

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 -Dspring.pulsar.client.failover.policy="order" -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_FAILOVER_POLICY="order"

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 --spring.pulsar.client.failover.policy="order"

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.

spring.pulsar.client.failover.switch-back-delay=

Delay before the Pulsar client switches from the backup cluster to the primary cluster.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Failover.

_{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:

spring.pulsar.client.failover.switch-back-delay=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      failover: 
        switch-back-delay: "..."

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 -Dspring.pulsar.client.failover.switch-back-delay="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_FAILOVER_SWITCH_BACK_DELAY="..."

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 --spring.pulsar.client.failover.switch-back-delay="..."

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.

spring.pulsar.client.lookup-timeout=

Client lookup timeout.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Client.

_{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:

spring.pulsar.client.lookup-timeout=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      lookup-timeout: "..."

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 -Dspring.pulsar.client.lookup-timeout="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_LOOKUP_TIMEOUT="..."

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 --spring.pulsar.client.lookup-timeout="..."

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.

spring.pulsar.client.operation-timeout=30s

Client operation timeout.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Client.

_{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:

spring.pulsar.client.operation-timeout=30s

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      operation-timeout: "30s"

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 -Dspring.pulsar.client.operation-timeout="30s" -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_OPERATION_TIMEOUT="30s"

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 --spring.pulsar.client.operation-timeout="30s"

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.

spring.pulsar.client.service-url=pulsar://localhost:6650

Pulsar service URL in the format '(pulsar|pulsar+ssl)://host:port'.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Client.

_{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:

spring.pulsar.client.service-url=pulsar://localhost:6650

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      service-url: "pulsar://localhost:6650"

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 -Dspring.pulsar.client.service-url="pulsar://localhost:6650" -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_SERVICE_URL="pulsar://localhost:6650"

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 --spring.pulsar.client.service-url="pulsar://localhost:6650"

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.

spring.pulsar.client.threads.io=

Number of threads to be used for handling connections to brokers.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Threads.

_{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:

spring.pulsar.client.threads.io=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      threads: 
        io: "..."

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 -Dspring.pulsar.client.threads.io="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_THREADS_IO="..."

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 --spring.pulsar.client.threads.io="..."

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.

spring.pulsar.client.threads.listener=

Number of threads to be used for message listeners.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Threads.

_{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:

spring.pulsar.client.threads.listener=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    client: 
      threads: 
        listener: "..."

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 -Dspring.pulsar.client.threads.listener="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CLIENT_THREADS_LISTENER="..."

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 --spring.pulsar.client.threads.listener="..."

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.

spring.pulsar.consumer.dead-letter-policy.dead-letter-topic=

Name of the dead topic where the failing messages will be sent.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer$DeadLetterPolicy.

_{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:

spring.pulsar.consumer.dead-letter-policy.dead-letter-topic=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      dead-letter-policy: 
        dead-letter-topic: "..."

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 -Dspring.pulsar.consumer.dead-letter-policy.dead-letter-topic="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_DEAD_LETTER_POLICY_DEAD_LETTER_TOPIC="..."

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 --spring.pulsar.consumer.dead-letter-policy.dead-letter-topic="..."

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.

spring.pulsar.consumer.dead-letter-policy.initial-subscription-name=

Name of the initial subscription of the dead letter topic. When not set, the initial subscription will not be created. However, when the property is set then the broker's 'allowAutoSubscriptionCreation' must be enabled or the DLQ producer will fail.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer$DeadLetterPolicy.

_{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:

spring.pulsar.consumer.dead-letter-policy.initial-subscription-name=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      dead-letter-policy: 
        initial-subscription-name: "..."

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 -Dspring.pulsar.consumer.dead-letter-policy.initial-subscription-name="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_DEAD_LETTER_POLICY_INITIAL_SUBSCRIPTION_NAME="..."

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 --spring.pulsar.consumer.dead-letter-policy.initial-subscription-name="..."

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.

spring.pulsar.consumer.dead-letter-policy.max-redeliver-count=0

Maximum number of times that a message will be redelivered before being sent to the dead letter queue.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer$DeadLetterPolicy.

_{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:

spring.pulsar.consumer.dead-letter-policy.max-redeliver-count=0

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      dead-letter-policy: 
        max-redeliver-count: "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 -Dspring.pulsar.consumer.dead-letter-policy.max-redeliver-count="0" -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_DEAD_LETTER_POLICY_MAX_REDELIVER_COUNT="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 --spring.pulsar.consumer.dead-letter-policy.max-redeliver-count="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.

spring.pulsar.consumer.dead-letter-policy.retry-letter-topic=

Name of the retry topic where the failing messages will be sent.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer$DeadLetterPolicy.

_{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:

spring.pulsar.consumer.dead-letter-policy.retry-letter-topic=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      dead-letter-policy: 
        retry-letter-topic: "..."

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 -Dspring.pulsar.consumer.dead-letter-policy.retry-letter-topic="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_DEAD_LETTER_POLICY_RETRY_LETTER_TOPIC="..."

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 --spring.pulsar.consumer.dead-letter-policy.retry-letter-topic="..."

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.

spring.pulsar.consumer.name=

Consumer name to identify a particular consumer from the topic stats.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer.

_{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:

spring.pulsar.consumer.name=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      name: "..."

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 -Dspring.pulsar.consumer.name="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_NAME="..."

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 --spring.pulsar.consumer.name="..."

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.

spring.pulsar.consumer.priority-level=0

Priority level for shared subscription consumers.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer.

_{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:

spring.pulsar.consumer.priority-level=0

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      priority-level: "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 -Dspring.pulsar.consumer.priority-level="0" -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_PRIORITY_LEVEL="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 --spring.pulsar.consumer.priority-level="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.

spring.pulsar.consumer.read-compacted=false

Whether to read messages from the compacted topic rather than the full message backlog.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer.

_{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:

spring.pulsar.consumer.read-compacted=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      read-compacted: "..."

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 -Dspring.pulsar.consumer.read-compacted="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_READ_COMPACTED="..."

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 --spring.pulsar.consumer.read-compacted="..."

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.

spring.pulsar.consumer.retry-enable=false

Whether to auto retry messages.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer.

_{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:

spring.pulsar.consumer.retry-enable=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      retry-enable: "..."

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 -Dspring.pulsar.consumer.retry-enable="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_RETRY_ENABLE="..."

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 --spring.pulsar.consumer.retry-enable="..."

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.

spring.pulsar.consumer.subscription.initial-position=latest

Position where to initialize a newly created subscription.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer$Subscription.

_{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:

spring.pulsar.consumer.subscription.initial-position=latest

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      subscription: 
        initial-position: "latest"

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 -Dspring.pulsar.consumer.subscription.initial-position="latest" -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_SUBSCRIPTION_INITIAL_POSITION="latest"

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 --spring.pulsar.consumer.subscription.initial-position="latest"

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.

spring.pulsar.consumer.subscription.mode=durable

Subscription mode to be used when subscribing to the topic.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer$Subscription.

_{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:

spring.pulsar.consumer.subscription.mode=durable

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      subscription: 
        mode: "durable"

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 -Dspring.pulsar.consumer.subscription.mode="durable" -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_SUBSCRIPTION_MODE="durable"

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 --spring.pulsar.consumer.subscription.mode="durable"

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.

spring.pulsar.consumer.subscription.name=

Subscription name for the consumer.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer$Subscription.

_{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:

spring.pulsar.consumer.subscription.name=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      subscription: 
        name: "..."

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 -Dspring.pulsar.consumer.subscription.name="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_SUBSCRIPTION_NAME="..."

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 --spring.pulsar.consumer.subscription.name="..."

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.

spring.pulsar.consumer.subscription.topics-mode=persistentonly

Determines which type of topics (persistent, non-persistent, or all) the consumer should be subscribed to when using pattern subscriptions.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer$Subscription.

_{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:

spring.pulsar.consumer.subscription.topics-mode=persistentonly

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      subscription: 
        topics-mode: "persistentonly"

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 -Dspring.pulsar.consumer.subscription.topics-mode="persistentonly" -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_SUBSCRIPTION_TOPICS_MODE="persistentonly"

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 --spring.pulsar.consumer.subscription.topics-mode="persistentonly"

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.

spring.pulsar.consumer.subscription.type=exclusive

Subscription type to be used when subscribing to a topic.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer$Subscription.

_{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:

spring.pulsar.consumer.subscription.type=exclusive

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      subscription: 
        type: "exclusive"

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 -Dspring.pulsar.consumer.subscription.type="exclusive" -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_SUBSCRIPTION_TYPE="exclusive"

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 --spring.pulsar.consumer.subscription.type="exclusive"

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.

spring.pulsar.consumer.topics=

Topics the consumer subscribes to.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer.

_{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:

spring.pulsar.consumer.topics=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      topics: "..."

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 -Dspring.pulsar.consumer.topics="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_TOPICS="..."

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 --spring.pulsar.consumer.topics="..."

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.

spring.pulsar.consumer.topics-pattern=

Pattern for topics the consumer subscribes to.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Consumer.

_{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:

spring.pulsar.consumer.topics-pattern=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    consumer: 
      topics-pattern: "..."

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 -Dspring.pulsar.consumer.topics-pattern="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_CONSUMER_TOPICS_PATTERN="..."

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 --spring.pulsar.consumer.topics-pattern="..."

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.

spring.pulsar.defaults.topic.enabled=true

Whether to enable default tenant and namespace support for topics.

_{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:

spring.pulsar.defaults.topic.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    defaults: 
      topic: 
        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 -Dspring.pulsar.defaults.topic.enabled="true" -jar build/libs/cas.war

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

export SPRING_PULSAR_DEFAULTS_TOPIC_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 --spring.pulsar.defaults.topic.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.

spring.pulsar.defaults.topic.namespace=default

Default namespace to use when producing or consuming messages against a non-fully-qualified topic URL.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Defaults$Topic.

_{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:

spring.pulsar.defaults.topic.namespace=default

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    defaults: 
      topic: 
        namespace: "default"

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 -Dspring.pulsar.defaults.topic.namespace="default" -jar build/libs/cas.war

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

export SPRING_PULSAR_DEFAULTS_TOPIC_NAMESPACE="default"

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 --spring.pulsar.defaults.topic.namespace="default"

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.

spring.pulsar.defaults.topic.tenant=public

Default tenant to use when producing or consuming messages against a non-fully-qualified topic URL.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Defaults$Topic.

_{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:

spring.pulsar.defaults.topic.tenant=public

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    defaults: 
      topic: 
        tenant: "public"

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 -Dspring.pulsar.defaults.topic.tenant="public" -jar build/libs/cas.war

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

export SPRING_PULSAR_DEFAULTS_TOPIC_TENANT="public"

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 --spring.pulsar.defaults.topic.tenant="public"

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.

spring.pulsar.defaults.type-mappings=

List of mappings from message type to topic name and schema info to use as a defaults when a topic name and/or schema is not explicitly specified when producing or consuming messages of the mapped type.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Defaults.

_{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:

spring.pulsar.defaults.type-mappings=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    defaults: 
      type-mappings: "..."

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 -Dspring.pulsar.defaults.type-mappings="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_DEFAULTS_TYPE_MAPPINGS="..."

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 --spring.pulsar.defaults.type-mappings="..."

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.

spring.pulsar.function.enabled=true

Whether to enable function support.

_{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:

spring.pulsar.function.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    function: 
      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 -Dspring.pulsar.function.enabled="true" -jar build/libs/cas.war

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

export SPRING_PULSAR_FUNCTION_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 --spring.pulsar.function.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.

spring.pulsar.function.fail-fast=true

Whether to stop processing further function creates/updates when a failure occurs.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Function.

_{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:

spring.pulsar.function.fail-fast=true

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    function: 
      fail-fast: "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 -Dspring.pulsar.function.fail-fast="true" -jar build/libs/cas.war

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

export SPRING_PULSAR_FUNCTION_FAIL_FAST="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 --spring.pulsar.function.fail-fast="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.

spring.pulsar.function.propagate-failures=true

Whether to throw an exception if any failure is encountered during server startup while creating/updating functions.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Function.

_{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:

spring.pulsar.function.propagate-failures=true

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    function: 
      propagate-failures: "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 -Dspring.pulsar.function.propagate-failures="true" -jar build/libs/cas.war

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

export SPRING_PULSAR_FUNCTION_PROPAGATE_FAILURES="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 --spring.pulsar.function.propagate-failures="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.

spring.pulsar.function.propagate-stop-failures=false

Whether to throw an exception if any failure is encountered during server shutdown while enforcing stop policy on functions.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Function.

_{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:

spring.pulsar.function.propagate-stop-failures=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    function: 
      propagate-stop-failures: "..."

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 -Dspring.pulsar.function.propagate-stop-failures="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_FUNCTION_PROPAGATE_STOP_FAILURES="..."

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 --spring.pulsar.function.propagate-stop-failures="..."

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.

spring.pulsar.listener.concurrency=

Number of threads used by listener container.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Listener.

_{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:

spring.pulsar.listener.concurrency=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    listener: 
      concurrency: "..."

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 -Dspring.pulsar.listener.concurrency="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_LISTENER_CONCURRENCY="..."

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 --spring.pulsar.listener.concurrency="..."

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.

spring.pulsar.listener.observation-enabled=false

Whether to record observations for when the Observations API is available and the client supports it.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Listener.

_{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:

spring.pulsar.listener.observation-enabled=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    listener: 
      observation-enabled: "..."

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 -Dspring.pulsar.listener.observation-enabled="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_LISTENER_OBSERVATION_ENABLED="..."

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 --spring.pulsar.listener.observation-enabled="..."

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.

spring.pulsar.listener.schema-type=

SchemaType of the consumed messages.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Listener.

_{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:

spring.pulsar.listener.schema-type=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    listener: 
      schema-type: "..."

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 -Dspring.pulsar.listener.schema-type="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_LISTENER_SCHEMA_TYPE="..."

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 --spring.pulsar.listener.schema-type="..."

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.

spring.pulsar.producer.access-mode=shared

Type of access to the topic the producer requires.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer.

_{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:

spring.pulsar.producer.access-mode=shared

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      access-mode: "shared"

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 -Dspring.pulsar.producer.access-mode="shared" -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_ACCESS_MODE="shared"

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 --spring.pulsar.producer.access-mode="shared"

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.

spring.pulsar.producer.batching-enabled=true

Whether to automatically batch messages.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer.

_{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:

spring.pulsar.producer.batching-enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      batching-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 -Dspring.pulsar.producer.batching-enabled="true" -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_BATCHING_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 --spring.pulsar.producer.batching-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.

spring.pulsar.producer.cache.enabled=true

Whether to enable caching in the PulsarProducerFactory.

_{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:

spring.pulsar.producer.cache.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      cache: 
        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 -Dspring.pulsar.producer.cache.enabled="true" -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_CACHE_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 --spring.pulsar.producer.cache.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.

spring.pulsar.producer.cache.expire-after-access=1m

Time period to expire unused entries in the cache.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer$Cache.

_{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:

spring.pulsar.producer.cache.expire-after-access=1m

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      cache: 
        expire-after-access: "1m"

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 -Dspring.pulsar.producer.cache.expire-after-access="1m" -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_CACHE_EXPIRE_AFTER_ACCESS="1m"

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 --spring.pulsar.producer.cache.expire-after-access="1m"

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.

spring.pulsar.producer.cache.initial-capacity=50

Initial size of cache.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer$Cache.

_{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:

spring.pulsar.producer.cache.initial-capacity=50

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      cache: 
        initial-capacity: "50"

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 -Dspring.pulsar.producer.cache.initial-capacity="50" -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_CACHE_INITIAL_CAPACITY="50"

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 --spring.pulsar.producer.cache.initial-capacity="50"

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.

spring.pulsar.producer.cache.maximum-size=1000

Maximum size of cache (entries).

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer$Cache.

_{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:

spring.pulsar.producer.cache.maximum-size=1000

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      cache: 
        maximum-size: "1000"

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 -Dspring.pulsar.producer.cache.maximum-size="1000" -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_CACHE_MAXIMUM_SIZE="1000"

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 --spring.pulsar.producer.cache.maximum-size="1000"

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.

spring.pulsar.producer.chunking-enabled=false

Whether to split large-size messages into multiple chunks.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer.

_{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:

spring.pulsar.producer.chunking-enabled=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      chunking-enabled: "..."

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 -Dspring.pulsar.producer.chunking-enabled="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_CHUNKING_ENABLED="..."

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 --spring.pulsar.producer.chunking-enabled="..."

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.

spring.pulsar.producer.compression-type=

Message compression type.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer.

_{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:

spring.pulsar.producer.compression-type=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      compression-type: "..."

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 -Dspring.pulsar.producer.compression-type="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_COMPRESSION_TYPE="..."

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 --spring.pulsar.producer.compression-type="..."

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.

spring.pulsar.producer.hashing-scheme=javastringhash

Message hashing scheme to choose the partition to which the message is published.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer.

_{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:

spring.pulsar.producer.hashing-scheme=javastringhash

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      hashing-scheme: "javastringhash"

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 -Dspring.pulsar.producer.hashing-scheme="javastringhash" -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_HASHING_SCHEME="javastringhash"

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 --spring.pulsar.producer.hashing-scheme="javastringhash"

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.

spring.pulsar.producer.message-routing-mode=roundrobinpartition

Message routing mode for a partitioned producer.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer.

_{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:

spring.pulsar.producer.message-routing-mode=roundrobinpartition

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      message-routing-mode: "roundrobinpartition"

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 -Dspring.pulsar.producer.message-routing-mode="roundrobinpartition" -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_MESSAGE_ROUTING_MODE="roundrobinpartition"

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 --spring.pulsar.producer.message-routing-mode="roundrobinpartition"

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.

spring.pulsar.producer.name=

Name for the producer. If not assigned, a unique name is generated.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer.

_{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:

spring.pulsar.producer.name=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      name: "..."

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 -Dspring.pulsar.producer.name="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_NAME="..."

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 --spring.pulsar.producer.name="..."

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.

spring.pulsar.producer.send-timeout=30s

Time before a message has to be acknowledged by the broker.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer.

_{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:

spring.pulsar.producer.send-timeout=30s

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      send-timeout: "30s"

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 -Dspring.pulsar.producer.send-timeout="30s" -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_SEND_TIMEOUT="30s"

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 --spring.pulsar.producer.send-timeout="30s"

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.

spring.pulsar.producer.topic-name=

Topic the producer will publish to.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Producer.

_{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:

spring.pulsar.producer.topic-name=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    producer: 
      topic-name: "..."

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 -Dspring.pulsar.producer.topic-name="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_PRODUCER_TOPIC_NAME="..."

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 --spring.pulsar.producer.topic-name="..."

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.

spring.pulsar.reader.name=

Reader name.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Reader.

_{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:

spring.pulsar.reader.name=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    reader: 
      name: "..."

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 -Dspring.pulsar.reader.name="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_READER_NAME="..."

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 --spring.pulsar.reader.name="..."

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.

spring.pulsar.reader.read-compacted=false

Whether to read messages from a compacted topic rather than a full message backlog of a topic.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Reader.

_{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:

spring.pulsar.reader.read-compacted=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    reader: 
      read-compacted: "..."

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 -Dspring.pulsar.reader.read-compacted="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_READER_READ_COMPACTED="..."

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 --spring.pulsar.reader.read-compacted="..."

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.

spring.pulsar.reader.subscription-name=

Subscription name.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Reader.

_{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:

spring.pulsar.reader.subscription-name=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    reader: 
      subscription-name: "..."

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 -Dspring.pulsar.reader.subscription-name="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_READER_SUBSCRIPTION_NAME="..."

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 --spring.pulsar.reader.subscription-name="..."

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.

spring.pulsar.reader.subscription-role-prefix=

Prefix of subscription role.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Reader.

_{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:

spring.pulsar.reader.subscription-role-prefix=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    reader: 
      subscription-role-prefix: "..."

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 -Dspring.pulsar.reader.subscription-role-prefix="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_READER_SUBSCRIPTION_ROLE_PREFIX="..."

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 --spring.pulsar.reader.subscription-role-prefix="..."

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.

spring.pulsar.reader.topics=

Topics the reader subscribes to.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Reader.

_{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:

spring.pulsar.reader.topics=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    reader: 
      topics: "..."

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 -Dspring.pulsar.reader.topics="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_READER_TOPICS="..."

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 --spring.pulsar.reader.topics="..."

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.

spring.pulsar.template.observations-enabled=false

Whether to record observations for when the Observations API is available.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Template.

_{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:

spring.pulsar.template.observations-enabled=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    template: 
      observations-enabled: "..."

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 -Dspring.pulsar.template.observations-enabled="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_TEMPLATE_OBSERVATIONS_ENABLED="..."

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 --spring.pulsar.template.observations-enabled="..."

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.

spring.pulsar.transaction.enabled=false

Whether transaction support is enabled.

org.springframework.boot.pulsar.autoconfigure.PulsarProperties$Transaction.

_{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:

spring.pulsar.transaction.enabled=...

CAS properties can be specified using the YAML syntax:

spring: 
  pulsar: 
    transaction: 
      enabled: "..."

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 -Dspring.pulsar.transaction.enabled="..." -jar build/libs/cas.war

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

export SPRING_PULSAR_TRANSACTION_ENABLED="..."

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 --spring.pulsar.transaction.enabled="..."

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.

# Authentication parameter(s) as a map of parameter names to parameter values.
# spring.pulsar.admin.authentication.param=

# Fully qualified class name of the authentication plugin.
# spring.pulsar.admin.authentication.plugin-class-name=

# Duration to wait for a connection to server to be established.
# spring.pulsar.admin.connection-timeout=1m

# Server response read time out for any request.
# spring.pulsar.admin.read-timeout=1m

# Server request time out for any request.
# spring.pulsar.admin.request-timeout=5m

# Pulsar web URL for the admin endpoint in the format '(http|https)://host:port'.
# spring.pulsar.admin.service-url=http://localhost:8080

# Authentication parameter(s) as a map of parameter names to parameter values.
# spring.pulsar.client.authentication.param=

# Fully qualified class name of the authentication plugin.
# spring.pulsar.client.authentication.plugin-class-name=

# Duration to wait for a connection to a broker to be established.
# spring.pulsar.client.connection-timeout=10s

# List of backup clusters.
# spring.pulsar.client.failover.backup-clusters=

# Frequency of performing a probe task.
# spring.pulsar.client.failover.check-interval=

# Delay before the Pulsar client switches from the primary cluster to the backup cluster.
# spring.pulsar.client.failover.delay=

# Cluster failover policy.
# spring.pulsar.client.failover.policy=order

# Delay before the Pulsar client switches from the backup cluster to the primary cluster.
# spring.pulsar.client.failover.switch-back-delay=

# Client lookup timeout.
# spring.pulsar.client.lookup-timeout=

# Client operation timeout.
# spring.pulsar.client.operation-timeout=30s

# Pulsar service URL in the format '(pulsar|pulsar+ssl)://host:port'.
# spring.pulsar.client.service-url=pulsar://localhost:6650

# Number of threads to be used for handling connections to brokers.
# spring.pulsar.client.threads.io=

# Number of threads to be used for message listeners.
# spring.pulsar.client.threads.listener=

# Name of the dead topic where the failing messages will be sent.
# spring.pulsar.consumer.dead-letter-policy.dead-letter-topic=

# Name of the initial subscription of the dead letter topic.
# spring.pulsar.consumer.dead-letter-policy.initial-subscription-name=

# Maximum number of times that a message will be redelivered before being sent to the dead letter queue.
# spring.pulsar.consumer.dead-letter-policy.max-redeliver-count=0

# Name of the retry topic where the failing messages will be sent.
# spring.pulsar.consumer.dead-letter-policy.retry-letter-topic=

# Consumer name to identify a particular consumer from the topic stats.
# spring.pulsar.consumer.name=

# Priority level for shared subscription consumers.
# spring.pulsar.consumer.priority-level=0

# Whether to read messages from the compacted topic rather than the full message backlog.
# spring.pulsar.consumer.read-compacted=false

# Whether to auto retry messages.
# spring.pulsar.consumer.retry-enable=false

# Position where to initialize a newly created subscription.
# spring.pulsar.consumer.subscription.initial-position=latest

# Subscription mode to be used when subscribing to the topic.
# spring.pulsar.consumer.subscription.mode=durable

# Subscription name for the consumer.
# spring.pulsar.consumer.subscription.name=

# Determines which type of topics (persistent, non-persistent, or all) the consumer should be subscribed to when using pattern subscriptions.
# spring.pulsar.consumer.subscription.topics-mode=persistentonly

# Subscription type to be used when subscribing to a topic.
# spring.pulsar.consumer.subscription.type=exclusive

# Topics the consumer subscribes to.
# spring.pulsar.consumer.topics=

# Pattern for topics the consumer subscribes to.
# spring.pulsar.consumer.topics-pattern=

# Whether to enable default tenant and namespace support for topics.
# spring.pulsar.defaults.topic.enabled=true

# Default namespace to use when producing or consuming messages against a non-fully-qualified topic URL.
# spring.pulsar.defaults.topic.namespace=default

# Default tenant to use when producing or consuming messages against a non-fully-qualified topic URL.
# spring.pulsar.defaults.topic.tenant=public

# List of mappings from message type to topic name and schema info to use as a defaults when a topic name and/or schema is not explicitly specified when producing or consuming messages of the mapped type.
# spring.pulsar.defaults.type-mappings=

# Whether to enable function support.
# spring.pulsar.function.enabled=true

# Whether to stop processing further function creates/updates when a failure occurs.
# spring.pulsar.function.fail-fast=true

# Whether to throw an exception if any failure is encountered during server startup while creating/updating functions.
# spring.pulsar.function.propagate-failures=true

# Whether to throw an exception if any failure is encountered during server shutdown while enforcing stop policy on functions.
# spring.pulsar.function.propagate-stop-failures=false

# Number of threads used by listener container.
# spring.pulsar.listener.concurrency=

# Whether to record observations for when the Observations API is available and the client supports it.
# spring.pulsar.listener.observation-enabled=false

# SchemaType of the consumed messages.
# spring.pulsar.listener.schema-type=

# Type of access to the topic the producer requires.
# spring.pulsar.producer.access-mode=shared

# Whether to automatically batch messages.
# spring.pulsar.producer.batching-enabled=true

# Whether to enable caching in the PulsarProducerFactory.
# spring.pulsar.producer.cache.enabled=true

# Time period to expire unused entries in the cache.
# spring.pulsar.producer.cache.expire-after-access=1m

# Initial size of cache.
# spring.pulsar.producer.cache.initial-capacity=50

# Maximum size of cache (entries).
# spring.pulsar.producer.cache.maximum-size=1000

# Whether to split large-size messages into multiple chunks.
# spring.pulsar.producer.chunking-enabled=false

# Message compression type.
# spring.pulsar.producer.compression-type=

# Message hashing scheme to choose the partition to which the message is published.
# spring.pulsar.producer.hashing-scheme=javastringhash

# Message routing mode for a partitioned producer.
# spring.pulsar.producer.message-routing-mode=roundrobinpartition

# Name for the producer.
# spring.pulsar.producer.name=

# Time before a message has to be acknowledged by the broker.
# spring.pulsar.producer.send-timeout=30s

# Topic the producer will publish to.
# spring.pulsar.producer.topic-name=

# Reader name.
# spring.pulsar.reader.name=

# Whether to read messages from a compacted topic rather than a full message backlog of a topic.
# spring.pulsar.reader.read-compacted=false

# Subscription name.
# spring.pulsar.reader.subscription-name=

# Prefix of subscription role.
# spring.pulsar.reader.subscription-role-prefix=

# Topics the reader subscribes to.
# spring.pulsar.reader.topics=

# Whether to record observations for when the Observations API is available.
# spring.pulsar.template.observations-enabled=false

# Whether transaction support is enabled.
# spring.pulsar.transaction.enabled=false

cas.ticket.registry.in-memory.crypto.encryption.key=

The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

_{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.ticket.registry.in-memory.crypto.encryption.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          encryption: 
            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.ticket.registry.in-memory.crypto.encryption.key="..." -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_ENCRYPTION_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.ticket.registry.in-memory.crypto.encryption.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.ticket.registry.in-memory.crypto.signing.key=

The signing key is a string whose length is defined by the signing key size setting.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{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.ticket.registry.in-memory.crypto.signing.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          signing: 
            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.ticket.registry.in-memory.crypto.signing.key="..." -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_SIGNING_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.ticket.registry.in-memory.crypto.signing.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.ticket.registry.in-memory.crypto.alg=AES

The signing/encryption algorithm to use.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{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.ticket.registry.in-memory.crypto.alg=AES

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          alg: "AES"

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.ticket.registry.in-memory.crypto.alg="AES" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_ALG="AES"

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.ticket.registry.in-memory.crypto.alg="AES"

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.ticket.registry.in-memory.crypto.enabled=true

Whether crypto operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{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.ticket.registry.in-memory.crypto.enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          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.ticket.registry.in-memory.crypto.enabled="true" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_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.ticket.registry.in-memory.crypto.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.ticket.registry.in-memory.crypto.encryption.key-size=16

Encryption key size.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

_{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.ticket.registry.in-memory.crypto.encryption.key-size=16

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          encryption: 
            key-size: "16"

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.ticket.registry.in-memory.crypto.encryption.key-size="16" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_ENCRYPTION_KEY_SIZE="16"

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.ticket.registry.in-memory.crypto.encryption.key-size="16"

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.ticket.registry.in-memory.crypto.signing-enabled=true

Whether signing encryption operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{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.ticket.registry.in-memory.crypto.signing-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          signing-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.ticket.registry.in-memory.crypto.signing-enabled="true" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_SIGNING_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.ticket.registry.in-memory.crypto.signing-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.ticket.registry.in-memory.crypto.signing.key-size=512

The signing key size.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{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.ticket.registry.in-memory.crypto.signing.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      in-memory: 
        crypto: 
          signing: 
            key-size: "512"

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.ticket.registry.in-memory.crypto.signing.key-size="512" -jar build/libs/cas.war

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

export CAS_TICKET_REGISTRY_IN_MEMORY_CRYPTO_SIGNING_KEY_SIZE="512"

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.ticket.registry.in-memory.crypto.signing.key-size="512"

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.

This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.

Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:

wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]

The outcome would be similar to:

{
  "kty": "oct",
  "kid": "...",
  "k": "..."
}

The generated value for k needs to be assigned to the relevant CAS settings. Note that keys generated via the above algorithm are processed by CAS using the Advanced Encryption Standard (AES) algorithm which is a specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.

CAS takes advantage of Apache Groovy in forms of either embedded or external scripts that allow one to, by default, dynamically build constructs, attributes, access strategies and a lot more. To activate the functionality described here, you may need to prepare CAS to support and integrate with Apache Groovy.

Please review this guide to configure your build.

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, especially 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="org.springframework.pulsar" level="debug" additivity="false">
    <AppenderRef ref="casConsole"/>
    <AppenderRef ref="casFile"/>
</Logger>
<Logger name="org.apache.pulsar" level="debug" additivity="false">
    <AppenderRef ref="casConsole"/>
    <AppenderRef ref="casFile"/>
</Logger>
...