LdapConfiguration (Cloud Foundry Java Client 3.12.0.RELEASE API)

java.lang.Object
- org.cloudfoundry.uaa.identityproviders.LdapConfiguration

All Implemented Interfaces:: IdentityProviderConfiguration

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class LdapConfiguration
extends Object

The payload for the ldap identity provider configuration

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LdapConfiguration.Builder
Builds instances of type LdapConfiguration.

Nested Classes
Modifier and Type	Class and Description
`static class`	`LdapConfiguration.Builder` Builds instances of type `LdapConfiguration`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LdapConfiguration.Builder`	`builder()` Creates a builder for `LdapConfiguration`.
`boolean`	`equals(Object another)` This instance is equal to all instances of `LdapConfiguration` that have equal attribute values.
`Boolean`	`getAddShadowUserOnLogin()` Determines whether or not shadow users must be created before login by an administrator.
`AttributeMappings`	`getAttributeMappings()`
`Boolean`	`getAutoAddGroups()` The auto add group flag
`String`	`getBaseUrl()` The URL to the ldap server, must start with ldap:// or ldaps://
`String`	`getBindPassword()` If you specified BindUserDN, then specify the corresponding password to be used for binding here.
`String`	`getBindUserDistinguishedName()` The distinguished name the gatekeeper uses to bind to the LDAP server.
`List<String>`	`getEmailDomains()` List of email domains associated with the provider for the purpose of associating users to the correct origin upon invitation.
`List<String>`	`getExternalGroupsWhitelist()` The external group white list
`String`	`getGroupRoleAttribute()` The group role attribute
`String`	`getGroupSearchBase()` The group search base
`Integer`	`getGroupSearchDepthLimit()` The maximum group search depth limit
`String`	`getGroupSearchFilter()` The group search filter
`Boolean`	`getGroupSearchSubTree()` The group search subtree
`Boolean`	`getGroupsIgnorePartialResults()` The group ignore partial search result flag
`LdapGroupFile`	`getLdapGroupFile()` The file to be used for group integration.
`LdapProfileFile`	`getLdapProfileFile()` The file to be used for configuring the LDAP authentication.
`Boolean`	`getLocalPasswordCompare()`
`String`	`getMailAttributeName()` The name of the LDAP attribute that contains the user’s email address
`String`	`getMailSubstitute()` Defines an email pattern containing a {0} to generate an email address for an LDAP user during authentication
`Boolean`	`getMailSubstituteOverridesLdap()` Set to true if you wish to override an LDAP user email address with a generated one
`String`	`getPasswordAttributeName()` The password attribute name
`String`	`getPasswordEncoder()` The password encoder
`String`	`getProviderDescription()` Human readable name/description of this provider
`String`	`getReferral()` Configures the UAA LDAP referral behavior.
`Boolean`	`getSkipSSLVerification()` Skips validation of the LDAP cert if set to true.
`Boolean`	`getStoreCustomAttributes()` Set to true, to store custom user attributes to be fetched from the /userinfo endpoint
`TlsConfiguration`	`getTlsConfiguration()` The StartTLS options
`String`	`getUserDistinguishedNamePattern()` The user distinguished name pattern
`String`	`getUserDistinguishedNamePatternDelimiter()` The user distinguished name pattern delimiter
`String`	`getUserSearchBase()` The user search base
`String`	`getUserSearchFilter()` The user search filter
`int`	`hashCode()` Computes a hash code from attributes: `addShadowUserOnLogin`, `autoAddGroups`, `baseUrl`, `bindPassword`, `bindUserDistinguishedName`, `groupRoleAttribute`, `groupSearchBase`, `groupSearchDepthLimit`, `groupSearchFilter`, `groupSearchSubTree`, `groupsIgnorePartialResults`, `ldapGroupFile`, `ldapProfileFile`, `localPasswordCompare`, `mailAttributeName`, `mailSubstitute`, `mailSubstituteOverridesLdap`, `passwordAttributeName`, `passwordEncoder`, `referral`, `skipSSLVerification`, `tlsConfiguration`, `userDistinguishedNamePattern`, `userDistinguishedNamePatternDelimiter`, `userSearchBase`, `userSearchFilter`, `attributeMappings`, `externalGroupsWhitelist`, `storeCustomAttributes`, `emailDomains`, `providerDescription`.
`String`	`toString()` Prints the immutable value `LdapConfiguration` with attribute values.

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

- Method Detail
  - getAddShadowUserOnLogin
```
public Boolean getAddShadowUserOnLogin()
```
    Determines whether or not shadow users must be created before login by an administrator.
  - getAutoAddGroups
```
public Boolean getAutoAddGroups()
```
    The auto add group flag
  - getBaseUrl
```
public String getBaseUrl()
```
    The URL to the ldap server, must start with ldap:// or ldaps://
  - getBindPassword
```
public String getBindPassword()
```
    If you specified BindUserDN, then specify the corresponding password to be used for binding here.
  - getBindUserDistinguishedName
```
public String getBindUserDistinguishedName()
```
    The distinguished name the gatekeeper uses to bind to the LDAP server.
  - getGroupRoleAttribute
```
public String getGroupRoleAttribute()
```
    The group role attribute
  - getGroupSearchBase
```
public String getGroupSearchBase()
```
    The group search base
  - getGroupSearchDepthLimit
```
public Integer getGroupSearchDepthLimit()
```
    The maximum group search depth limit
  - getGroupSearchFilter
```
public String getGroupSearchFilter()
```
    The group search filter
  - getGroupSearchSubTree
```
public Boolean getGroupSearchSubTree()
```
    The group search subtree
  - getGroupsIgnorePartialResults
```
public Boolean getGroupsIgnorePartialResults()
```
    The group ignore partial search result flag
  - getLdapGroupFile
```
public LdapGroupFile getLdapGroupFile()
```
    The file to be used for group integration.
  - getLdapProfileFile
```
public LdapProfileFile getLdapProfileFile()
```
    The file to be used for configuring the LDAP authentication.
  - getLocalPasswordCompare
```
public Boolean getLocalPasswordCompare()
```
    Returns:
    
    The value of the localPasswordCompare attribute
  - getMailAttributeName
```
public String getMailAttributeName()
```
    The name of the LDAP attribute that contains the user’s email address
  - getMailSubstitute
```
public String getMailSubstitute()
```
    Defines an email pattern containing a {0} to generate an email address for an LDAP user during authentication
  - getMailSubstituteOverridesLdap
```
public Boolean getMailSubstituteOverridesLdap()
```
    Set to true if you wish to override an LDAP user email address with a generated one
  - getPasswordAttributeName
```
public String getPasswordAttributeName()
```
    The password attribute name
  - getPasswordEncoder
```
public String getPasswordEncoder()
```
    The password encoder
  - getReferral
```
public String getReferral()
```
    Configures the UAA LDAP referral behavior. The following values are possible: - follow → Referrals are followed - ignore → Referrals are ignored and the partial result is returned - throw → An error is thrown and the authentication is aborted
  - getSkipSSLVerification
```
public Boolean getSkipSSLVerification()
```
    Skips validation of the LDAP cert if set to true.
  - getTlsConfiguration
```
public TlsConfiguration getTlsConfiguration()
```
    The StartTLS options
  - getUserDistinguishedNamePattern
```
public String getUserDistinguishedNamePattern()
```
    The user distinguished name pattern
  - getUserDistinguishedNamePatternDelimiter
```
public String getUserDistinguishedNamePatternDelimiter()
```
    The user distinguished name pattern delimiter
  - getUserSearchBase
```
public String getUserSearchBase()
```
    The user search base
  - getUserSearchFilter
```
public String getUserSearchFilter()
```
    The user search filter
  - getAttributeMappings
```
public AttributeMappings getAttributeMappings()
```
    Returns:
    
    The value of the attributeMappings attribute
  - getExternalGroupsWhitelist
```
public List<String> getExternalGroupsWhitelist()
```
    The external group white list
  - getStoreCustomAttributes
```
public Boolean getStoreCustomAttributes()
```
    Set to true, to store custom user attributes to be fetched from the /userinfo endpoint
  - getEmailDomains
```
public List<String> getEmailDomains()
```
    List of email domains associated with the provider for the purpose of associating users to the correct origin upon invitation. If empty list, no invitations are accepted. Wildcards supported.
  - getProviderDescription
```
public String getProviderDescription()
```
    Human readable name/description of this provider
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of LdapConfiguration that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: addShadowUserOnLogin, autoAddGroups, baseUrl, bindPassword, bindUserDistinguishedName, groupRoleAttribute, groupSearchBase, groupSearchDepthLimit, groupSearchFilter, groupSearchSubTree, groupsIgnorePartialResults, ldapGroupFile, ldapProfileFile, localPasswordCompare, mailAttributeName, mailSubstitute, mailSubstituteOverridesLdap, passwordAttributeName, passwordEncoder, referral, skipSSLVerification, tlsConfiguration, userDistinguishedNamePattern, userDistinguishedNamePatternDelimiter, userSearchBase, userSearchFilter, attributeMappings, externalGroupsWhitelist, storeCustomAttributes, emailDomains, providerDescription.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value LdapConfiguration with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - builder
```
public static LdapConfiguration.Builder builder()
```
    Creates a builder for LdapConfiguration.
    
    Returns:
    
    A new LdapConfiguration builder

Class LdapConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAddShadowUserOnLogin

getAutoAddGroups

getBaseUrl

getBindPassword

getBindUserDistinguishedName

getGroupRoleAttribute

getGroupSearchBase

getGroupSearchDepthLimit

getGroupSearchFilter

getGroupSearchSubTree

getGroupsIgnorePartialResults

getLdapGroupFile

getLdapProfileFile

getLocalPasswordCompare

getMailAttributeName

getMailSubstitute

getMailSubstituteOverridesLdap

getPasswordAttributeName

getPasswordEncoder

getReferral

getSkipSSLVerification

getTlsConfiguration

getUserDistinguishedNamePattern

getUserDistinguishedNamePatternDelimiter

getUserSearchBase

getUserSearchFilter

getAttributeMappings

getExternalGroupsWhitelist

getStoreCustomAttributes

getEmailDomains

getProviderDescription

equals

hashCode

toString

builder