org.ldaptive.provider.jndi

Class NamingExceptionUtils

java.lang.Object

org.ldaptive.provider.jndi.NamingExceptionUtils

public final class NamingExceptionUtils
extends java.lang.Object

Utility class that provides a bridge between JNDI naming exceptions and ldap result codes. See http://docs.oracle.com/javase/tutorial/jndi/ldap/exceptions.html

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.Class<? extends javax.naming.NamingException>,ResultCode[]>	EXCEPTIONS_TO_RESULT_CODES Map of naming exceptions to ldap result codes.
private static java.util.regex.Pattern	PATTERN Pattern to find error code in exception messages.
private static java.util.Map<ResultCode,java.lang.Class<? extends javax.naming.NamingException>>	RESULT_CODES_TO_EXCEPTION Map of ldap result codes to naming exceptions.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	NamingExceptionUtils() Default constructor.

Method Summary

Modifier and Type	Method and Description
static java.lang.Class<? extends javax.naming.NamingException>	getNamingException(ResultCode code) Returns the naming exception that maps to the supplied result code.
static ResultCode	getResultCode(java.lang.Class<? extends javax.naming.NamingException> clazz) Returns the result code that map to the supplied naming exception.
static ResultCode	getResultCode(java.lang.String message) Returns the result code contained in the supplied naming exception message.
static ResultCode[]	getResultCodes(java.lang.Class<? extends javax.naming.NamingException> clazz) Returns the result codes that map to the supplied naming exception.
static boolean	matches(java.lang.Class<? extends javax.naming.NamingException> clazz, ResultCode code) Returns whether the supplied naming exception maps to the supplied result code.

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTIONS_TO_RESULT_CODES

private static final java.util.Map<java.lang.Class<? extends javax.naming.NamingException>,ResultCode[]> EXCEPTIONS_TO_RESULT_CODES

Map of naming exceptions to ldap result codes.

RESULT_CODES_TO_EXCEPTION

private static final java.util.Map<ResultCode,java.lang.Class<? extends javax.naming.NamingException>> RESULT_CODES_TO_EXCEPTION

Map of ldap result codes to naming exceptions.

PATTERN

private static final java.util.regex.Pattern PATTERN

Pattern to find error code in exception messages.

Constructor Detail

NamingExceptionUtils

private NamingExceptionUtils()

Default constructor.

Method Detail

getResultCodes

public static ResultCode[] getResultCodes(java.lang.Class<? extends javax.naming.NamingException> clazz)

Returns the result codes that map to the supplied naming exception.

Parameters:

clazz - naming exception

Returns:

ldap result codes

getResultCode

public static ResultCode getResultCode(java.lang.Class<? extends javax.naming.NamingException> clazz)

Returns the result code that map to the supplied naming exception. If the exception maps to multiple result codes, null is returned.

Parameters:

clazz - naming exception

Returns:

ldap result code or null

getResultCode

public static ResultCode getResultCode(java.lang.String message)

Returns the result code contained in the supplied naming exception message. JNDI displays the error code in the form "[LDAP: error code {code} - {message}" and this method attempts to parse that numeric code from the message.

Parameters:

message - naming exception message

Returns:

ldap result code or null

matches

public static boolean matches(java.lang.Class<? extends javax.naming.NamingException> clazz,
                              ResultCode code)

Returns whether the supplied naming exception maps to the supplied result code.

Parameters:

clazz - naming exception

code - ldap result code

Returns:

whether the naming exception matches the result code

getNamingException

public static java.lang.Class<? extends javax.naming.NamingException> getNamingException(ResultCode code)

Returns the naming exception that maps to the supplied result code. If the result code does not map to an exception, null is returned

Parameters:

code - ldap result code

Returns:

array of naming exception classes