OAuth2ServiceConfigurationBuilder (java-security 2.10.2 API)

java.lang.Object
- com.sap.cloud.security.config.OAuth2ServiceConfigurationBuilder

```
public class OAuth2ServiceConfigurationBuilder
extends Object
```
Builds an OAuth configuration (OAuth2ServiceConfiguration) for a dedicated identity (Service) based on the properties applied.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OAuth2ServiceConfiguration`	`build()` Builds an OAuth configuration (`OAuth2ServiceConfiguration`) based on the properties applied.
`static OAuth2ServiceConfigurationBuilder`	`forService(Service service)` Creates a builder for a dedicated identity (`Service`)
`static OAuth2ServiceConfigurationBuilder`	`fromConfiguration(OAuth2ServiceConfiguration baseConfiguration)`
`OAuth2ServiceConfigurationBuilder`	`runInLegacyMode(boolean isLegacyMode)`
`OAuth2ServiceConfigurationBuilder`	`withCertificate(String certificate)` X.509 certificate of identity service instance.
`OAuth2ServiceConfigurationBuilder`	`withCertUrl(String url)` Cert URL of the OAuth2 identity service instance.
`OAuth2ServiceConfigurationBuilder`	`withClientId(String clientId)` Client id of identity service instance.
`OAuth2ServiceConfigurationBuilder`	`withClientIdentity(ClientIdentity clientIdentity)` ClientIdentity of identity service instance.
`OAuth2ServiceConfigurationBuilder`	`withClientSecret(String clientSecret)` Client secret of identity service instance.
`OAuth2ServiceConfigurationBuilder`	`withCredentialType(CredentialType credentialType)` Credential type of OAuth2 configuration.
`OAuth2ServiceConfigurationBuilder`	`withDomains(String... domains)` Domains of the OAuth2 identity service instance.
`OAuth2ServiceConfigurationBuilder`	`withPrivateKey(String privateKey)` X.509 private key of identity service instance.
`OAuth2ServiceConfigurationBuilder`	`withProperties(Map<String,String> properties)`
`OAuth2ServiceConfigurationBuilder`	`withProperty(String propertyName, String propertyValue)`
`OAuth2ServiceConfigurationBuilder`	`withUrl(String url)` Base URL of the OAuth2 identity service instance.

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

- Method Detail
  - forService
```
public static OAuth2ServiceConfigurationBuilder forService(@Nonnull
                                                           Service service)
```
    Creates a builder for a dedicated identity (Service)
    
    Parameters:
    
    service - the service
    
    Returns:
    
    this builder
  - fromConfiguration
```
public static OAuth2ServiceConfigurationBuilder fromConfiguration(OAuth2ServiceConfiguration baseConfiguration)
```
  - withClientId
```
public OAuth2ServiceConfigurationBuilder withClientId(String clientId)
```
    Client id of identity service instance.
    
    Parameters:
    
    clientId - client identifier
    
    Returns:
    
    this builder itself
  - withClientSecret
```
public OAuth2ServiceConfigurationBuilder withClientSecret(String clientSecret)
```
    Client secret of identity service instance.
    
    Parameters:
    
    clientSecret - client secret
    
    Returns:
    
    this builder itself
  - withCertificate
```
public OAuth2ServiceConfigurationBuilder withCertificate(String certificate)
```
    X.509 certificate of identity service instance.
    
    Parameters:
    
    certificate - PEM encoded certificate
    
    Returns:
    
    this builder itself
  - withPrivateKey
```
public OAuth2ServiceConfigurationBuilder withPrivateKey(String privateKey)
```
    X.509 private key of identity service instance.
    
    Parameters:
    
    privateKey - PEM encoded RSA private key
    
    Returns:
    
    this builder itself
  - withClientIdentity
```
public OAuth2ServiceConfigurationBuilder withClientIdentity(ClientIdentity clientIdentity)
```
    ClientIdentity of identity service instance.
    
    Parameters:
    
    clientIdentity - ClientIdentity object
    
    Returns:
    
    this builder itself
  - withUrl
```
public OAuth2ServiceConfigurationBuilder withUrl(String url)
```
    Base URL of the OAuth2 identity service instance. In multi tenancy scenarios this is the url where the service instance was created.
    
    Parameters:
    
    url - base url, e.g. https://paastenant.idservice.com
    
    Returns:
    
    this builder itself
  - withCertUrl
```
public OAuth2ServiceConfigurationBuilder withCertUrl(String url)
```
    Cert URL of the OAuth2 identity service instance.
    
    Parameters:
    
    url - cert url, e.g. https://paastenant.cert.idservice.com
    
    Returns:
    
    this builder itself
  - withCredentialType
```
public OAuth2ServiceConfigurationBuilder withCredentialType(CredentialType credentialType)
```
    Credential type of OAuth2 configuration.
    
    Parameters:
    
    credentialType - credential-type i.e. x509, instance_secret or binding_secret
    
    Returns:
    
    this builder itself
  - withDomains
```
public OAuth2ServiceConfigurationBuilder withDomains(String... domains)
```
    Domains of the OAuth2 identity service instance. In multi tenancy scenarios this contains the domain where the service instance was created.
    
    Parameters:
    
    domains - one or multiple domain, e.g. "idservice.com"
    
    Returns:
    
    this builder itself
  - withProperty
```
public OAuth2ServiceConfigurationBuilder withProperty(String propertyName,
                                                      String propertyValue)
```
  - withProperties
```
public OAuth2ServiceConfigurationBuilder withProperties(Map<String,String> properties)
```
  - runInLegacyMode
```
public OAuth2ServiceConfigurationBuilder runInLegacyMode(boolean isLegacyMode)
```
  - build
```
public OAuth2ServiceConfiguration build()
```
    Builds an OAuth configuration (OAuth2ServiceConfiguration) based on the properties applied.
    
    Returns:
    
    the oauth2 service configuration.

Class OAuth2ServiceConfigurationBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

forService

fromConfiguration

withClientId

withClientSecret

withCertificate

withPrivateKey

withClientIdentity

withUrl

withCertUrl

withCredentialType

withDomains

withProperty

withProperties

runInLegacyMode

build