org.cloudfoundry.uaa.identityproviders

Class OpenIdConnectConfiguration.Builder

java.lang.Object

org.cloudfoundry.uaa.identityproviders.OpenIdConnectConfiguration.Builder

Enclosing class:

OpenIdConnectConfiguration

public static final class OpenIdConnectConfiguration.Builder
extends Object

Builds instances of type OpenIdConnectConfiguration. 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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public final OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.Builder from(OpenIdConnectConfiguration instance)

Fill a builder with attribute values from the provided OpenIdConnectConfiguration instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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

userInfoUrl

public final OpenIdConnectConfiguration.Builder userInfoUrl(String userInfoUrl)

Initializes the value for the userInfoUrl attribute.

Parameters:

userInfoUrl - The value for userInfoUrl (can be null)

Returns:

this builder for use in a chained invocation

addShadowUserOnLogin

public final OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.Builder relyingPartySecret(String relyingPartySecret)

Initializes the value for the relyingPartySecret attribute.

Parameters:

relyingPartySecret - The value for relyingPartySecret (can be null)

Returns:

this builder for use in a chained invocation

scope

public final OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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

storeCustomAttributes

public final OpenIdConnectConfiguration.Builder storeCustomAttributes(Boolean storeCustomAttributes)

Initializes the value for the storeCustomAttributes attribute.

Parameters:

storeCustomAttributes - The value for storeCustomAttributes (can be null)

Returns:

this builder for use in a chained invocation

emailDomain

public final OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration.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 OpenIdConnectConfiguration build()

Builds a new OpenIdConnectConfiguration.

Returns:

An immutable instance of OpenIdConnectConfiguration

Throws:

IllegalStateException - if any required attributes are missing