OidcClientRegistration.Builder (spring-security-oauth2-authorization-server 0.3.1 API)

java.lang.Object
- org.springframework.security.oauth2.core.oidc.OidcClientRegistration.Builder

Enclosing class:

OidcClientRegistration
```
public static class OidcClientRegistration.Builder
extends java.lang.Object
```
Helps configure an OidcClientRegistration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OidcClientRegistration`	`build()` Validate the claims and build the `OidcClientRegistration`.
`OidcClientRegistration.Builder`	`claim(java.lang.String name, java.lang.Object value)` Sets the claim.
`OidcClientRegistration.Builder`	`claims(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> claimsConsumer)` Provides access to every `claim(String, Object)` declared so far allowing the ability to add, replace, or remove.
`OidcClientRegistration.Builder`	`clientId(java.lang.String clientId)` Sets the Client Identifier, REQUIRED.
`OidcClientRegistration.Builder`	`clientIdIssuedAt(java.time.Instant clientIdIssuedAt)` Sets the time at which the Client Identifier was issued, OPTIONAL.
`OidcClientRegistration.Builder`	`clientName(java.lang.String clientName)` Sets the name of the Client to be presented to the End-User, OPTIONAL.
`OidcClientRegistration.Builder`	`clientSecret(java.lang.String clientSecret)` Sets the Client Secret, OPTIONAL.
`OidcClientRegistration.Builder`	`clientSecretExpiresAt(java.time.Instant clientSecretExpiresAt)` Sets the time at which the `client_secret` will expire or `null` if it will not expire, REQUIRED if `client_secret` was issued.
`OidcClientRegistration.Builder`	`grantType(java.lang.String grantType)` Add the OAuth 2.0 `grant_type` that the Client will restrict itself to using, OPTIONAL.
`OidcClientRegistration.Builder`	`grantTypes(java.util.function.Consumer<java.util.List<java.lang.String>> grantTypesConsumer)` A `Consumer` of the OAuth 2.0 `grant_type` values that the Client will restrict itself to using, allowing the ability to add, replace, or remove, OPTIONAL.
`OidcClientRegistration.Builder`	`idTokenSignedResponseAlgorithm(java.lang.String idTokenSignedResponseAlgorithm)` Sets the `JWS` algorithm required for signing the `ID Token` issued to the Client, OPTIONAL.
`OidcClientRegistration.Builder`	`jwkSetUrl(java.lang.String jwkSetUrl)` Sets the `URL` for the Client's JSON Web Key Set, OPTIONAL.
`OidcClientRegistration.Builder`	`redirectUri(java.lang.String redirectUri)` Add the redirection `URI` used by the Client, REQUIRED.
`OidcClientRegistration.Builder`	`redirectUris(java.util.function.Consumer<java.util.List<java.lang.String>> redirectUrisConsumer)` A `Consumer` of the redirection `URI` values used by the Client, allowing the ability to add, replace, or remove, REQUIRED.
`OidcClientRegistration.Builder`	`registrationAccessToken(java.lang.String registrationAccessToken)` Sets the Registration Access Token that can be used at the Client Configuration Endpoint, OPTIONAL.
`OidcClientRegistration.Builder`	`registrationClientUrl(java.lang.String registrationClientUrl)` Sets the `URL` of the Client Configuration Endpoint where the Registration Access Token can be used, OPTIONAL.
`OidcClientRegistration.Builder`	`responseType(java.lang.String responseType)` Add the OAuth 2.0 `response_type` that the Client will restrict itself to using, OPTIONAL.
`OidcClientRegistration.Builder`	`responseTypes(java.util.function.Consumer<java.util.List<java.lang.String>> responseTypesConsumer)` A `Consumer` of the OAuth 2.0 `response_type` values that the Client will restrict itself to using, allowing the ability to add, replace, or remove, OPTIONAL.
`OidcClientRegistration.Builder`	`scope(java.lang.String scope)` Add the OAuth 2.0 `scope` that the Client will restrict itself to using, OPTIONAL.
`OidcClientRegistration.Builder`	`scopes(java.util.function.Consumer<java.util.List<java.lang.String>> scopesConsumer)` A `Consumer` of the OAuth 2.0 `scope` values that the Client will restrict itself to using, allowing the ability to add, replace, or remove, OPTIONAL.
`OidcClientRegistration.Builder`	`tokenEndpointAuthenticationMethod(java.lang.String tokenEndpointAuthenticationMethod)` Sets the authentication method used by the Client for the Token Endpoint, OPTIONAL.
`OidcClientRegistration.Builder`	`tokenEndpointAuthenticationSigningAlgorithm(java.lang.String 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, OPTIONAL.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - clientId
```
public OidcClientRegistration.Builder clientId(java.lang.String clientId)
```
    Sets the Client Identifier, REQUIRED.
    
    Parameters:
    
    clientId - the Client Identifier
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - clientIdIssuedAt
```
public OidcClientRegistration.Builder clientIdIssuedAt(java.time.Instant clientIdIssuedAt)
```
    Sets the time at which the Client Identifier was issued, OPTIONAL.
    
    Parameters:
    
    clientIdIssuedAt - the time at which the Client Identifier was issued
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - clientSecret
```
public OidcClientRegistration.Builder clientSecret(java.lang.String clientSecret)
```
    Sets the Client Secret, OPTIONAL.
    
    Parameters:
    
    clientSecret - the Client Secret
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - clientSecretExpiresAt
```
public OidcClientRegistration.Builder clientSecretExpiresAt(java.time.Instant clientSecretExpiresAt)
```
    Sets the time at which the client_secret will expire or null if it will not expire, REQUIRED if client_secret was issued.
    
    Parameters:
    
    clientSecretExpiresAt - the time at which the client_secret will expire or null if it will not expire
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - clientName
```
public OidcClientRegistration.Builder clientName(java.lang.String clientName)
```
    Sets the name of the Client to be presented to the End-User, OPTIONAL.
    
    Parameters:
    
    clientName - the name of the Client to be presented to the End-User
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - redirectUri
```
public OidcClientRegistration.Builder redirectUri(java.lang.String redirectUri)
```
    Add the redirection URI used by the Client, REQUIRED.
    
    Parameters:
    
    redirectUri - the redirection URI used by the Client
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - redirectUris
```
public OidcClientRegistration.Builder redirectUris(java.util.function.Consumer<java.util.List<java.lang.String>> redirectUrisConsumer)
```
    A Consumer of the redirection URI values used by the Client, allowing the ability to add, replace, or remove, REQUIRED.
    
    Parameters:
    
    redirectUrisConsumer - a Consumer of the redirection URI values used by the Client
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - tokenEndpointAuthenticationMethod
```
public OidcClientRegistration.Builder tokenEndpointAuthenticationMethod(java.lang.String tokenEndpointAuthenticationMethod)
```
    Sets the authentication method used by the Client for the Token Endpoint, OPTIONAL.
    
    Parameters:
    
    tokenEndpointAuthenticationMethod - the authentication method used by the Client for the Token Endpoint
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - tokenEndpointAuthenticationSigningAlgorithm
```
public OidcClientRegistration.Builder tokenEndpointAuthenticationSigningAlgorithm(java.lang.String 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, OPTIONAL.
    
    Parameters:
    
    authenticationSigningAlgorithm - the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
    
    Since:
    
    0.2.2
  - grantType
```
public OidcClientRegistration.Builder grantType(java.lang.String grantType)
```
    Add the OAuth 2.0 grant_type that the Client will restrict itself to using, OPTIONAL.
    
    Parameters:
    
    grantType - the OAuth 2.0 grant_type that the Client will restrict itself to using
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - grantTypes
```
public OidcClientRegistration.Builder grantTypes(java.util.function.Consumer<java.util.List<java.lang.String>> grantTypesConsumer)
```
    A Consumer of the OAuth 2.0 grant_type values that the Client will restrict itself to using, allowing the ability to add, replace, or remove, OPTIONAL.
    
    Parameters:
    
    grantTypesConsumer - a Consumer of the OAuth 2.0 grant_type values that the Client will restrict itself to using
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - responseType
```
public OidcClientRegistration.Builder responseType(java.lang.String responseType)
```
    Add the OAuth 2.0 response_type that the Client will restrict itself to using, OPTIONAL.
    
    Parameters:
    
    responseType - the OAuth 2.0 response_type that the Client will restrict itself to using
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - responseTypes
```
public OidcClientRegistration.Builder responseTypes(java.util.function.Consumer<java.util.List<java.lang.String>> responseTypesConsumer)
```
    A Consumer of the OAuth 2.0 response_type values that the Client will restrict itself to using, allowing the ability to add, replace, or remove, OPTIONAL.
    
    Parameters:
    
    responseTypesConsumer - a Consumer of the OAuth 2.0 response_type values that the Client will restrict itself to using
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - scope
```
public OidcClientRegistration.Builder scope(java.lang.String scope)
```
    Add the OAuth 2.0 scope that the Client will restrict itself to using, OPTIONAL.
    
    Parameters:
    
    scope - the OAuth 2.0 scope that the Client will restrict itself to using
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - scopes
```
public OidcClientRegistration.Builder scopes(java.util.function.Consumer<java.util.List<java.lang.String>> scopesConsumer)
```
    A Consumer of the OAuth 2.0 scope values that the Client will restrict itself to using, allowing the ability to add, replace, or remove, OPTIONAL.
    
    Parameters:
    
    scopesConsumer - a Consumer of the OAuth 2.0 scope values that the Client will restrict itself to using
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - jwkSetUrl
```
public OidcClientRegistration.Builder jwkSetUrl(java.lang.String jwkSetUrl)
```
    Sets the URL for the Client's JSON Web Key Set, OPTIONAL.
    
    Parameters:
    
    jwkSetUrl - the URL for the Client's JSON Web Key Set
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
    
    Since:
    
    0.2.2
  - idTokenSignedResponseAlgorithm
```
public OidcClientRegistration.Builder idTokenSignedResponseAlgorithm(java.lang.String idTokenSignedResponseAlgorithm)
```
    Sets the JWS algorithm required for signing the ID Token issued to the Client, OPTIONAL.
    
    Parameters:
    
    idTokenSignedResponseAlgorithm - the JWS algorithm required for signing the ID Token issued to the Client
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - registrationAccessToken
```
public OidcClientRegistration.Builder registrationAccessToken(java.lang.String registrationAccessToken)
```
    Sets the Registration Access Token that can be used at the Client Configuration Endpoint, OPTIONAL.
    
    Parameters:
    
    registrationAccessToken - the Registration Access Token that can be used at the Client Configuration Endpoint
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
    
    Since:
    
    0.2.1
  - registrationClientUrl
```
public OidcClientRegistration.Builder registrationClientUrl(java.lang.String registrationClientUrl)
```
    Sets the URL of the Client Configuration Endpoint where the Registration Access Token can be used, OPTIONAL.
    
    Parameters:
    
    registrationClientUrl - the URL of the Client Configuration Endpoint where the Registration Access Token can be used
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
    
    Since:
    
    0.2.1
  - claim
```
public OidcClientRegistration.Builder claim(java.lang.String name,
                                            java.lang.Object value)
```
    Sets the claim.
    
    Parameters:
    
    name - the claim name
    
    value - the claim value
    
    Returns:
    
    the OidcClientRegistration.Builder for further configuration
  - claims
```
public OidcClientRegistration.Builder claims(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> claimsConsumer)
```
    Provides access to every claim(String, Object) declared so far allowing the ability to add, replace, or remove.
    
    Parameters:
    
    claimsConsumer - a Consumer of the claims
    
    Returns:
    
    the OidcClientRegistration.Builder for further configurations
  - build
```
public OidcClientRegistration build()
```
    Validate the claims and build the OidcClientRegistration.
    The following claims are REQUIRED: client_id, redirect_uris.
    
    Returns:
    
    the OidcClientRegistration

Class OidcClientRegistration.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

clientId

clientIdIssuedAt

clientSecret

clientSecretExpiresAt

clientName

redirectUri

redirectUris

tokenEndpointAuthenticationMethod

tokenEndpointAuthenticationSigningAlgorithm

grantType

grantTypes

responseType

responseTypes

scope

scopes

jwkSetUrl

idTokenSignedResponseAlgorithm

registrationAccessToken

registrationClientUrl

claim

claims

build