org.apache.directory.shared.client.api

Class LdapApiIntegrationUtils

java.lang.Object

org.apache.directory.shared.client.api.LdapApiIntegrationUtils

public final class LdapApiIntegrationUtils
extends java.lang.Object

The Class LdapApiIntegrationUtils.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	DEFAULT_ADMIN The Constant DEFAULT_ADMIN.
private static java.lang.String	DEFAULT_HOST The Constant DEFAULT_HOST.
private static java.lang.String	DEFAULT_PASSWORD The Constant DEFAULT_PASSWORD.
private static java.util.Map<java.lang.Integer,org.apache.directory.ldap.client.api.LdapConnectionPool>	POOLS The pools.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	LdapApiIntegrationUtils()

Method Summary

Modifier and Type	Method and Description
static void	closeConnection(org.apache.directory.ldap.client.api.LdapNetworkConnection conn) Closes the LdapNetworkConnection.
static org.apache.directory.ldap.client.api.LdapNetworkConnection	createAdminConnection(LdapServer ldapServer) Creates a new LdapNetworkConnection and authenticates as admin user.
private static org.apache.directory.ldap.client.api.LdapConnectionPool	getAdminPool(LdapServer ldapServer) Gets the admin pool.
static org.apache.directory.ldap.client.api.LdapConnection	getAnonymousNetworkConnection(LdapServer ldapServer) Gets an anonymous LdapNetworkConnection
static org.apache.directory.ldap.client.api.LdapConnection	getAnonymousNetworkConnection(java.lang.String host, int port) Gets an anonymous LdapNetworkConnection
static org.apache.directory.ldap.client.api.LdapConnection	getPooledAdminConnection(LdapServer ldapServer) Gets the pooled LdapConnectionPool, authenticated as admin user.
static void	releasePooledAdminConnection(org.apache.directory.ldap.client.api.LdapConnection conn, LdapServer ldapServer) Releases a pooled connection back to the pool.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

private static final java.lang.String DEFAULT_HOST

The Constant DEFAULT_HOST.

See Also:

Constant Field Values

DEFAULT_ADMIN

private static final java.lang.String DEFAULT_ADMIN

The Constant DEFAULT_ADMIN.

See Also:

Constant Field Values

DEFAULT_PASSWORD

private static final java.lang.String DEFAULT_PASSWORD

The Constant DEFAULT_PASSWORD.

See Also:

Constant Field Values

POOLS

private static final java.util.Map<java.lang.Integer,org.apache.directory.ldap.client.api.LdapConnectionPool> POOLS

The pools.

Constructor Detail

LdapApiIntegrationUtils

private LdapApiIntegrationUtils()

Method Detail

createAdminConnection

public static org.apache.directory.ldap.client.api.LdapNetworkConnection createAdminConnection(LdapServer ldapServer)
                                                                                        throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                                               java.io.IOException

Creates a new LdapNetworkConnection and authenticates as admin user. The caller is responsible for closing the connection, use closeConnection().

Parameters:

ldapServer - the LDAP server instance, used to obtain the port used

Returns:

the created connection

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - the LDAP exception

java.io.IOException - Signals that an I/O exception has occurred.

closeConnection

public static void closeConnection(org.apache.directory.ldap.client.api.LdapNetworkConnection conn)
                            throws org.apache.directory.api.ldap.model.exception.LdapException,
                                   java.io.IOException

Closes the LdapNetworkConnection.

Parameters:

conn - the connection to close

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - the LDAP exception

java.io.IOException - Signals that an I/O exception has occurred.

getPooledAdminConnection

public static org.apache.directory.ldap.client.api.LdapConnection getPooledAdminConnection(LdapServer ldapServer)
                                                                                    throws java.lang.Exception

Gets the pooled LdapConnectionPool, authenticated as admin user. The caller is reponsible for releasing the connection, use releasePooledConnection().

Parameters:

ldapServer - the LDAP server instance, used to obtain the port used

Returns:

the pooled admin connection

Throws:

java.lang.Exception - the exception

releasePooledAdminConnection

public static void releasePooledAdminConnection(org.apache.directory.ldap.client.api.LdapConnection conn,
                                                LdapServer ldapServer)
                                         throws java.lang.Exception

Releases a pooled connection back to the pool.

Parameters:

conn - the connection to release

ldapServer - the LDAP server instance, used to obtain the port used

Throws:

java.lang.Exception - the exception

getAdminPool

private static org.apache.directory.ldap.client.api.LdapConnectionPool getAdminPool(LdapServer ldapServer)

Gets the admin pool.

Parameters:

ldapServer - the ldap server

Returns:

the admin pool

getAnonymousNetworkConnection

public static org.apache.directory.ldap.client.api.LdapConnection getAnonymousNetworkConnection(java.lang.String host,
                                                                                                int port)
                                                                                         throws java.lang.Exception

Gets an anonymous LdapNetworkConnection

Parameters:

dirService - The Directory Service to be connected to

Returns:

A LdapNetworkConnection instance

Throws:

If - the connection could not be established.

java.lang.Exception

getAnonymousNetworkConnection

public static org.apache.directory.ldap.client.api.LdapConnection getAnonymousNetworkConnection(LdapServer ldapServer)
                                                                                         throws java.lang.Exception

Gets an anonymous LdapNetworkConnection

Parameters:

ldapServer - The LDAP server we want to connect to

Returns:

A LdapNetworkConnection instance

Throws:

If - the connection could not be established.

java.lang.Exception