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

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

封闭类:: OidcClientRegistration

public static class OidcClientRegistration.Builder
extends java.lang.Object

Helps configure an OidcClientRegistration.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - clientId
```
public OidcClientRegistration.Builder clientId(java.lang.String clientId)
```
    Sets the Client Identifier, REQUIRED.
    
    参数:
    
    clientId - the Client Identifier
    
    返回:
    
    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.
    
    参数:
    
    clientIdIssuedAt - the time at which the Client Identifier was issued
    
    返回:
    
    the OidcClientRegistration.Builder for further configuration
  - clientSecret
```
public OidcClientRegistration.Builder clientSecret(java.lang.String clientSecret)
```
    Sets the Client Secret, OPTIONAL.
    
    参数:
    
    clientSecret - the Client Secret
    
    返回:
    
    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.
    
    参数:
    
    clientSecretExpiresAt - the time at which the client_secret will expire or null if it will not expire
    
    返回:
    
    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.
    
    参数:
    
    clientName - the name of the Client to be presented to the End-User
    
    返回:
    
    the OidcClientRegistration.Builder for further configuration
  - redirectUri
```
public OidcClientRegistration.Builder redirectUri(java.lang.String redirectUri)
```
    Add the redirection URI used by the Client, REQUIRED.
    
    参数:
    
    redirectUri - the redirection URI used by the Client
    
    返回:
    
    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.
    
    参数:
    
    redirectUrisConsumer - a Consumer of the redirection URI values used by the Client
    
    返回:
    
    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.
    
    参数:
    
    tokenEndpointAuthenticationMethod - the authentication method used by the Client for the Token Endpoint
    
    返回:
    
    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.
    
    参数:
    
    authenticationSigningAlgorithm - the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint
    
    返回:
    
    the OidcClientRegistration.Builder for further configuration
    
    从以下版本开始:
    
    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.
    
    参数:
    
    grantType - the OAuth 2.0 grant_type that the Client will restrict itself to using
    
    返回:
    
    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.
    
    参数:
    
    grantTypesConsumer - a Consumer of the OAuth 2.0 grant_type values that the Client will restrict itself to using
    
    返回:
    
    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.
    
    参数:
    
    responseType - the OAuth 2.0 response_type that the Client will restrict itself to using
    
    返回:
    
    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.
    
    参数:
    
    responseTypesConsumer - a Consumer of the OAuth 2.0 response_type values that the Client will restrict itself to using
    
    返回:
    
    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.
    
    参数:
    
    scope - the OAuth 2.0 scope that the Client will restrict itself to using
    
    返回:
    
    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.
    
    参数:
    
    scopesConsumer - a Consumer of the OAuth 2.0 scope values that the Client will restrict itself to using
    
    返回:
    
    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.
    
    参数:
    
    jwkSetUrl - the URL for the Client's JSON Web Key Set
    
    返回:
    
    the OidcClientRegistration.Builder for further configuration
    
    从以下版本开始:
    
    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.
    
    参数:
    
    idTokenSignedResponseAlgorithm - the JWS algorithm required for signing the ID Token issued to the Client
    
    返回:
    
    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.
    
    参数:
    
    registrationAccessToken - the Registration Access Token that can be used at the Client Configuration Endpoint
    
    返回:
    
    the OidcClientRegistration.Builder for further configuration
    
    从以下版本开始:
    
    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.
    
    参数:
    
    registrationClientUrl - the URL of the Client Configuration Endpoint where the Registration Access Token can be used
    
    返回:
    
    the OidcClientRegistration.Builder for further configuration
    
    从以下版本开始:
    
    0.2.1
  - claim
```
public OidcClientRegistration.Builder claim(java.lang.String name,
                                            java.lang.Object value)
```
    Sets the claim.
    
    参数:
    
    name - the claim name
    
    value - the claim value
    
    返回:
    
    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.
    
    参数:
    
    claimsConsumer - a Consumer of the claims
    
    返回:
    
    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.
    
    返回:
    
    the OidcClientRegistration

类 OidcClientRegistration.Builder

方法概要

从类继承的方法 java.lang.Object

方法详细资料

clientId

clientIdIssuedAt

clientSecret

clientSecretExpiresAt

clientName

redirectUri

redirectUris

tokenEndpointAuthenticationMethod

tokenEndpointAuthenticationSigningAlgorithm

grantType

grantTypes

responseType

responseTypes

scope

scopes

jwkSetUrl

idTokenSignedResponseAlgorithm

registrationAccessToken

registrationClientUrl

claim

claims

build