AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder (spring-security-oauth2-authorization-server 0.3.1 API)

java.lang.Object
- org.springframework.security.oauth2.core.AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<T,B>

Direct Known Subclasses:: OAuth2AuthorizationServerMetadata.Builder, OidcProviderConfiguration.Builder

Enclosing class:: AbstractOAuth2AuthorizationServerMetadata

protected abstract static class AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<T extends AbstractOAuth2AuthorizationServerMetadata,B extends AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<T,B>>
extends java.lang.Object

A builder for subclasses of AbstractOAuth2AuthorizationServerMetadata.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractBuilder()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractBuilder()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`B`	`authorizationEndpoint(java.lang.String authorizationEndpoint)` Use this `authorization_endpoint` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, REQUIRED.
`abstract T`	`build()` Creates the `AbstractOAuth2AuthorizationServerMetadata`.
`B`	`claim(java.lang.String name, java.lang.Object value)` Use this claim in the resulting `AbstractOAuth2AuthorizationServerMetadata`.
`B`	`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 with the possibility to add, replace, or remove.
`B`	`codeChallengeMethod(java.lang.String codeChallengeMethod)` Add this Proof Key for Code Exchange (PKCE) `code_challenge_method` to the collection of `code_challenge_methods_supported` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, OPTIONAL.
`B`	`codeChallengeMethods(java.util.function.Consumer<java.util.List<java.lang.String>> codeChallengeMethodsConsumer)` A `Consumer` of the Proof Key for Code Exchange (PKCE) `code_challenge_method` values supported allowing the ability to add, replace, or remove.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getClaims()`
`protected B`	`getThis()`
`B`	`grantType(java.lang.String grantType)` Add this OAuth 2.0 `grant_type` to the collection of `grant_types_supported` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, OPTIONAL.
`B`	`grantTypes(java.util.function.Consumer<java.util.List<java.lang.String>> grantTypesConsumer)` A `Consumer` of the OAuth 2.0 `grant_type` values supported allowing the ability to add, replace, or remove.
`B`	`issuer(java.lang.String issuer)` Use this `issuer` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, REQUIRED.
`B`	`jwkSetUrl(java.lang.String jwkSetUrl)` Use this `jwks_uri` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, OPTIONAL.
`B`	`responseType(java.lang.String responseType)` Add this OAuth 2.0 `response_type` to the collection of `response_types_supported` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, REQUIRED.
`B`	`responseTypes(java.util.function.Consumer<java.util.List<java.lang.String>> responseTypesConsumer)` A `Consumer` of the OAuth 2.0 `response_type` values supported allowing the ability to add, replace, or remove.
`B`	`scope(java.lang.String scope)` Add this OAuth 2.0 `scope` to the collection of `scopes_supported` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, RECOMMENDED.
`B`	`scopes(java.util.function.Consumer<java.util.List<java.lang.String>> scopesConsumer)` A `Consumer` of the OAuth 2.0 `scope` values supported allowing the ability to add, replace, or remove.
`B`	`tokenEndpoint(java.lang.String tokenEndpoint)` Use this `token_endpoint` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, REQUIRED.
`B`	`tokenEndpointAuthenticationMethod(java.lang.String authenticationMethod)` Add this client authentication method to the collection of `token_endpoint_auth_methods_supported` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, OPTIONAL.
`B`	`tokenEndpointAuthenticationMethods(java.util.function.Consumer<java.util.List<java.lang.String>> authenticationMethodsConsumer)` A `Consumer` of the client authentication method(s) allowing the ability to add, replace, or remove.
`B`	`tokenIntrospectionEndpoint(java.lang.String tokenIntrospectionEndpoint)` Use this `introspection_endpoint` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, OPTIONAL.
`B`	`tokenIntrospectionEndpointAuthenticationMethod(java.lang.String authenticationMethod)` Add this client authentication method to the collection of `introspection_endpoint_auth_methods_supported` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, OPTIONAL.
`B`	`tokenIntrospectionEndpointAuthenticationMethods(java.util.function.Consumer<java.util.List<java.lang.String>> authenticationMethodsConsumer)` A `Consumer` of the client authentication method(s) allowing the ability to add, replace, or remove.
`B`	`tokenRevocationEndpoint(java.lang.String tokenRevocationEndpoint)` Use this `revocation_endpoint` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, OPTIONAL.
`B`	`tokenRevocationEndpointAuthenticationMethod(java.lang.String authenticationMethod)` Add this client authentication method to the collection of `revocation_endpoint_auth_methods_supported` in the resulting `AbstractOAuth2AuthorizationServerMetadata`, OPTIONAL.
`B`	`tokenRevocationEndpointAuthenticationMethods(java.util.function.Consumer<java.util.List<java.lang.String>> authenticationMethodsConsumer)` A `Consumer` of the client authentication method(s) allowing the ability to add, replace, or remove.
`protected void`	`validate()`
`protected static void`	`validateURL(java.lang.Object url, java.lang.String errorMessage)`

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

- Constructor Detail
  - AbstractBuilder
```
protected AbstractBuilder()
```
- Method Detail
  - getClaims
```
protected java.util.Map<java.lang.String,java.lang.Object> getClaims()
```
  - getThis
```
protected final B getThis()
```
  - issuer
```
public B issuer(java.lang.String issuer)
```
    Use this issuer in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.
    
    Parameters:
    
    issuer - the URL of the Authorization Server's Issuer Identifier
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - authorizationEndpoint
```
public B authorizationEndpoint(java.lang.String authorizationEndpoint)
```
    Use this authorization_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.
    
    Parameters:
    
    authorizationEndpoint - the URL of the OAuth 2.0 Authorization Endpoint
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - tokenEndpoint
```
public B tokenEndpoint(java.lang.String tokenEndpoint)
```
    Use this token_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.
    
    Parameters:
    
    tokenEndpoint - the URL of the OAuth 2.0 Token Endpoint
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - tokenEndpointAuthenticationMethod
```
public B tokenEndpointAuthenticationMethod(java.lang.String authenticationMethod)
```
    Add this client authentication method to the collection of token_endpoint_auth_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
    
    Parameters:
    
    authenticationMethod - the client authentication method supported by the OAuth 2.0 Token Endpoint
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - tokenEndpointAuthenticationMethods
```
public B tokenEndpointAuthenticationMethods(java.util.function.Consumer<java.util.List<java.lang.String>> authenticationMethodsConsumer)
```
    A Consumer of the client authentication method(s) allowing the ability to add, replace, or remove.
    
    Parameters:
    
    authenticationMethodsConsumer - a Consumer of the client authentication method(s) supported by the OAuth 2.0 Token Endpoint
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - jwkSetUrl
```
public B jwkSetUrl(java.lang.String jwkSetUrl)
```
    Use this jwks_uri in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
    
    Parameters:
    
    jwkSetUrl - the URL of the JSON Web Key Set
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - scope
```
public B scope(java.lang.String scope)
```
    Add this OAuth 2.0 scope to the collection of scopes_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, RECOMMENDED.
    
    Parameters:
    
    scope - the OAuth 2.0 scope value supported
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - scopes
```
public B scopes(java.util.function.Consumer<java.util.List<java.lang.String>> scopesConsumer)
```
    A Consumer of the OAuth 2.0 scope values supported allowing the ability to add, replace, or remove.
    
    Parameters:
    
    scopesConsumer - a Consumer of the OAuth 2.0 scope values supported
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - responseType
```
public B responseType(java.lang.String responseType)
```
    Add this OAuth 2.0 response_type to the collection of response_types_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.
    
    Parameters:
    
    responseType - the OAuth 2.0 response_type value supported
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - responseTypes
```
public B responseTypes(java.util.function.Consumer<java.util.List<java.lang.String>> responseTypesConsumer)
```
    A Consumer of the OAuth 2.0 response_type values supported allowing the ability to add, replace, or remove.
    
    Parameters:
    
    responseTypesConsumer - a Consumer of the OAuth 2.0 response_type values supported
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - grantType
```
public B grantType(java.lang.String grantType)
```
    Add this OAuth 2.0 grant_type to the collection of grant_types_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
    
    Parameters:
    
    grantType - the OAuth 2.0 grant_type value supported
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - grantTypes
```
public B grantTypes(java.util.function.Consumer<java.util.List<java.lang.String>> grantTypesConsumer)
```
    A Consumer of the OAuth 2.0 grant_type values supported allowing the ability to add, replace, or remove.
    
    Parameters:
    
    grantTypesConsumer - a Consumer of the OAuth 2.0 grant_type values supported
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - tokenRevocationEndpoint
```
public B tokenRevocationEndpoint(java.lang.String tokenRevocationEndpoint)
```
    Use this revocation_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
    
    Parameters:
    
    tokenRevocationEndpoint - the URL of the OAuth 2.0 Token Revocation Endpoint
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - tokenRevocationEndpointAuthenticationMethod
```
public B tokenRevocationEndpointAuthenticationMethod(java.lang.String authenticationMethod)
```
    Add this client authentication method to the collection of revocation_endpoint_auth_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
    
    Parameters:
    
    authenticationMethod - the client authentication method supported by the OAuth 2.0 Token Revocation Endpoint
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - tokenRevocationEndpointAuthenticationMethods
```
public B tokenRevocationEndpointAuthenticationMethods(java.util.function.Consumer<java.util.List<java.lang.String>> authenticationMethodsConsumer)
```
    A Consumer of the client authentication method(s) allowing the ability to add, replace, or remove.
    
    Parameters:
    
    authenticationMethodsConsumer - a Consumer of the client authentication method(s) supported by the OAuth 2.0 Token Revocation Endpoint
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - tokenIntrospectionEndpoint
```
public B tokenIntrospectionEndpoint(java.lang.String tokenIntrospectionEndpoint)
```
    Use this introspection_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
    
    Parameters:
    
    tokenIntrospectionEndpoint - the URL of the OAuth 2.0 Token Introspection Endpoint
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - tokenIntrospectionEndpointAuthenticationMethod
```
public B tokenIntrospectionEndpointAuthenticationMethod(java.lang.String authenticationMethod)
```
    Add this client authentication method to the collection of introspection_endpoint_auth_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
    
    Parameters:
    
    authenticationMethod - the client authentication method supported by the OAuth 2.0 Token Introspection Endpoint
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - tokenIntrospectionEndpointAuthenticationMethods
```
public B tokenIntrospectionEndpointAuthenticationMethods(java.util.function.Consumer<java.util.List<java.lang.String>> authenticationMethodsConsumer)
```
    A Consumer of the client authentication method(s) allowing the ability to add, replace, or remove.
    
    Parameters:
    
    authenticationMethodsConsumer - a Consumer of the client authentication method(s) supported by the OAuth 2.0 Token Introspection Endpoint
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - codeChallengeMethod
```
public B codeChallengeMethod(java.lang.String codeChallengeMethod)
```
    Add this Proof Key for Code Exchange (PKCE) code_challenge_method to the collection of code_challenge_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
    
    Parameters:
    
    codeChallengeMethod - the code_challenge_method value supported
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - codeChallengeMethods
```
public B codeChallengeMethods(java.util.function.Consumer<java.util.List<java.lang.String>> codeChallengeMethodsConsumer)
```
    A Consumer of the Proof Key for Code Exchange (PKCE) code_challenge_method values supported allowing the ability to add, replace, or remove.
    
    Parameters:
    
    codeChallengeMethodsConsumer - a Consumer of the code_challenge_method values supported
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - claim
```
public B claim(java.lang.String name,
               java.lang.Object value)
```
    Use this claim in the resulting AbstractOAuth2AuthorizationServerMetadata.
    
    Parameters:
    
    name - the claim name
    
    value - the claim value
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration
  - claims
```
public B 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 with the possibility to add, replace, or remove.
    
    Parameters:
    
    claimsConsumer - a Consumer of the claims
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configurations
  - build
```
public abstract T build()
```
    Creates the AbstractOAuth2AuthorizationServerMetadata.
    
    Returns:
    
    the AbstractOAuth2AuthorizationServerMetadata
  - validate
```
protected void validate()
```
  - validateURL
```
protected static void validateURL(java.lang.Object url,
                                  java.lang.String errorMessage)
```

Class AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<T extends AbstractOAuth2AuthorizationServerMetadata,B extends AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<T,B>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractBuilder

Method Detail

getClaims

getThis

issuer

authorizationEndpoint

tokenEndpoint

tokenEndpointAuthenticationMethod

tokenEndpointAuthenticationMethods

jwkSetUrl

scope

scopes

responseType

responseTypes

grantType

grantTypes

tokenRevocationEndpoint

tokenRevocationEndpointAuthenticationMethod

tokenRevocationEndpointAuthenticationMethods

tokenIntrospectionEndpoint

tokenIntrospectionEndpointAuthenticationMethod

tokenIntrospectionEndpointAuthenticationMethods

codeChallengeMethod

codeChallengeMethods

claim

claims

build

validate

validateURL