org.apache.directory.server.integ

Class ServerIntegrationUtils

java.lang.Object

org.apache.directory.server.core.integ.IntegrationUtils

org.apache.directory.server.integ.ServerIntegrationUtils

public class ServerIntegrationUtils
extends IntegrationUtils

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CTX_FACTORY
private static java.lang.String	DEFAULT_ADMIN
private static java.lang.String	DEFAULT_PASSWORD
private static int	DEFAULT_PORT
private static org.slf4j.Logger	LOG The class logger

Constructor Summary

Constructors

Constructor and Description
ServerIntegrationUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.directory.ldap.client.api.LdapConnection	getAdminConnection(LdapServer ldapServer) Gets a LDAP connection instance on a server.
static org.apache.directory.ldap.client.api.LdapConnection	getLdapConnection(LdapServer ldapServer) Gets a LDAP connection instance on a server.
static netscape.ldap.LDAPConnection	getNsdkWiredConnection(LdapServer ldapServer)
static netscape.ldap.LDAPConnection	getNsdkWiredConnection(LdapServer ldapServer, java.lang.String principalDn, java.lang.String password) Gets a LDAP connection instance on a server, authenticating a user.
static org.apache.directory.ldap.client.api.LdapConnection	getWiredConnection(LdapServer ldapServer)
static org.apache.directory.ldap.client.api.LdapConnection	getWiredConnection(LdapServer ldapServer, java.lang.String principalDn, java.lang.String password) Gets a LDAP connection instance on a server, authenticating a user.
static javax.naming.ldap.LdapContext	getWiredContext(LdapServer ldapServer) Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider.
static javax.naming.ldap.LdapContext	getWiredContext(LdapServer ldapServer, org.apache.directory.api.ldap.model.message.Control[] controls) Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider.
static javax.naming.ldap.LdapContext	getWiredContext(LdapServer ldapServer, java.lang.String principalDn, java.lang.String password) Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider.
static javax.naming.ldap.LdapContext	getWiredContextFollowOnRefferal(LdapServer ldapServer) Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider.
static javax.naming.ldap.LdapContext	getWiredContextRefferalIgnore(LdapServer ldapServer) Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider.
static javax.naming.ldap.LdapContext	getWiredContextThrowOnRefferal(LdapServer ldapServer) Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider.

Methods inherited from class org.apache.directory.server.core.integ.IntegrationUtils

apply, closeConnections, disableSchema, doDelete, enableSchema, getAdminConnection, getAdminNetworkConnection, getAnonymousNetworkConnection, getAnonymousNetworkConnection, getConnectionAs, getConnectionAs, getContext, getCoreSession, getNetworkConnectionAs, getNetworkConnectionAs, getRootContext, getSchemaContext, getSystemContext, getUserAddLdif, getUserAddLdif, injectEntries, isDisabled, isEnabled, isLoaded

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

The class logger

CTX_FACTORY

private static final java.lang.String CTX_FACTORY

See Also:

Constant Field Values

DEFAULT_PORT

private static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_ADMIN

private static final java.lang.String DEFAULT_ADMIN

See Also:

Constant Field Values

DEFAULT_PASSWORD

private static final java.lang.String DEFAULT_PASSWORD

See Also:

Constant Field Values

Constructor Detail

ServerIntegrationUtils

public ServerIntegrationUtils()

Method Detail

getWiredContext

public static javax.naming.ldap.LdapContext getWiredContext(LdapServer ldapServer)
                                                     throws java.lang.Exception

Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider. The connection is made using the administrative user as the principalDN. The context is to the rootDSE.

Parameters:

ldapServer - the LDAP server to get the connection to

Returns:

an LdapContext as the administrative user to the RootDSE

Throws:

java.lang.Exception - if there are problems creating the context

getWiredContext

public static javax.naming.ldap.LdapContext getWiredContext(LdapServer ldapServer,
                                                            java.lang.String principalDn,
                                                            java.lang.String password)
                                                     throws java.lang.Exception

Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider. The connection is made using the administrative user as the principalDN. The context is to the rootDSE.

Parameters:

ldapServer - the LDAP server to get the connection to

Returns:

an LdapContext as the administrative user to the RootDSE

Throws:

java.lang.Exception - if there are problems creating the context

getWiredContext

public static javax.naming.ldap.LdapContext getWiredContext(LdapServer ldapServer,
                                                            org.apache.directory.api.ldap.model.message.Control[] controls)
                                                     throws java.lang.Exception

Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider. The connection is made using the administrative user as the principalDN. The context is to the rootDSE.

Parameters:

ldapServer - the LDAP server to get the connection to

Returns:

an LdapContext as the administrative user to the RootDSE

Throws:

java.lang.Exception - if there are problems creating the context

getWiredContextThrowOnRefferal

public static javax.naming.ldap.LdapContext getWiredContextThrowOnRefferal(LdapServer ldapServer)
                                                                    throws java.lang.Exception

Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider. The connection is made using the administrative user as the principalDN. The context is to the rootDSE.

Parameters:

ldapServer - the LDAP server to get the connection to

Returns:

an LdapContext as the administrative user to the RootDSE

Throws:

java.lang.Exception - if there are problems creating the context

getWiredContextRefferalIgnore

public static javax.naming.ldap.LdapContext getWiredContextRefferalIgnore(LdapServer ldapServer)
                                                                   throws java.lang.Exception

Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider. The connection is made using the administrative user as the principalDN. The context is to the rootDSE.

Parameters:

ldapServer - the LDAP server to get the connection to

Returns:

an LdapContext as the administrative user to the RootDSE

Throws:

java.lang.Exception - if there are problems creating the context

getWiredContextFollowOnRefferal

public static javax.naming.ldap.LdapContext getWiredContextFollowOnRefferal(LdapServer ldapServer)
                                                                     throws java.lang.Exception

Creates a JNDI LdapContext with a connection over the wire using the SUN LDAP provider. The connection is made using the administrative user as the principalDN. The context is to the rootDSE.

Parameters:

ldapServer - the LDAP server to get the connection to

Returns:

an LdapContext as the administrative user to the RootDSE

Throws:

java.lang.Exception - if there are problems creating the context

getWiredConnection

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

Throws:

java.lang.Exception

getNsdkWiredConnection

public static netscape.ldap.LDAPConnection getNsdkWiredConnection(LdapServer ldapServer)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

getWiredConnection

public static org.apache.directory.ldap.client.api.LdapConnection getWiredConnection(LdapServer ldapServer,
                                                                                     java.lang.String principalDn,
                                                                                     java.lang.String password)
                                                                              throws java.lang.Exception

Gets a LDAP connection instance on a server, authenticating a user.

Parameters:

ldapServer - The server we want to connect to

principalDn - The user's DN

password - The user's password

Returns:

A LdapConnection instance if we got one

Throws:

java.lang.Exception - If the connection cannot be created

getLdapConnection

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

Gets a LDAP connection instance on a server. We won't bind on the server.

Parameters:

ldapServer - The server we want to connect to

Returns:

A LdapConnection instance if we got one

Throws:

java.lang.Exception - If the connection cannot be created

getNsdkWiredConnection

public static netscape.ldap.LDAPConnection getNsdkWiredConnection(LdapServer ldapServer,
                                                                  java.lang.String principalDn,
                                                                  java.lang.String password)
                                                           throws java.lang.Exception

Gets a LDAP connection instance on a server, authenticating a user.

Parameters:

ldapServer - The server we want to connect to

principalDn - The user's DN

password - The user's password

Returns:

A LdapConnection instance if we got one

Throws:

java.lang.Exception - If the connection cannot be created

getAdminConnection

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

Gets a LDAP connection instance on a server. We will bind as Admin

Parameters:

ldapServer - The server we want to connect to

Returns:

A LdapConnection instance if we got one

Throws:

java.lang.Exception - If the connection cannot be created