Package org.springframework.security.oauth2.server.authorization.settings

Class ClientSettings.Builder

java.lang.Object
org.springframework.security.oauth2.server.authorization.settings.AbstractSettings.AbstractBuilder<ClientSettings,ClientSettings.Builder>
org.springframework.security.oauth2.server.authorization.settings.ClientSettings.Builder
Enclosing class:
ClientSettings
public static final class ClientSettings.Builder extends AbstractSettings.AbstractBuilder<ClientSettings,ClientSettings.Builder>
A builder for ClientSettings.

  • Method Details

    • requireProofKey

      public ClientSettings.Builder requireProofKey(boolean requireProofKey)
      Set to true if the client is required to provide a proof key challenge and verifier when performing the Authorization Code Grant flow.
      Parameters:
      requireProofKey - true if the client is required to provide a proof key challenge and verifier, false otherwise
      Returns:
      the ClientSettings.Builder for further configuration

    • requireAuthorizationConsent

      public ClientSettings.Builder requireAuthorizationConsent(boolean requireAuthorizationConsent)
      Set to true if authorization consent is required when the client requests access. This applies to all interactive flows (e.g. authorization_code and device_code).
      Parameters:
      requireAuthorizationConsent - true if authorization consent is required when the client requests access, false otherwise
      Returns:
      the ClientSettings.Builder for further configuration

    • jwkSetUrl

      public ClientSettings.Builder jwkSetUrl(String jwkSetUrl)
      Sets the URL for the Client's JSON Web Key Set.
      Parameters:
      jwkSetUrl - the URL for the Client's JSON Web Key Set
      Returns:
      the ClientSettings.Builder for further configuration
      Since:
      0.2.2

    • tokenEndpointAuthenticationSigningAlgorithm

      public ClientSettings.Builder tokenEndpointAuthenticationSigningAlgorithm(org.springframework.security.oauth2.jose.jws.JwsAlgorithm authenticationSigningAlgorithm)
      Sets the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods.
      Parameters:
      authenticationSigningAlgorithm - the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint
      Returns:
      the ClientSettings.Builder for further configuration
      Since:
      0.2.2

    • x509CertificateSubjectDN

      public ClientSettings.Builder x509CertificateSubjectDN(String x509CertificateSubjectDN)
      Sets the expected subject distinguished name associated to the client X509Certificate received during client authentication when using the tls_client_auth method.
      Parameters:
      x509CertificateSubjectDN - the expected subject distinguished name associated to the client X509Certificate received during client authentication * @return the ClientSettings.Builder for further configuration
      Returns:
      the ClientSettings.Builder for further configuration
      Since:
      1.3

    • build

      public ClientSettings build()
      Builds the ClientSettings.
      Specified by:
      build in class AbstractSettings.AbstractBuilder<ClientSettings,ClientSettings.Builder>
      Returns:
      the ClientSettings