SamlConfiguration (Cloud Foundry Java Client 4.14.0.RELEASE API)

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

All Implemented Interfaces:: IdentityProviderConfiguration

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

The payload for the saml identity provider configuration

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SamlConfiguration.Builder
Builds instances of type SamlConfiguration.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SamlConfiguration.Builder`	`builder()` Creates a builder for `SamlConfiguration`.
`boolean`	`equals(Object another)` This instance is equal to all instances of `SamlConfiguration` that have equal attribute values.
`Boolean`	`getAddShadowUserOnLogin()` Determines whether or not shadow users must be created before login by an administrator.
`Integer`	`getAssertionConsumerIndex()` SAML assertion consumer index, default is 0
`AttributeMappings`	`getAttributeMappings()`
`List<String>`	`getAuthnContext()` A list of AuthnContextClassRef to include in the SAML request
`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
`ExternalGroupMappingMode`	`getGroupMappingMode()` Either EXPLICITLY_MAPPED in order to map external groups to OAuth scopes using the group mappings, or AS_SCOPES to use SAML group names as scopes.
`String`	`getIconUrl()` Reserved for future use
`String`	`getIdpEntityAlias()` This will be set to origin by system
`String`	`getLinkText()` The link text for the SAML IDP on the login page
`String`	`getMetaDataLocation()` SAML Metadata - either an XML string or a URL that will deliver XML content
`Boolean`	`getMetadataTrustCheck()` Should metadata be validated, defaults to false
`String`	`getNameId()` The name ID to use for the username, default is “urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified”.
`String`	`getProviderDescription()` Human readable name/description of this provider
`Boolean`	`getShowSamlLink()` Should the SAML login link be displayed on the login page, defaults to false
`Boolean`	`getSkipSslValidation()` Whether to skip SSL validation
`String`	`getSocketFactoryClassName()` Either "org.apache.commons.httpclient.protocol.DefaultProtocolSocketFactory" or"org.apache.commons.httpclient.contrib.ssl.EasySSLProtocolSocketFactory" depending on if the metaDataLocation of type URL is HTTP or HTTPS, respectively
`Boolean`	`getStoreCustomAttributes()` Set to true, to store custom user attributes to be fetched from the /userinfo endpoint
`String`	`getZoneId()` This will be set to the ID of the zone where the provider is being created by system
`int`	`hashCode()` Computes a hash code from attributes: `emailDomains`, `providerDescription`, `attributeMappings`, `externalGroupsWhitelist`, `storeCustomAttributes`, `addShadowUserOnLogin`, `assertionConsumerIndex`, `authnContext`, `groupMappingMode`, `iconUrl`, `idpEntityAlias`, `linkText`, `metaDataLocation`, `metadataTrustCheck`, `nameId`, `showSamlLink`, `skipSslValidation`, `socketFactoryClassName`, `zoneId`.
`String`	`toString()` Prints the immutable value `SamlConfiguration` with attribute values.

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

- Method Detail
  - 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
  - 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
  - getAddShadowUserOnLogin
```
public Boolean getAddShadowUserOnLogin()
```
    Determines whether or not shadow users must be created before login by an administrator.
  - getAssertionConsumerIndex
```
public Integer getAssertionConsumerIndex()
```
    SAML assertion consumer index, default is 0
  - getAuthnContext
```
public List<String> getAuthnContext()
```
    A list of AuthnContextClassRef to include in the SAML request
  - getGroupMappingMode
```
public ExternalGroupMappingMode getGroupMappingMode()
```
    Either EXPLICITLY_MAPPED in order to map external groups to OAuth scopes using the group mappings, or AS_SCOPES to use SAML group names as scopes.
  - getIconUrl
```
public String getIconUrl()
```
    Reserved for future use
  - getIdpEntityAlias
```
public String getIdpEntityAlias()
```
    This will be set to origin by system
  - getLinkText
```
public String getLinkText()
```
    The link text for the SAML IDP on the login page
  - getMetaDataLocation
```
public String getMetaDataLocation()
```
    SAML Metadata - either an XML string or a URL that will deliver XML content
  - getMetadataTrustCheck
```
public Boolean getMetadataTrustCheck()
```
    Should metadata be validated, defaults to false
  - getNameId
```
public String getNameId()
```
    The name ID to use for the username, default is “urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified”.
  - getShowSamlLink
```
public Boolean getShowSamlLink()
```
    Should the SAML login link be displayed on the login page, defaults to false
  - getSkipSslValidation
```
public Boolean getSkipSslValidation()
```
    Whether to skip SSL validation
  - getSocketFactoryClassName
```
public String getSocketFactoryClassName()
```
    Either "org.apache.commons.httpclient.protocol.DefaultProtocolSocketFactory" or"org.apache.commons.httpclient.contrib.ssl.EasySSLProtocolSocketFactory" depending on if the metaDataLocation of type URL is HTTP or HTTPS, respectively
  - getZoneId
```
public String getZoneId()
```
    This will be set to the ID of the zone where the provider is being created by system
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of SamlConfiguration 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: emailDomains, providerDescription, attributeMappings, externalGroupsWhitelist, storeCustomAttributes, addShadowUserOnLogin, assertionConsumerIndex, authnContext, groupMappingMode, iconUrl, idpEntityAlias, linkText, metaDataLocation, metadataTrustCheck, nameId, showSamlLink, skipSslValidation, socketFactoryClassName, zoneId.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value SamlConfiguration with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - builder
```
public static SamlConfiguration.Builder builder()
```
    Creates a builder for SamlConfiguration.
```
 SamlConfiguration.builder()
    .emailDomains(List&lt;String&gt; | null) // nullable emailDomains
    .providerDescription(String | null) // nullable providerDescription
    .attributeMappings(org.cloudfoundry.uaa.identityproviders.AttributeMappings | null) // nullable attributeMappings
    .externalGroupsWhitelist(List&lt;String&gt; | null) // nullable externalGroupsWhitelist
    .storeCustomAttributes(Boolean | null) // nullable storeCustomAttributes
    .addShadowUserOnLogin(Boolean | null) // nullable addShadowUserOnLogin
    .assertionConsumerIndex(Integer | null) // nullable assertionConsumerIndex
    .authnContext(List&lt;String&gt; | null) // nullable authnContext
    .groupMappingMode(org.cloudfoundry.uaa.identityproviders.ExternalGroupMappingMode | null) // nullable groupMappingMode
    .iconUrl(String | null) // nullable iconUrl
    .idpEntityAlias(String | null) // nullable idpEntityAlias
    .linkText(String | null) // nullable linkText
    .metaDataLocation(String) // required metaDataLocation
    .metadataTrustCheck(Boolean | null) // nullable metadataTrustCheck
    .nameId(String | null) // nullable nameId
    .showSamlLink(Boolean | null) // nullable showSamlLink
    .skipSslValidation(Boolean | null) // nullable skipSslValidation
    .socketFactoryClassName(String | null) // nullable socketFactoryClassName
    .zoneId(String | null) // nullable zoneId
    .build();
 
```
    Returns:
    
    A new SamlConfiguration builder

Class SamlConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getEmailDomains

getProviderDescription

getAttributeMappings

getExternalGroupsWhitelist

getStoreCustomAttributes

getAddShadowUserOnLogin

getAssertionConsumerIndex

getAuthnContext

getGroupMappingMode

getIconUrl

getIdpEntityAlias

getLinkText

getMetaDataLocation

getMetadataTrustCheck

getNameId

getShowSamlLink

getSkipSslValidation

getSocketFactoryClassName

getZoneId

equals

hashCode

toString

builder