org.cloudfoundry.uaa.identityproviders

Class SamlConfiguration.Builder

java.lang.Object

org.cloudfoundry.uaa.identityproviders.SamlConfiguration.Builder

Enclosing class:

SamlConfiguration

public static final class SamlConfiguration.Builder
extends Object

Builds instances of type SamlConfiguration. 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
SamlConfiguration.Builder	addAllAuthnContext(Iterable<String> elements) Adds elements to authnContext list.
SamlConfiguration.Builder	addAllEmailDomains(Iterable<String> elements) Adds elements to emailDomains list.
SamlConfiguration.Builder	addAllExternalGroupsWhitelist(Iterable<String> elements) Adds elements to externalGroupsWhitelist list.
SamlConfiguration.Builder	addShadowUserOnLogin(Boolean addShadowUserOnLogin) Initializes the value for the addShadowUserOnLogin attribute.
SamlConfiguration.Builder	assertionConsumerIndex(Integer assertionConsumerIndex) Initializes the value for the assertionConsumerIndex attribute.
SamlConfiguration.Builder	attributeMappings(AttributeMappings attributeMappings) Initializes the value for the attributeMappings attribute.
SamlConfiguration.Builder	authnContext(Iterable<String> elements) Sets or replaces all elements for authnContext list.
SamlConfiguration.Builder	authnContext(String... elements) Adds elements to authnContext list.
SamlConfiguration.Builder	authnContext(String element) Adds one element to authnContext list.
SamlConfiguration	build() Builds a new SamlConfiguration.
SamlConfiguration.Builder	emailDomain(String element) Adds one element to emailDomains list.
SamlConfiguration.Builder	emailDomains(Iterable<String> elements) Sets or replaces all elements for emailDomains list.
SamlConfiguration.Builder	emailDomains(String... elements) Adds elements to emailDomains list.
SamlConfiguration.Builder	externalGroupsWhitelist(Iterable<String> elements) Sets or replaces all elements for externalGroupsWhitelist list.
SamlConfiguration.Builder	externalGroupsWhitelist(String... elements) Adds elements to externalGroupsWhitelist list.
SamlConfiguration.Builder	externalGroupsWhitelist(String element) Adds one element to externalGroupsWhitelist list.
SamlConfiguration.Builder	from(org.cloudfoundry.uaa.identityproviders._SamlConfiguration instance) Copy abstract value type _SamlConfiguration instance into builder.
SamlConfiguration.Builder	from(org.cloudfoundry.uaa.identityproviders.AbstractExternalIdentityProviderConfiguration instance) Fill a builder with attribute values from the provided org.cloudfoundry.uaa.identityproviders.AbstractExternalIdentityProviderConfiguration instance.
SamlConfiguration.Builder	from(org.cloudfoundry.uaa.identityproviders.AbstractIdentityProviderConfiguration instance) Fill a builder with attribute values from the provided org.cloudfoundry.uaa.identityproviders.AbstractIdentityProviderConfiguration instance.
SamlConfiguration.Builder	from(SamlConfiguration instance) Fill a builder with attribute values from the provided SamlConfiguration instance.
SamlConfiguration.Builder	groupMappingMode(ExternalGroupMappingMode groupMappingMode) Initializes the value for the groupMappingMode attribute.
SamlConfiguration.Builder	iconUrl(String iconUrl) Initializes the value for the iconUrl attribute.
SamlConfiguration.Builder	idpEntityAlias(String idpEntityAlias) Initializes the value for the idpEntityAlias attribute.
SamlConfiguration.Builder	linkText(String linkText) Initializes the value for the linkText attribute.
SamlConfiguration.Builder	metaDataLocation(String metaDataLocation) Initializes the value for the metaDataLocation attribute.
SamlConfiguration.Builder	metadataTrustCheck(Boolean metadataTrustCheck) Initializes the value for the metadataTrustCheck attribute.
SamlConfiguration.Builder	nameId(String nameId) Initializes the value for the nameId attribute.
SamlConfiguration.Builder	providerDescription(String providerDescription) Initializes the value for the providerDescription attribute.
SamlConfiguration.Builder	showSamlLink(Boolean showSamlLink) Initializes the value for the showSamlLink attribute.
SamlConfiguration.Builder	skipSslValidation(Boolean skipSslValidation) Initializes the value for the skipSslValidation attribute.
SamlConfiguration.Builder	socketFactoryClassName(String socketFactoryClassName) Initializes the value for the socketFactoryClassName attribute.
SamlConfiguration.Builder	storeCustomAttributes(Boolean storeCustomAttributes) Initializes the value for the storeCustomAttributes attribute.
SamlConfiguration.Builder	zoneId(String zoneId) Initializes the value for the zoneId attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

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

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final SamlConfiguration.Builder from(org.cloudfoundry.uaa.identityproviders._SamlConfiguration instance)

Copy abstract value type _SamlConfiguration instance into builder.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

emailDomain

public final SamlConfiguration.Builder emailDomain(String element)

Adds one element to emailDomains list.

Parameters:

element - A emailDomains element

Returns:

this builder for use in a chained invocation

emailDomains

public final SamlConfiguration.Builder emailDomains(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 SamlConfiguration.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 SamlConfiguration.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 SamlConfiguration.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

attributeMappings

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

addShadowUserOnLogin

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

assertionConsumerIndex

public final SamlConfiguration.Builder assertionConsumerIndex(Integer assertionConsumerIndex)

Initializes the value for the assertionConsumerIndex attribute.

Parameters:

assertionConsumerIndex - The value for assertionConsumerIndex (can be null)

Returns:

this builder for use in a chained invocation

authnContext

public final SamlConfiguration.Builder authnContext(String element)

Adds one element to authnContext list.

Parameters:

element - A authnContext element

Returns:

this builder for use in a chained invocation

authnContext

public final SamlConfiguration.Builder authnContext(String... elements)

Adds elements to authnContext list.

Parameters:

elements - An array of authnContext elements

Returns:

this builder for use in a chained invocation

authnContext

public final SamlConfiguration.Builder authnContext(Iterable<String> elements)

Sets or replaces all elements for authnContext list.

Parameters:

elements - An iterable of authnContext elements

Returns:

this builder for use in a chained invocation

addAllAuthnContext

public final SamlConfiguration.Builder addAllAuthnContext(Iterable<String> elements)

Adds elements to authnContext list.

Parameters:

elements - An iterable of authnContext elements

Returns:

this builder for use in a chained invocation

groupMappingMode

public final SamlConfiguration.Builder groupMappingMode(ExternalGroupMappingMode groupMappingMode)

Initializes the value for the groupMappingMode attribute.

Parameters:

groupMappingMode - The value for groupMappingMode (can be null)

Returns:

this builder for use in a chained invocation

iconUrl

public final SamlConfiguration.Builder iconUrl(String iconUrl)

Initializes the value for the iconUrl attribute.

Parameters:

iconUrl - The value for iconUrl (can be null)

Returns:

this builder for use in a chained invocation

idpEntityAlias

public final SamlConfiguration.Builder idpEntityAlias(String idpEntityAlias)

Initializes the value for the idpEntityAlias attribute.

Parameters:

idpEntityAlias - The value for idpEntityAlias (can be null)

Returns:

this builder for use in a chained invocation

linkText

public final SamlConfiguration.Builder linkText(String 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

metaDataLocation

public final SamlConfiguration.Builder metaDataLocation(String metaDataLocation)

Initializes the value for the metaDataLocation attribute.

Parameters:

metaDataLocation - The value for metaDataLocation

Returns:

this builder for use in a chained invocation

metadataTrustCheck

public final SamlConfiguration.Builder metadataTrustCheck(Boolean metadataTrustCheck)

Initializes the value for the metadataTrustCheck attribute.

Parameters:

metadataTrustCheck - The value for metadataTrustCheck (can be null)

Returns:

this builder for use in a chained invocation

nameId

public final SamlConfiguration.Builder nameId(String nameId)

Initializes the value for the nameId attribute.

Parameters:

nameId - The value for nameId (can be null)

Returns:

this builder for use in a chained invocation

showSamlLink

public final SamlConfiguration.Builder showSamlLink(Boolean showSamlLink)

Initializes the value for the showSamlLink attribute.

Parameters:

showSamlLink - The value for showSamlLink (can be null)

Returns:

this builder for use in a chained invocation

skipSslValidation

public final SamlConfiguration.Builder skipSslValidation(Boolean skipSslValidation)

Initializes the value for the skipSslValidation attribute.

Parameters:

skipSslValidation - The value for skipSslValidation (can be null)

Returns:

this builder for use in a chained invocation

socketFactoryClassName

public final SamlConfiguration.Builder socketFactoryClassName(String socketFactoryClassName)

Initializes the value for the socketFactoryClassName attribute.

Parameters:

socketFactoryClassName - The value for socketFactoryClassName (can be null)

Returns:

this builder for use in a chained invocation

zoneId

public final SamlConfiguration.Builder zoneId(String zoneId)

Initializes the value for the zoneId attribute.

Parameters:

zoneId - The value for zoneId (can be null)

Returns:

this builder for use in a chained invocation

build

public SamlConfiguration build()

Builds a new SamlConfiguration.

Returns:

An immutable instance of SamlConfiguration

Throws:

IllegalStateException - if any required attributes are missing