spring-boot-starter-solace-client-config

This starter enables the Solace configuration to use certificates and private keys in the PEM format. As PEM is just a text format, it can be easily passed to the application configuration directly from an environment variable or configuration files such as .yaml or .properties. Loading certificates and private keys in the .jks format from the file system is no longer necessary.

Spring Cloud Version Compatibility

Consult the table below to determine which version you need to use:

spring-boot-starter-solace-client-config	Spring Boot	sol-jcsmp
1.0.3	3.3.3	10.24.1
1.0.2	3.3.0	10.23.0
1.0.1	3.2.5	10.23.0

Usage

Add a dependency in your application POM:

<dependency>
    <groupId>community.solace.spring.boot</groupId>
    <artifactId>spring-boot-starter-solace-client-config</artifactId>
    <version>1.0.3</version>
</dependency>

Configuration

The PEM strings can be defined via environment variables, properties or directly in the application.yml.

solace:
  java:
    apiProperties:
      AUTHENTICATION_SCHEME: AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE
      SSL_CLIENT_CERT: ${SOLACE_CLIENT_CERT}
      SSL_PRIVATE_KEY: ${SOLACE_PRIVATE_KEY}
      SSL_TRUST_CERT: ${SOLACE_TRUST_ROOTS:}

When the configuration is made directly in the binder config, it requires additionally the spring.main.sources: community.solace.spring.boot.starter.solaceclientconfig.PemFormatConfigurer property to enable the PemFormatConfigurer in the binder context.

spring:
  cloud:
    stream:
      binders:
        <solace_binder_name>:
          type: solace
          environment:
            spring.main.sources: community.solace.spring.boot.starter.solaceclientconfig.PemFormatConfigurer
            solace:
              java:
                apiProperties:
                  AUTHENTICATION_SCHEME: AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE
                  SSL_CLIENT_CERT: ${SOLACE_CLIENT_CERT}
                  SSL_PRIVATE_KEY: ${SOLACE_PRIVATE_KEY}
                  SSL_TRUST_CERT: ${SOLACE_TRUST_ROOTS:}

Note, that for both configuration cases, all 4 API properties (AUTHENTICATION_SCHEME, SSL_CLIENT_CERT, SSL_PRIVATE_KEY, SSL_TRUST_CERT) are required to create a valid Solace broker connection configuration.

An additional feature is log messages to warn you if your certificate is going to be expired.

solace:
  java:
    sslCertInfo:
      enabled: true
      warnInDays: 30
      errorInDays: 7

You will get WARNING or ERROR messages in log like: Your ssl client auth cert, used to auth at solace broker is going to be expired in 25days

that should highlight if your client cert is about to expire.