org.opends.admin.ads.util

Class ConnectionUtils

java.lang.Object

org.opends.admin.ads.util.ConnectionUtils

public class ConnectionUtils
extends Object

Class providing some utilities to create LDAP connections using JNDI and to manage entries retrieved using JNDI.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	canConnectAsAdministrativeUser(String ldapUrl, String dn, String pwd, int timeout) Method used to know if we can connect as administrator in a server with a given password and dn.
static InitialLdapContext	cloneInitialLdapContext(InitialLdapContext ctx, int timeout, TrustManager trustManager, KeyManager keyManager) Clones the provided InitialLdapContext and returns a connection using the same parameters.
static boolean	connectedAsAdministrativeUser(InitialLdapContext ctx) Method used to know if we are connected as administrator in a server with a given InitialLdapContext.
static InitialLdapContext	createLdapContext(String ldapURL, String dn, String pwd, int timeout, Hashtable<String,String> env) Creates a clear LDAP connection and returns the corresponding LdapContext.
static InitialLdapContext	createLdapsContext(String ldapsURL, String dn, String pwd, int timeout, Hashtable<String,String> env, TrustManager trustManager, KeyManager keyManager) Creates an LDAPS connection and returns the corresponding LdapContext.
static InitialLdapContext	createStartTLSContext(String ldapURL, String dn, String pwd, int timeout, Hashtable<String,String> env, TrustManager trustManager, KeyManager keyManager, HostnameVerifier verifier) Creates an LDAP+StartTLS connection and returns the corresponding LdapContext.
static String	getBindDN(InitialLdapContext ctx) Returns the bind DN used in the provided InitialLdapContext.
static String	getBindPassword(InitialLdapContext ctx) Returns the password used in the provided InitialLdapContext.
static String	getFirstValue(SearchResult entry, String attrName) Returns the String representation of the first value of an attribute in a LDAP entry.
static String	getHostName(InitialLdapContext ctx) Returns the host name used in the provided InitialLdapContext.
static String	getHostPort(InitialLdapContext ctx) Returns the host port representation of the server to which this context is connected.
static String	getLdapUrl(InitialLdapContext ctx) Returns the LDAP URL used in the provided InitialLdapContext.
static String	getLDAPUrl(String host, int port, boolean useSSL) Returns the LDAP URL for the provided parameters.
static int	getPort(InitialLdapContext ctx) Returns the port number used in the provided InitialLdapContext.
static Set<String>	getValues(SearchResult entry, String attrName) Returns a Set with the String representation of the values of an attribute in a LDAP entry.
static boolean	isSSL(InitialLdapContext ctx) Tells whether we are using SSL in the provided InitialLdapContext.
static boolean	isStartTLS(InitialLdapContext ctx) Tells whether we are using StartTLS in the provided InitialLdapContext.

Methods inherited from class java.lang.Object

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

Method Detail

createLdapContext

public static InitialLdapContext createLdapContext(String ldapURL,
                                   String dn,
                                   String pwd,
                                   int timeout,
                                   Hashtable<String,String> env)
                                            throws NamingException

Creates a clear LDAP connection and returns the corresponding LdapContext. This methods uses the specified parameters to create a JNDI environment hashtable and creates an InitialLdapContext instance.

Parameters:

ldapURL - the target LDAP URL

dn - passed as Context.SECURITY_PRINCIPAL if not null

pwd - passed as Context.SECURITY_CREDENTIALS if not null

timeout - passed as com.sun.jndi.ldap.connect.timeout if > 0

env - null or additional environment properties

Returns:

the created InitialLdapContext.

Throws:

NamingException - the exception thrown when instantiating InitialLdapContext

See Also:

Context, InitialLdapContext

createLdapsContext

public static InitialLdapContext createLdapsContext(String ldapsURL,
                                    String dn,
                                    String pwd,
                                    int timeout,
                                    Hashtable<String,String> env,
                                    TrustManager trustManager,
                                    KeyManager keyManager)
                                             throws NamingException

Creates an LDAPS connection and returns the corresponding LdapContext. This method uses the TrusteSocketFactory class so that the specified trust manager gets called during the SSL handshake. If trust manager is null, certificates are not verified during SSL handshake.

Parameters:

ldapsURL - the target *LDAPS* URL.

dn - passed as Context.SECURITY_PRINCIPAL if not null.

pwd - passed as Context.SECURITY_CREDENTIALS if not null.

timeout - passed as com.sun.jndi.ldap.connect.timeout if > 0.

env - null or additional environment properties.

trustManager - null or the trust manager to be invoked during SSL negotiation.

keyManager - null or the key manager to be invoked during SSL negotiation.

Returns:

the established connection with the given parameters.

Throws:

NamingException - the exception thrown when instantiating InitialLdapContext.

See Also:

Context, InitialLdapContext, TrustedSocketFactory

cloneInitialLdapContext

public static InitialLdapContext cloneInitialLdapContext(InitialLdapContext ctx,
                                         int timeout,
                                         TrustManager trustManager,
                                         KeyManager keyManager)
                                                  throws NamingException

Clones the provided InitialLdapContext and returns a connection using the same parameters.

Parameters:

ctx - the connection to be cloned.

timeout - the timeout to establish the connection in milliseconds. Use 0 to express no timeout.

trustManager - the trust manager to be used to connect.

keyManager - the key manager to be used to connect.

Returns:

the new InitialLdapContext connected to the server.

Throws:

NamingException - if there was an error creating the new connection.

createStartTLSContext

public static InitialLdapContext createStartTLSContext(String ldapURL,
                                       String dn,
                                       String pwd,
                                       int timeout,
                                       Hashtable<String,String> env,
                                       TrustManager trustManager,
                                       KeyManager keyManager,
                                       HostnameVerifier verifier)
                                                throws NamingException

Creates an LDAP+StartTLS connection and returns the corresponding LdapContext. This method first creates an LdapContext with anonymous bind. Then it requests a StartTlsRequest extended operation. The StartTlsResponse is setup with the specified hostname verifier. Negotiation is done using a TrustSocketFactory so that the specified TrustManager gets called during the SSL handshake. If trust manager is null, certificates are not checked during SSL handshake.

Parameters:

ldapURL - the target *LDAP* URL.

dn - passed as Context.SECURITY_PRINCIPAL if not null.

pwd - passed as Context.SECURITY_CREDENTIALS if not null.

timeout - passed as com.sun.jndi.ldap.connect.timeout if > 0.

env - null or additional environment properties.

trustManager - null or the trust manager to be invoked during SSL negotiation.

keyManager - null or the key manager to be invoked during SSL negotiation.

verifier - null or the hostname verifier to be setup in the StartTlsResponse.

Returns:

the established connection with the given parameters.

Throws:

NamingException - the exception thrown when instantiating InitialLdapContext.

See Also:

Context, InitialLdapContext, StartTlsRequest, StartTlsResponse, TrustedSocketFactory

getLdapUrl

public static String getLdapUrl(InitialLdapContext ctx)

Returns the LDAP URL used in the provided InitialLdapContext.

Parameters:

ctx - the context to analyze.

Returns:

the LDAP URL used in the provided InitialLdapContext.

getHostName

public static String getHostName(InitialLdapContext ctx)

Returns the host name used in the provided InitialLdapContext.

Parameters:

ctx - the context to analyze.

Returns:

the host name used in the provided InitialLdapContext.

getPort

public static int getPort(InitialLdapContext ctx)

Returns the port number used in the provided InitialLdapContext.

Parameters:

ctx - the context to analyze.

Returns:

the port number used in the provided InitialLdapContext.

getHostPort

public static String getHostPort(InitialLdapContext ctx)

Returns the host port representation of the server to which this context is connected.

Parameters:

ctx - the context to analyze.

Returns:

the host port representation of the server to which this context is connected.

getBindDN

public static String getBindDN(InitialLdapContext ctx)

Returns the bind DN used in the provided InitialLdapContext.

Parameters:

ctx - the context to analyze.

Returns:

the bind DN used in the provided InitialLdapContext.

getBindPassword

public static String getBindPassword(InitialLdapContext ctx)

Returns the password used in the provided InitialLdapContext.

Parameters:

ctx - the context to analyze.

Returns:

the password used in the provided InitialLdapContext.

isSSL

public static boolean isSSL(InitialLdapContext ctx)

Tells whether we are using SSL in the provided InitialLdapContext.

Parameters:

ctx - the context to analyze.

Returns:

true if we are using SSL and false otherwise.

isStartTLS

public static boolean isStartTLS(InitialLdapContext ctx)

Tells whether we are using StartTLS in the provided InitialLdapContext.

Parameters:

ctx - the context to analyze.

Returns:

true if we are using StartTLS and false otherwise.

canConnectAsAdministrativeUser

public static boolean canConnectAsAdministrativeUser(String ldapUrl,
                                     String dn,
                                     String pwd,
                                     int timeout)

Method used to know if we can connect as administrator in a server with a given password and dn.

Parameters:

ldapUrl - the LDAP URL of the server.

dn - the dn to be used.

pwd - the password to be used.

timeout - the timeout to establish the connection in milliseconds. Use 0 to express no timeout.

Returns:

true if we can connect and read the configuration and false otherwise.

connectedAsAdministrativeUser

public static boolean connectedAsAdministrativeUser(InitialLdapContext ctx)

Method used to know if we are connected as administrator in a server with a given InitialLdapContext.

Parameters:

ctx - the context.

Returns:

true if we are connected and read the configuration and false otherwise.

getLDAPUrl

public static String getLDAPUrl(String host,
                int port,
                boolean useSSL)

Returns the LDAP URL for the provided parameters.

Parameters:

host - the host name.

port - the LDAP port.

useSSL - whether to use SSL or not.

Returns:

the LDAP URL for the provided parameters.

getFirstValue

public static String getFirstValue(SearchResult entry,
                   String attrName)
                            throws NamingException

Returns the String representation of the first value of an attribute in a LDAP entry.

Parameters:

entry - the entry.

attrName - the attribute name.

Returns:

the String representation of the first value of an attribute in a LDAP entry.

Throws:

NamingException - if there is an error processing the entry.

getValues

public static Set<String> getValues(SearchResult entry,
                    String attrName)
                             throws NamingException

Returns a Set with the String representation of the values of an attribute in a LDAP entry. The returned Set will never be null.

Parameters:

entry - the entry.

attrName - the attribute name.

Returns:

a Set with the String representation of the values of an attribute in a LDAP entry.

Throws:

NamingException - if there is an error processing the entry.