org.cloudfoundry.uaa.identityproviders

Class LdapConfiguration.Builder

java.lang.Object

org.cloudfoundry.uaa.identityproviders.LdapConfiguration.Builder

Enclosing class:

LdapConfiguration

public static final class LdapConfiguration.Builder
extends Object

Builds instances of type LdapConfiguration. 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
LdapConfiguration.Builder	addAllEmailDomains(Iterable<String> elements) Adds elements to emailDomains list.
LdapConfiguration.Builder	addAllExternalGroupsWhitelist(Iterable<String> elements) Adds elements to externalGroupsWhitelist list.
LdapConfiguration.Builder	addShadowUserOnLogin(Boolean addShadowUserOnLogin) Initializes the value for the addShadowUserOnLogin attribute.
LdapConfiguration.Builder	attributeMappings(AttributeMappings attributeMappings) Initializes the value for the attributeMappings attribute.
LdapConfiguration.Builder	autoAddGroups(Boolean autoAddGroups) Initializes the value for the autoAddGroups attribute.
LdapConfiguration.Builder	baseUrl(String baseUrl) Initializes the value for the baseUrl attribute.
LdapConfiguration.Builder	bindPassword(String bindPassword) Initializes the value for the bindPassword attribute.
LdapConfiguration.Builder	bindUserDistinguishedName(String bindUserDistinguishedName) Initializes the value for the bindUserDistinguishedName attribute.
LdapConfiguration	build() Builds a new LdapConfiguration.
LdapConfiguration.Builder	emailDomain(String... elements) Adds elements to emailDomains list.
LdapConfiguration.Builder	emailDomain(String element) Adds one element to emailDomains list.
LdapConfiguration.Builder	emailDomains(Iterable<String> elements) Sets or replaces all elements for emailDomains list.
LdapConfiguration.Builder	externalGroupsWhitelist(Iterable<String> elements) Sets or replaces all elements for externalGroupsWhitelist list.
LdapConfiguration.Builder	externalGroupsWhitelist(String... elements) Adds elements to externalGroupsWhitelist list.
LdapConfiguration.Builder	externalGroupsWhitelist(String element) Adds one element to externalGroupsWhitelist list.
LdapConfiguration.Builder	from(org.cloudfoundry.uaa.identityproviders.AbstractExternalIdentityProviderConfiguration instance) Fill a builder with attribute values from the provided org.cloudfoundry.uaa.identityproviders.AbstractExternalIdentityProviderConfiguration instance.
LdapConfiguration.Builder	from(org.cloudfoundry.uaa.identityproviders.AbstractIdentityProviderConfiguration instance) Fill a builder with attribute values from the provided org.cloudfoundry.uaa.identityproviders.AbstractIdentityProviderConfiguration instance.
LdapConfiguration.Builder	from(LdapConfiguration instance) Fill a builder with attribute values from the provided LdapConfiguration instance.
LdapConfiguration.Builder	groupRoleAttribute(String groupRoleAttribute) Initializes the value for the groupRoleAttribute attribute.
LdapConfiguration.Builder	groupSearchBase(String groupSearchBase) Initializes the value for the groupSearchBase attribute.
LdapConfiguration.Builder	groupSearchDepthLimit(Integer groupSearchDepthLimit) Initializes the value for the groupSearchDepthLimit attribute.
LdapConfiguration.Builder	groupSearchFilter(String groupSearchFilter) Initializes the value for the groupSearchFilter attribute.
LdapConfiguration.Builder	groupSearchSubTree(Boolean groupSearchSubTree) Initializes the value for the groupSearchSubTree attribute.
LdapConfiguration.Builder	groupsIgnorePartialResults(Boolean groupsIgnorePartialResults) Initializes the value for the groupsIgnorePartialResults attribute.
LdapConfiguration.Builder	ldapGroupFile(LdapGroupFile ldapGroupFile) Initializes the value for the ldapGroupFile attribute.
LdapConfiguration.Builder	ldapProfileFile(LdapProfileFile ldapProfileFile) Initializes the value for the ldapProfileFile attribute.
LdapConfiguration.Builder	localPasswordCompare(Boolean localPasswordCompare) Initializes the value for the localPasswordCompare attribute.
LdapConfiguration.Builder	mailAttributeName(String mailAttributeName) Initializes the value for the mailAttributeName attribute.
LdapConfiguration.Builder	mailSubstitute(String mailSubstitute) Initializes the value for the mailSubstitute attribute.
LdapConfiguration.Builder	mailSubstituteOverridesLdap(Boolean mailSubstituteOverridesLdap) Initializes the value for the mailSubstituteOverridesLdap attribute.
LdapConfiguration.Builder	passwordAttributeName(String passwordAttributeName) Initializes the value for the passwordAttributeName attribute.
LdapConfiguration.Builder	passwordEncoder(String passwordEncoder) Initializes the value for the passwordEncoder attribute.
LdapConfiguration.Builder	providerDescription(String providerDescription) Initializes the value for the providerDescription attribute.
LdapConfiguration.Builder	referral(String referral) Initializes the value for the referral attribute.
LdapConfiguration.Builder	skipSSLVerification(Boolean skipSSLVerification) Initializes the value for the skipSSLVerification attribute.
LdapConfiguration.Builder	storeCustomAttributes(Boolean storeCustomAttributes) Initializes the value for the storeCustomAttributes attribute.
LdapConfiguration.Builder	tlsConfiguration(TlsConfiguration tlsConfiguration) Initializes the value for the tlsConfiguration attribute.
LdapConfiguration.Builder	userDistinguishedNamePattern(String userDistinguishedNamePattern) Initializes the value for the userDistinguishedNamePattern attribute.
LdapConfiguration.Builder	userDistinguishedNamePatternDelimiter(String userDistinguishedNamePatternDelimiter) Initializes the value for the userDistinguishedNamePatternDelimiter attribute.
LdapConfiguration.Builder	userSearchBase(String userSearchBase) Initializes the value for the userSearchBase attribute.
LdapConfiguration.Builder	userSearchFilter(String userSearchFilter) Initializes the value for the userSearchFilter attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

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

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

addShadowUserOnLogin

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

autoAddGroups

public final LdapConfiguration.Builder autoAddGroups(Boolean autoAddGroups)

Initializes the value for the autoAddGroups attribute.

Parameters:

autoAddGroups - The value for autoAddGroups (can be null)

Returns:

this builder for use in a chained invocation

baseUrl

public final LdapConfiguration.Builder baseUrl(String baseUrl)

Initializes the value for the baseUrl attribute.

Parameters:

baseUrl - The value for baseUrl

Returns:

this builder for use in a chained invocation

bindPassword

public final LdapConfiguration.Builder bindPassword(String bindPassword)

Initializes the value for the bindPassword attribute.

Parameters:

bindPassword - The value for bindPassword (can be null)

Returns:

this builder for use in a chained invocation

bindUserDistinguishedName

public final LdapConfiguration.Builder bindUserDistinguishedName(String bindUserDistinguishedName)

Initializes the value for the bindUserDistinguishedName attribute.

Parameters:

bindUserDistinguishedName - The value for bindUserDistinguishedName (can be null)

Returns:

this builder for use in a chained invocation

groupRoleAttribute

public final LdapConfiguration.Builder groupRoleAttribute(String groupRoleAttribute)

Initializes the value for the groupRoleAttribute attribute.

Parameters:

groupRoleAttribute - The value for groupRoleAttribute (can be null)

Returns:

this builder for use in a chained invocation

groupSearchBase

public final LdapConfiguration.Builder groupSearchBase(String groupSearchBase)

Initializes the value for the groupSearchBase attribute.

Parameters:

groupSearchBase - The value for groupSearchBase (can be null)

Returns:

this builder for use in a chained invocation

groupSearchDepthLimit

public final LdapConfiguration.Builder groupSearchDepthLimit(Integer groupSearchDepthLimit)

Initializes the value for the groupSearchDepthLimit attribute.

Parameters:

groupSearchDepthLimit - The value for groupSearchDepthLimit (can be null)

Returns:

this builder for use in a chained invocation

groupSearchFilter

public final LdapConfiguration.Builder groupSearchFilter(String groupSearchFilter)

Initializes the value for the groupSearchFilter attribute.

Parameters:

groupSearchFilter - The value for groupSearchFilter (can be null)

Returns:

this builder for use in a chained invocation

groupSearchSubTree

public final LdapConfiguration.Builder groupSearchSubTree(Boolean groupSearchSubTree)

Initializes the value for the groupSearchSubTree attribute.

Parameters:

groupSearchSubTree - The value for groupSearchSubTree (can be null)

Returns:

this builder for use in a chained invocation

groupsIgnorePartialResults

public final LdapConfiguration.Builder groupsIgnorePartialResults(Boolean groupsIgnorePartialResults)

Initializes the value for the groupsIgnorePartialResults attribute.

Parameters:

groupsIgnorePartialResults - The value for groupsIgnorePartialResults (can be null)

Returns:

this builder for use in a chained invocation

ldapGroupFile

public final LdapConfiguration.Builder ldapGroupFile(LdapGroupFile ldapGroupFile)

Initializes the value for the ldapGroupFile attribute.

Parameters:

ldapGroupFile - The value for ldapGroupFile

Returns:

this builder for use in a chained invocation

ldapProfileFile

public final LdapConfiguration.Builder ldapProfileFile(LdapProfileFile ldapProfileFile)

Initializes the value for the ldapProfileFile attribute.

Parameters:

ldapProfileFile - The value for ldapProfileFile

Returns:

this builder for use in a chained invocation

localPasswordCompare

public final LdapConfiguration.Builder localPasswordCompare(Boolean localPasswordCompare)

Initializes the value for the localPasswordCompare attribute.

Parameters:

localPasswordCompare - The value for localPasswordCompare (can be null)

Returns:

this builder for use in a chained invocation

mailAttributeName

public final LdapConfiguration.Builder mailAttributeName(String mailAttributeName)

Initializes the value for the mailAttributeName attribute.

Parameters:

mailAttributeName - The value for mailAttributeName (can be null)

Returns:

this builder for use in a chained invocation

mailSubstitute

public final LdapConfiguration.Builder mailSubstitute(String mailSubstitute)

Initializes the value for the mailSubstitute attribute.

Parameters:

mailSubstitute - The value for mailSubstitute (can be null)

Returns:

this builder for use in a chained invocation

mailSubstituteOverridesLdap

public final LdapConfiguration.Builder mailSubstituteOverridesLdap(Boolean mailSubstituteOverridesLdap)

Initializes the value for the mailSubstituteOverridesLdap attribute.

Parameters:

mailSubstituteOverridesLdap - The value for mailSubstituteOverridesLdap (can be null)

Returns:

this builder for use in a chained invocation

passwordAttributeName

public final LdapConfiguration.Builder passwordAttributeName(String passwordAttributeName)

Initializes the value for the passwordAttributeName attribute.

Parameters:

passwordAttributeName - The value for passwordAttributeName (can be null)

Returns:

this builder for use in a chained invocation

passwordEncoder

public final LdapConfiguration.Builder passwordEncoder(String passwordEncoder)

Initializes the value for the passwordEncoder attribute.

Parameters:

passwordEncoder - The value for passwordEncoder (can be null)

Returns:

this builder for use in a chained invocation

referral

public final LdapConfiguration.Builder referral(String referral)

Initializes the value for the referral attribute.

Parameters:

referral - The value for referral (can be null)

Returns:

this builder for use in a chained invocation

skipSSLVerification

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

tlsConfiguration

public final LdapConfiguration.Builder tlsConfiguration(TlsConfiguration tlsConfiguration)

Initializes the value for the tlsConfiguration attribute.

Parameters:

tlsConfiguration - The value for tlsConfiguration (can be null)

Returns:

this builder for use in a chained invocation

userDistinguishedNamePattern

public final LdapConfiguration.Builder userDistinguishedNamePattern(String userDistinguishedNamePattern)

Initializes the value for the userDistinguishedNamePattern attribute.

Parameters:

userDistinguishedNamePattern - The value for userDistinguishedNamePattern (can be null)

Returns:

this builder for use in a chained invocation

userDistinguishedNamePatternDelimiter

public final LdapConfiguration.Builder userDistinguishedNamePatternDelimiter(String userDistinguishedNamePatternDelimiter)

Initializes the value for the userDistinguishedNamePatternDelimiter attribute.

Parameters:

userDistinguishedNamePatternDelimiter - The value for userDistinguishedNamePatternDelimiter (can be null)

Returns:

this builder for use in a chained invocation

userSearchBase

public final LdapConfiguration.Builder userSearchBase(String userSearchBase)

Initializes the value for the userSearchBase attribute.

Parameters:

userSearchBase - The value for userSearchBase (can be null)

Returns:

this builder for use in a chained invocation

userSearchFilter

public final LdapConfiguration.Builder userSearchFilter(String userSearchFilter)

Initializes the value for the userSearchFilter attribute.

Parameters:

userSearchFilter - The value for userSearchFilter (can be null)

Returns:

this builder for use in a chained invocation

attributeMappings

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

Builds a new LdapConfiguration.

Returns:

An immutable instance of LdapConfiguration

Throws:

IllegalStateException - if any required attributes are missing