org.cloudfoundry.identity.uaa.provider

Class ExternalIdentityProviderDefinition

java.lang.Object

org.cloudfoundry.identity.uaa.provider.AbstractIdentityProviderDefinition

org.cloudfoundry.identity.uaa.provider.ExternalIdentityProviderDefinition

Direct Known Subclasses:

AbstractXOAuthIdentityProviderDefinition, KeystoneIdentityProviderDefinition, LdapIdentityProviderDefinition, SamlIdentityProviderDefinition

public class ExternalIdentityProviderDefinition
extends AbstractIdentityProviderDefinition

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_MAPPINGS
static java.lang.String	EMAIL_ATTRIBUTE_NAME
static java.lang.String	EXTERNAL_GROUPS_WHITELIST
static java.lang.String	FAMILY_NAME_ATTRIBUTE_NAME
static java.lang.String	GIVEN_NAME_ATTRIBUTE_NAME
static java.lang.String	GROUP_ATTRIBUTE_NAME
static java.lang.String	PHONE_NUMBER_ATTRIBUTE_NAME
static java.lang.String	STORE_CUSTOM_ATTRIBUTES_NAME
static java.lang.String	USER_ATTRIBUTE_PREFIX
static java.lang.String	USER_NAME_ATTRIBUTE_NAME

Fields inherited from class org.cloudfoundry.identity.uaa.provider.AbstractIdentityProviderDefinition

EMAIL_DOMAIN_ATTR, PROVIDER_DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
ExternalIdentityProviderDefinition()

Method Summary

Modifier and Type	Method and Description
void	addAttributeMapping(java.lang.String key, java.lang.Object value) adds an attribute mapping, where the key is known to the UAA and the value represents the attribute name on the IDP
void	addWhiteListedGroup(java.lang.String group)
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.lang.Object>	getAttributeMappings()
java.util.List<java.lang.String>	getExternalGroupsWhitelist()
int	hashCode()
boolean	isAddShadowUserOnLogin()
boolean	isStoreCustomAttributes()
void	setAddShadowUserOnLogin(boolean addShadowUserOnLogin)
void	setAttributeMappings(java.util.Map<java.lang.String,java.lang.Object> attributeMappings)
void	setExternalGroupsWhitelist(java.util.List<java.lang.String> externalGroupsWhitelist)
void	setStoreCustomAttributes(boolean storeCustomAttributes)

Methods inherited from class org.cloudfoundry.identity.uaa.provider.AbstractIdentityProviderDefinition

getAdditionalConfiguration, getEmailDomain, getProviderDescription, setAdditionalConfiguration, setEmailDomain, setProviderDescription

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_ATTRIBUTE_NAME

public static final java.lang.String GROUP_ATTRIBUTE_NAME

See Also:

Constant Field Values

EMAIL_ATTRIBUTE_NAME

public static final java.lang.String EMAIL_ATTRIBUTE_NAME

See Also:

Constant Field Values

GIVEN_NAME_ATTRIBUTE_NAME

public static final java.lang.String GIVEN_NAME_ATTRIBUTE_NAME

See Also:

Constant Field Values

FAMILY_NAME_ATTRIBUTE_NAME

public static final java.lang.String FAMILY_NAME_ATTRIBUTE_NAME

See Also:

Constant Field Values

PHONE_NUMBER_ATTRIBUTE_NAME

public static final java.lang.String PHONE_NUMBER_ATTRIBUTE_NAME

See Also:

Constant Field Values

USER_ATTRIBUTE_PREFIX

public static final java.lang.String USER_ATTRIBUTE_PREFIX

See Also:

Constant Field Values

USER_NAME_ATTRIBUTE_NAME

public static final java.lang.String USER_NAME_ATTRIBUTE_NAME

See Also:

Constant Field Values

STORE_CUSTOM_ATTRIBUTES_NAME

public static final java.lang.String STORE_CUSTOM_ATTRIBUTES_NAME

See Also:

Constant Field Values

EXTERNAL_GROUPS_WHITELIST

public static final java.lang.String EXTERNAL_GROUPS_WHITELIST

See Also:

Constant Field Values

ATTRIBUTE_MAPPINGS

public static final java.lang.String ATTRIBUTE_MAPPINGS

See Also:

Constant Field Values

Constructor Detail

ExternalIdentityProviderDefinition

public ExternalIdentityProviderDefinition()

Method Detail

getExternalGroupsWhitelist

public java.util.List<java.lang.String> getExternalGroupsWhitelist()

setExternalGroupsWhitelist

public void setExternalGroupsWhitelist(java.util.List<java.lang.String> externalGroupsWhitelist)

addWhiteListedGroup

public void addWhiteListedGroup(java.lang.String group)

setAttributeMappings

public void setAttributeMappings(java.util.Map<java.lang.String,java.lang.Object> attributeMappings)

getAttributeMappings

public java.util.Map<java.lang.String,java.lang.Object> getAttributeMappings()

addAttributeMapping

public void addAttributeMapping(java.lang.String key,
                                java.lang.Object value)

adds an attribute mapping, where the key is known to the UAA and the value represents the attribute name on the IDP

Parameters:

key - - known to the UAA, such as EMAIL_ATTRIBUTE_NAME, GROUP_ATTRIBUTE_NAME, PHONE_NUMBER_ATTRIBUTE_NAME

value - - the name of the attribute on the IDP side, for example emailAddress

isAddShadowUserOnLogin

public boolean isAddShadowUserOnLogin()

setAddShadowUserOnLogin

public void setAddShadowUserOnLogin(boolean addShadowUserOnLogin)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AbstractIdentityProviderDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractIdentityProviderDefinition

isStoreCustomAttributes

public boolean isStoreCustomAttributes()

setStoreCustomAttributes

public void setStoreCustomAttributes(boolean storeCustomAttributes)