OAuth2Configuration.Builder (Cloud Foundry Java Client 2.4.0.BUILD-SNAPSHOT API)

java.lang.Object
- org.cloudfoundry.uaa.identityproviders.OAuth2Configuration.Builder

Enclosing class:

OAuth2Configuration
```
public static final class OAuth2Configuration.Builder
extends Object
```
Builds instances of type OAuth2Configuration. Initialize attributes and then invoke the build() method to create an immutable instance.
Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OAuth2Configuration.Builder`	`addAllEmailDomains(Iterable<String> elements)` Adds elements to `emailDomains` list.
`OAuth2Configuration.Builder`	`addAllExternalGroupsWhitelist(Iterable<String> elements)` Adds elements to `externalGroupsWhitelist` list.
`OAuth2Configuration.Builder`	`addAllScopes(Iterable<String> elements)` Adds elements to `scopes` list.
`OAuth2Configuration.Builder`	`addShadowUserOnLogin(Boolean addShadowUserOnLogin)` Initializes the value for the `addShadowUserOnLogin` attribute.
`OAuth2Configuration.Builder`	`attributeMappings(AttributeMappings attributeMappings)` Initializes the value for the `attributeMappings` attribute.
`OAuth2Configuration.Builder`	`authUrl(String authUrl)` Initializes the value for the `authUrl` attribute.
`OAuth2Configuration`	`build()` Builds a new `OAuth2Configuration`.
`OAuth2Configuration.Builder`	`checkTokenUrl(String checkTokenUrl)` Initializes the value for the `checkTokenUrl` attribute.
`OAuth2Configuration.Builder`	`emailDomain(String... elements)` Adds elements to `emailDomains` list.
`OAuth2Configuration.Builder`	`emailDomain(String element)` Adds one element to `emailDomains` list.
`OAuth2Configuration.Builder`	`emailDomains(Iterable<String> elements)` Sets or replaces all elements for `emailDomains` list.
`OAuth2Configuration.Builder`	`externalGroupsWhitelist(Iterable<String> elements)` Sets or replaces all elements for `externalGroupsWhitelist` list.
`OAuth2Configuration.Builder`	`externalGroupsWhitelist(String... elements)` Adds elements to `externalGroupsWhitelist` list.
`OAuth2Configuration.Builder`	`externalGroupsWhitelist(String element)` Adds one element to `externalGroupsWhitelist` list.
`OAuth2Configuration.Builder`	`from(org.cloudfoundry.uaa.identityproviders.AbstractAuthenticationConfiguration instance)` Fill a builder with attribute values from the provided `org.cloudfoundry.uaa.identityproviders.AbstractAuthenticationConfiguration` instance.
`OAuth2Configuration.Builder`	`from(org.cloudfoundry.uaa.identityproviders.AbstractExternalIdentityProviderConfiguration instance)` Fill a builder with attribute values from the provided `org.cloudfoundry.uaa.identityproviders.AbstractExternalIdentityProviderConfiguration` instance.
`OAuth2Configuration.Builder`	`from(org.cloudfoundry.uaa.identityproviders.AbstractIdentityProviderConfiguration instance)` Fill a builder with attribute values from the provided `org.cloudfoundry.uaa.identityproviders.AbstractIdentityProviderConfiguration` instance.
`OAuth2Configuration.Builder`	`from(OAuth2Configuration instance)` Fill a builder with attribute values from the provided `OAuth2Configuration` instance.
`OAuth2Configuration.Builder`	`issuer(String issuer)` Initializes the value for the `issuer` attribute.
`OAuth2Configuration.Builder`	`linkText(Boolean linkText)` Initializes the value for the `linkText` attribute.
`OAuth2Configuration.Builder`	`providerDescription(String providerDescription)` Initializes the value for the `providerDescription` attribute.
`OAuth2Configuration.Builder`	`relyingPartyId(String relyingPartyId)` Initializes the value for the `relyingPartyId` attribute.
`OAuth2Configuration.Builder`	`relyingPartySecret(String relyingPartySecret)` Initializes the value for the `relyingPartySecret` attribute.
`OAuth2Configuration.Builder`	`responseType(String responseType)` Initializes the value for the `responseType` attribute.
`OAuth2Configuration.Builder`	`scope(String... elements)` Adds elements to `scopes` list.
`OAuth2Configuration.Builder`	`scope(String element)` Adds one element to `scopes` list.
`OAuth2Configuration.Builder`	`scopes(Iterable<String> elements)` Sets or replaces all elements for `scopes` list.
`OAuth2Configuration.Builder`	`showLinkText(Boolean showLinkText)` Initializes the value for the `showLinkText` attribute.
`OAuth2Configuration.Builder`	`skipSslVerification(Boolean skipSslVerification)` Initializes the value for the `skipSslVerification` attribute.
`OAuth2Configuration.Builder`	`tokenKey(String tokenKey)` Initializes the value for the `tokenKey` attribute.
`OAuth2Configuration.Builder`	`tokenKeyUrl(String tokenKeyUrl)` Initializes the value for the `tokenKeyUrl` attribute.
`OAuth2Configuration.Builder`	`tokenUrl(String tokenUrl)` Initializes the value for the `tokenUrl` attribute.

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

- Method Detail
  - from
```
public final OAuth2Configuration.Builder from(OAuth2Configuration instance)
```
    Fill a builder with attribute values from the provided OAuth2Configuration instance.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - from
```
public final OAuth2Configuration.Builder from(org.cloudfoundry.uaa.identityproviders.AbstractIdentityProviderConfiguration instance)
```
    Fill a builder with attribute values from the provided org.cloudfoundry.uaa.identityproviders.AbstractIdentityProviderConfiguration instance.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - from
```
public final OAuth2Configuration.Builder from(org.cloudfoundry.uaa.identityproviders.AbstractExternalIdentityProviderConfiguration instance)
```
    Fill a builder with attribute values from the provided org.cloudfoundry.uaa.identityproviders.AbstractExternalIdentityProviderConfiguration instance.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - from
```
public final OAuth2Configuration.Builder from(org.cloudfoundry.uaa.identityproviders.AbstractAuthenticationConfiguration instance)
```
    Fill a builder with attribute values from the provided org.cloudfoundry.uaa.identityproviders.AbstractAuthenticationConfiguration instance.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - checkTokenUrl
```
public final OAuth2Configuration.Builder checkTokenUrl(String checkTokenUrl)
```
    Initializes the value for the checkTokenUrl attribute.
    
    Parameters:
    
    checkTokenUrl - The value for checkTokenUrl (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - issuer
```
public final OAuth2Configuration.Builder issuer(String issuer)
```
    Initializes the value for the issuer attribute.
    
    Parameters:
    
    issuer - The value for issuer (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - responseType
```
public final OAuth2Configuration.Builder responseType(String responseType)
```
    Initializes the value for the responseType attribute.
    
    Parameters:
    
    responseType - The value for responseType (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - addShadowUserOnLogin
```
public final OAuth2Configuration.Builder addShadowUserOnLogin(Boolean addShadowUserOnLogin)
```
    Initializes the value for the addShadowUserOnLogin attribute.
    
    Parameters:
    
    addShadowUserOnLogin - The value for addShadowUserOnLogin (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - authUrl
```
public final OAuth2Configuration.Builder authUrl(String authUrl)
```
    Initializes the value for the authUrl attribute.
    
    Parameters:
    
    authUrl - The value for authUrl
    
    Returns:
    
    this builder for use in a chained invocation
  - linkText
```
public final OAuth2Configuration.Builder linkText(Boolean linkText)
```
    Initializes the value for the linkText attribute.
    
    Parameters:
    
    linkText - The value for linkText (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - relyingPartyId
```
public final OAuth2Configuration.Builder relyingPartyId(String relyingPartyId)
```
    Initializes the value for the relyingPartyId attribute.
    
    Parameters:
    
    relyingPartyId - The value for relyingPartyId
    
    Returns:
    
    this builder for use in a chained invocation
  - relyingPartySecret
```
public final OAuth2Configuration.Builder relyingPartySecret(String relyingPartySecret)
```
    Initializes the value for the relyingPartySecret attribute.
    
    Parameters:
    
    relyingPartySecret - The value for relyingPartySecret
    
    Returns:
    
    this builder for use in a chained invocation
  - scope
```
public final OAuth2Configuration.Builder scope(String element)
```
    Adds one element to scopes list.
    
    Parameters:
    
    element - A scopes element
    
    Returns:
    
    this builder for use in a chained invocation
  - scope
```
public final OAuth2Configuration.Builder scope(String... elements)
```
    Adds elements to scopes list.
    
    Parameters:
    
    elements - An array of scopes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - scopes
```
public final OAuth2Configuration.Builder scopes(Iterable<String> elements)
```
    Sets or replaces all elements for scopes list.
    
    Parameters:
    
    elements - An iterable of scopes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllScopes
```
public final OAuth2Configuration.Builder addAllScopes(Iterable<String> elements)
```
    Adds elements to scopes list.
    
    Parameters:
    
    elements - An iterable of scopes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - showLinkText
```
public final OAuth2Configuration.Builder showLinkText(Boolean showLinkText)
```
    Initializes the value for the showLinkText attribute.
    
    Parameters:
    
    showLinkText - The value for showLinkText (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - skipSslVerification
```
public final OAuth2Configuration.Builder skipSslVerification(Boolean skipSslVerification)
```
    Initializes the value for the skipSslVerification attribute.
    
    Parameters:
    
    skipSslVerification - The value for skipSslVerification (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - tokenKey
```
public final OAuth2Configuration.Builder tokenKey(String tokenKey)
```
    Initializes the value for the tokenKey attribute.
    
    Parameters:
    
    tokenKey - The value for tokenKey (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - tokenKeyUrl
```
public final OAuth2Configuration.Builder tokenKeyUrl(String tokenKeyUrl)
```
    Initializes the value for the tokenKeyUrl attribute.
    
    Parameters:
    
    tokenKeyUrl - The value for tokenKeyUrl (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - tokenUrl
```
public final OAuth2Configuration.Builder tokenUrl(String tokenUrl)
```
    Initializes the value for the tokenUrl attribute.
    
    Parameters:
    
    tokenUrl - The value for tokenUrl
    
    Returns:
    
    this builder for use in a chained invocation
  - attributeMappings
```
public final OAuth2Configuration.Builder attributeMappings(AttributeMappings attributeMappings)
```
    Initializes the value for the attributeMappings attribute.
    
    Parameters:
    
    attributeMappings - The value for attributeMappings (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - externalGroupsWhitelist
```
public final OAuth2Configuration.Builder externalGroupsWhitelist(String element)
```
    Adds one element to externalGroupsWhitelist list.
    
    Parameters:
    
    element - A externalGroupsWhitelist element
    
    Returns:
    
    this builder for use in a chained invocation
  - externalGroupsWhitelist
```
public final OAuth2Configuration.Builder externalGroupsWhitelist(String... elements)
```
    Adds elements to externalGroupsWhitelist list.
    
    Parameters:
    
    elements - An array of externalGroupsWhitelist elements
    
    Returns:
    
    this builder for use in a chained invocation
  - externalGroupsWhitelist
```
public final OAuth2Configuration.Builder externalGroupsWhitelist(Iterable<String> elements)
```
    Sets or replaces all elements for externalGroupsWhitelist list.
    
    Parameters:
    
    elements - An iterable of externalGroupsWhitelist elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllExternalGroupsWhitelist
```
public final OAuth2Configuration.Builder addAllExternalGroupsWhitelist(Iterable<String> elements)
```
    Adds elements to externalGroupsWhitelist list.
    
    Parameters:
    
    elements - An iterable of externalGroupsWhitelist elements
    
    Returns:
    
    this builder for use in a chained invocation
  - emailDomain
```
public final OAuth2Configuration.Builder emailDomain(String element)
```
    Adds one element to emailDomains list.
    
    Parameters:
    
    element - A emailDomains element
    
    Returns:
    
    this builder for use in a chained invocation
  - emailDomain
```
public final OAuth2Configuration.Builder emailDomain(String... elements)
```
    Adds elements to emailDomains list.
    
    Parameters:
    
    elements - An array of emailDomains elements
    
    Returns:
    
    this builder for use in a chained invocation
  - emailDomains
```
public final OAuth2Configuration.Builder emailDomains(Iterable<String> elements)
```
    Sets or replaces all elements for emailDomains list.
    
    Parameters:
    
    elements - An iterable of emailDomains elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllEmailDomains
```
public final OAuth2Configuration.Builder addAllEmailDomains(Iterable<String> elements)
```
    Adds elements to emailDomains list.
    
    Parameters:
    
    elements - An iterable of emailDomains elements
    
    Returns:
    
    this builder for use in a chained invocation
  - providerDescription
```
public final OAuth2Configuration.Builder providerDescription(String providerDescription)
```
    Initializes the value for the providerDescription attribute.
    
    Parameters:
    
    providerDescription - The value for providerDescription (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - build
```
public OAuth2Configuration build()
```
    Builds a new OAuth2Configuration.
    
    Returns:
    
    An immutable instance of OAuth2Configuration
    
    Throws:
    
    IllegalStateException - if any required attributes are missing

Class OAuth2Configuration.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

from

from

from

from

checkTokenUrl

issuer

responseType

addShadowUserOnLogin

authUrl

linkText

relyingPartyId

relyingPartySecret

scope

scope

scopes

addAllScopes

showLinkText

skipSslVerification

tokenKey

tokenKeyUrl

tokenUrl

attributeMappings

externalGroupsWhitelist

externalGroupsWhitelist

externalGroupsWhitelist

addAllExternalGroupsWhitelist

emailDomain

emailDomain

emailDomains

addAllEmailDomains

providerDescription

build