Skip navigation links

oracle.idm.connection.ldap
Interface LdapContextDelegate

All Superinterfaces:

XmlPrintable

All Known Implementing Classes:

LdapContextManager

public interface LdapContextDelegate

extends XmlPrintable

This interface specifies LDAP context delegate methods.

When modifying LDAP context delegate properties directly, synchronize with the connection pool in order to avoid undesirable side effects, as follows:

 synchronized (pool) { delegate.setValidating(false); }
 

Field Summary

static boolean	DEFAULT_PROXYING The default proxying mode is defined by the connection delegate interface.
static boolean	DEFAULT_VALIDATING The default validating mode is defined by the connection delegate interface.

Method Summary

boolean	canCloseLdapContext(javax.naming.ldap.LdapContext context, java.util.Map parameters) Returns true if the LDAP context can be closed.
boolean	canOpenLdapContext(java.util.Map parameters) Returns true if the LDAP context can be opened.
boolean	canProxyLdapContext(javax.naming.ldap.LdapContext context, java.util.Map parameters) Returns true if the LDAP context can be proxied.
boolean	canValidateLdapContext(javax.naming.ldap.LdapContext context, java.util.Map parameters) Returns true if the LDAP context can be validated.
java.util.Map	cloneEnvironment(java.util.Map environment) This method clones the LDAP context environment.
java.util.Map	cloneParameters(java.util.Map parameters) This method colones parameters to be internalized by the connection.
void	closeLdapContext(javax.naming.ldap.LdapContext context, java.util.Map parameters, int failSafeLevel) Closes the LDAP context.
boolean	isAlteredLdapContext(javax.naming.ldap.LdapContext context, java.util.Map environment) Returns true if this LDAP context environment is altered with regards to the one passed in.
boolean	isMatchingLdapContext(javax.naming.ldap.LdapContext context, java.util.Map parameters) Returns true if this LDAP context matches all parameters without the need to be proxied.
boolean	isMatchingParameters(java.util.Map parameters) Tests if the ldap context delegate matches specified parameters.
boolean	isProxying() Getter for the proxying mode.
boolean	isValidating() Getter for the validating mode.
javax.naming.ldap.LdapContext	openLdapContext(java.util.Map parameters, int failSafeLevel) Opens an LDAP context.
void	proxyLdapContext(javax.naming.ldap.LdapContext context, java.util.Map parameters, int failSafeLevel) Proxies the LDAP context.
void	resetProxying() Resets the proxying mode to DEFAULT_PROXYING.
void	resetValidating() Resets the validating mode to DEFAULT_VALIDATING.
void	setProxying(boolean proxying) Setter for the proxying mode.
void	setValidating(boolean validating) Setter for the validating mode.
void	validateLdapContext(javax.naming.ldap.LdapContext context, java.util.Map parameters, int failSafeLevel) Validates the LDAP context.

Methods inherited from interface oracle.idm.io.XmlPrintable

xprint

Field Detail

DEFAULT_PROXYING

static final boolean DEFAULT_PROXYING

The default proxying mode is defined by the connection delegate interface.

See Also:

Constant Field Values

DEFAULT_VALIDATING

static final boolean DEFAULT_VALIDATING

The default validating mode is defined by the connection delegate interface.

See Also:

Constant Field Values

Method Detail

isProxying

boolean isProxying()

Getter for the proxying mode.

Returns:

true if the ldap context delegate is proxying, false otherwise

setProxying

void setProxying(boolean proxying)
                 throws java.lang.UnsupportedOperationException

Setter for the proxying mode.

Throws:

java.lang.UnsupportedOperationException

resetProxying

void resetProxying()
                   throws java.lang.UnsupportedOperationException

Resets the proxying mode to DEFAULT_PROXYING.

Throws:

java.lang.UnsupportedOperationException

isValidating

boolean isValidating()

Getter for the validating mode.

Returns:

true if the ldap context delegate is validating, false otherwise

setValidating

void setValidating(boolean validating)
                   throws java.lang.UnsupportedOperationException

Setter for the validating mode.

Throws:

java.lang.UnsupportedOperationException

resetValidating

void resetValidating()
                     throws java.lang.UnsupportedOperationException

Resets the validating mode to DEFAULT_VALIDATING.

Throws:

java.lang.UnsupportedOperationException

isMatchingParameters

boolean isMatchingParameters(java.util.Map parameters)

Tests if the ldap context delegate matches specified parameters.

Returns:

true if the parameterts match, false otherwise

canOpenLdapContext

boolean canOpenLdapContext(java.util.Map parameters)
                           throws javax.naming.NamingException

Returns true if the LDAP context can be opened.

Returns:

true if the ldap context can be opened, false otherwise

Throws:

javax.naming.NamingException

openLdapContext

javax.naming.ldap.LdapContext openLdapContext(java.util.Map parameters,
                                              int failSafeLevel)
                                              throws javax.naming.NamingException

Opens an LDAP context.

Returns:

the opened ladp context

Throws:

javax.naming.NamingException

canCloseLdapContext

boolean canCloseLdapContext(javax.naming.ldap.LdapContext context,
                            java.util.Map parameters)
                            throws javax.naming.NamingException

Returns true if the LDAP context can be closed.

Returns:

true if the ldap context can be closed, false otherwise

Throws:

javax.naming.NamingException

closeLdapContext

void closeLdapContext(javax.naming.ldap.LdapContext context,
                      java.util.Map parameters,
                      int failSafeLevel)
                      throws javax.naming.NamingException

Closes the LDAP context.

Throws:

javax.naming.NamingException

canProxyLdapContext

boolean canProxyLdapContext(javax.naming.ldap.LdapContext context,
                            java.util.Map parameters)
                            throws javax.naming.NamingException

Returns true if the LDAP context can be proxied.

Returns:

true if the ldap context can be proxied, false otherwise

Throws:

javax.naming.NamingException

proxyLdapContext

void proxyLdapContext(javax.naming.ldap.LdapContext context,
                      java.util.Map parameters,
                      int failSafeLevel)
                      throws javax.naming.NamingException,
                             java.lang.UnsupportedOperationException

Proxies the LDAP context.

If proxying is not supported, throw UnsupportedOperationException.

Throws:

javax.naming.NamingException

java.lang.UnsupportedOperationException

isMatchingLdapContext

boolean isMatchingLdapContext(javax.naming.ldap.LdapContext context,
                              java.util.Map parameters)
                              throws javax.naming.NamingException

Returns true if this LDAP context matches all parameters without the need to be proxied.

Returns:

true if the ldap context matches the parameters, false otherwise

Throws:

javax.naming.NamingException

isAlteredLdapContext

boolean isAlteredLdapContext(javax.naming.ldap.LdapContext context,
                             java.util.Map environment)
                             throws javax.naming.NamingException

Returns true if this LDAP context environment is altered with regards to the one passed in.

Returns:

true if the ldap context has been altered, false otherwise

Throws:

javax.naming.NamingException

canValidateLdapContext

boolean canValidateLdapContext(javax.naming.ldap.LdapContext context,
                               java.util.Map parameters)
                               throws javax.naming.NamingException

Returns true if the LDAP context can be validated.

Returns:

true if the ldap context can be validated, false otherwise

Throws:

javax.naming.NamingException

validateLdapContext

void validateLdapContext(javax.naming.ldap.LdapContext context,
                         java.util.Map parameters,
                         int failSafeLevel)
                         throws javax.naming.NamingException,
                                java.lang.UnsupportedOperationException

Validates the LDAP context.

If validation is not supported, throw UnsupportedOperationException.

Throws:

javax.naming.NamingException

java.lang.UnsupportedOperationException

cloneParameters

java.util.Map cloneParameters(java.util.Map parameters)

This method colones parameters to be internalized by the connection.

This method returns a clone of original parameteres.

This method must hide all sensitive parameters.

Returns:

cloned parameter map

cloneEnvironment

java.util.Map cloneEnvironment(java.util.Map environment)

This method clones the LDAP context environment.

This method returns a clone of original environment.

This method must hide all sensitive parameters.

Returns:

cloned environment map

Skip navigation links