de.hybris.platform.ldap.jalo

Class LDAPConfigProxyItem

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.config.ConfigProxyItem

de.hybris.platform.ldap.jalo.LDAPConfigProxyItem

All Implemented Interfaces:

JaloOnlyItem, JaloOnlySingletonItem, java.io.Serializable, java.lang.Comparable

public class LDAPConfigProxyItem
extends ConfigProxyItem

A singleton used to manage the LDAP specific properties.properties settings.

Uses ConfigItem iternally to read/store config properties.

CAUTION: The configproxyitem persistence mechanism is currently not supported by the core !!! (so we are using the project.properties settings, here)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DELIMITER

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
LDAPConfigProxyItem()

Method Summary

Modifier and Type	Method and Description
void	dumpEnvironmentValues(java.util.Hashtable env)
EnumerationValue	getAuthentication()
java.lang.String	getCaCerts()
java.lang.String	getCaKeyStorePwd()
java.lang.String	getCaKeyStoreType()
java.lang.String	getClientCerts()
java.lang.String	getClientKeyStorePwd()
java.lang.String	getClientKeyStoreType()
char[]	getCredentials()
java.lang.String	getFactory()
int	getInitSize()
int	getJNDIConnectionTimeout()
java.util.Hashtable<java.lang.String,java.lang.String>	getJNDIEnvironment()
EnumerationValue	getJNDIVersion()
java.util.List	getLocalAccountsOnlyAsList()
java.lang.String	getLocalAccountsOnlyAsString()
java.lang.String	getLoginField()
int	getMaxRetries()
int	getMaxSize()
int	getMinFailbackTime() Set the current value for how many times servers will be tested (in total) before failing.
int	getPoolTimeOut()
int	getPrefSize()
java.lang.String	getPrincipal()
java.util.List<java.lang.String>	getProviderURLasList()
java.lang.String	getProviderURLasString()
java.lang.String	getRootDN()
java.lang.String	getSecurityProtocol()
java.util.List<java.util.Hashtable<java.lang.String,java.lang.String>>	getServerEnvironments() Build and return an array of DirContext environments.
java.lang.String	getSocketFactory()
boolean	getTracing()
boolean	getUsePooling()
boolean	isHybrisPoolingDisabled()
void	setAuthentication(EnumerationValue value)
void	setCaCerts(java.lang.String value)
void	setCaKeyStorePwd(java.lang.String value)
void	setCaKeyStoreType(java.lang.String value)
void	setClientCerts(java.lang.String value)
void	setClientKeyStorePwd(java.lang.String value)
void	setClientKeyStoreType(java.lang.String value)
void	setCredentials(char[] value)
void	setFactory(java.lang.String value)
void	setInitSize(java.lang.Integer value)
void	setJNDIConnectionTimeout(java.lang.Integer value)
void	setJNDIVersion(EnumerationValue value)
void	setLocalAccountsOnly(java.util.List value)
void	setLoginField(java.lang.String value)
void	setMaxSize(java.lang.Integer value)
void	setMinFailbackTime(java.lang.Integer minFailbackTime) Set the mimumim amount of time (ms) to wait before retrying the primary server in case of a failure.
void	setPoolTimeOut(java.lang.Integer value)
void	setPrefSize(java.lang.Integer value)
void	setPrincipal(java.lang.String value)
void	setProviderURL(java.util.List value)
void	setRootDN(java.lang.String rootDN)
void	setSecurityProtocol(java.lang.String value)
void	setSocketFactory(java.lang.String value)
void	setUsePooling(boolean value)
void	testConnection(LDAPConfigProxyItem config)

Methods inherited from class de.hybris.platform.jalo.config.ConfigProxyItem

booleanValue, createItem, doGetAttribute, doSetAttribute, getExternalQualifier, getInt, getPersistentValue, getTransientValue, getValue, getValue, integerValue, longValue, provideComposedType, provideCreationTime, provideModificationTime, providePK, removeJaloOnly, setPersistentValue, setTransientValue, setValue, setValue, storeInDatabase

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, createNonClassAccessor, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getDefaultAttributeModes, getImplementation, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getNonInitialAttributes, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isMarkModifiedDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

setTenant

Methods inherited from class java.lang.Object

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

Field Detail

DELIMITER

public static final java.lang.String DELIMITER

See Also:

Constant Field Values

Constructor Detail

LDAPConfigProxyItem

public LDAPConfigProxyItem()

Method Detail

getProviderURLasList

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

getProviderURLasString

public java.lang.String getProviderURLasString()

setProviderURL

public void setProviderURL(java.util.List value)

getLocalAccountsOnlyAsList

public java.util.List getLocalAccountsOnlyAsList()

getLocalAccountsOnlyAsString

public java.lang.String getLocalAccountsOnlyAsString()

setLocalAccountsOnly

public void setLocalAccountsOnly(java.util.List value)

isHybrisPoolingDisabled

public boolean isHybrisPoolingDisabled()

getServerEnvironments

public java.util.List<java.util.Hashtable<java.lang.String,java.lang.String>> getServerEnvironments()

Build and return an array of DirContext environments.

Returns:

An array of hashtables suitable for creating DirContext objects.

getMaxRetries

public int getMaxRetries()

Returns:

the max retry count.

getMinFailbackTime

public int getMinFailbackTime()

Set the current value for how many times servers will be tested (in total) before failing. If this method is not called, the class will default to three times the number of servers available.

setMinFailbackTime

public void setMinFailbackTime(java.lang.Integer minFailbackTime)

Set the mimumim amount of time (ms) to wait before retrying the primary server in case of a failure. Default is 15 minutes.

Parameters:

minFailbackTime - - in ms.

getRootDN

public java.lang.String getRootDN()

Returns:

Returns the rootDN

setRootDN

public void setRootDN(java.lang.String rootDN)

Parameters:

rootDN - The rootDN to set.

setInitSize

public void setInitSize(java.lang.Integer value)

getInitSize

public int getInitSize()

getPoolTimeOut

public int getPoolTimeOut()

setPoolTimeOut

public void setPoolTimeOut(java.lang.Integer value)

setMaxSize

public void setMaxSize(java.lang.Integer value)

getMaxSize

public int getMaxSize()

setPrefSize

public void setPrefSize(java.lang.Integer value)

getPrefSize

public int getPrefSize()

setUsePooling

public void setUsePooling(boolean value)

getUsePooling

public boolean getUsePooling()

setAuthentication

public void setAuthentication(EnumerationValue value)

getAuthentication

public EnumerationValue getAuthentication()

setLoginField

public void setLoginField(java.lang.String value)

getLoginField

public java.lang.String getLoginField()

setCredentials

public void setCredentials(char[] value)

getCredentials

public char[] getCredentials()

setFactory

public void setFactory(java.lang.String value)

getTracing

public boolean getTracing()

getFactory

public java.lang.String getFactory()

setSocketFactory

public void setSocketFactory(java.lang.String value)

getSocketFactory

public java.lang.String getSocketFactory()

getJNDIConnectionTimeout

public int getJNDIConnectionTimeout()

setJNDIConnectionTimeout

public void setJNDIConnectionTimeout(java.lang.Integer value)

setCaCerts

public void setCaCerts(java.lang.String value)

getCaCerts

public java.lang.String getCaCerts()

setClientCerts

public void setClientCerts(java.lang.String value)

getClientCerts

public java.lang.String getClientCerts()

setCaKeyStorePwd

public void setCaKeyStorePwd(java.lang.String value)

getCaKeyStorePwd

public java.lang.String getCaKeyStorePwd()

setClientKeyStorePwd

public void setClientKeyStorePwd(java.lang.String value)

getClientKeyStorePwd

public java.lang.String getClientKeyStorePwd()

setCaKeyStoreType

public void setCaKeyStoreType(java.lang.String value)

getCaKeyStoreType

public java.lang.String getCaKeyStoreType()

setClientKeyStoreType

public void setClientKeyStoreType(java.lang.String value)

getClientKeyStoreType

public java.lang.String getClientKeyStoreType()

setPrincipal

public void setPrincipal(java.lang.String value)

getPrincipal

public java.lang.String getPrincipal()

setJNDIVersion

public void setJNDIVersion(EnumerationValue value)

getJNDIVersion

public EnumerationValue getJNDIVersion()

setSecurityProtocol

public void setSecurityProtocol(java.lang.String value)

getSecurityProtocol

public java.lang.String getSecurityProtocol()

getJNDIEnvironment

public java.util.Hashtable<java.lang.String,java.lang.String> getJNDIEnvironment()

dumpEnvironmentValues

public void dumpEnvironmentValues(java.util.Hashtable env)

testConnection

public void testConnection(LDAPConfigProxyItem config)
                    throws LDAPUnavailableException

Throws:

LDAPUnavailableException