Package org.forgerock.opendj.server.embedded

Class ConnectionParameters

java.lang.Object

org.forgerock.opendj.server.embedded.ConnectionParameters

public final class ConnectionParameters
extends Object

Parameters to establish connections to a directory server.

Method Summary

Modifier and Type	Method	Description
ConnectionParameters	adminPort(int port)	Sets the port for directory server administration.
ConnectionParameters	bindDn(String dn)	Sets the Dn to use to bind to the directory server.
ConnectionParameters	bindPassword(String password)	Sets the password to use to bind to the directory server.
static ConnectionParameters	connectionParams()	Creates connection parameters.
ConnectionParameters	hostName(String hostName)	Sets the the fully-qualified directory server host name.
ConnectionParameters	ldapPort(int port)	Sets the port on which the directory server listens for LDAP communication.
ConnectionParameters	ldapPortWithStartTls(int port)	Sets the port on which the directory server listens for LDAP with StartTLS communications.
ConnectionParameters	ldapSecurePort(int port)	Sets the port on which the directory server listens for LDAPS (secure) communication.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

connectionParams

public static ConnectionParameters connectionParams()

Creates connection parameters.

Returns:

the parameters

toString

public String toString()

Overrides:

toString in class Object

adminPort

public ConnectionParameters adminPort(int port)

Sets the port for directory server administration.

Parameters:

port - the admin port

Returns:

this builder

bindDn

public ConnectionParameters bindDn(String dn)

Sets the Dn to use to bind to the directory server.

Parameters:

dn - the bind Dn

Returns:

this builder

bindPassword

public ConnectionParameters bindPassword(String password)

Sets the password to use to bind to the directory server.

Parameters:

password - the bind password

Returns:

this builder

hostName

public ConnectionParameters hostName(String hostName)

Sets the the fully-qualified directory server host name.

Parameters:

hostName - the hostName of the server

Returns:

this builder

ldapPort

public ConnectionParameters ldapPort(int port)

Sets the port on which the directory server listens for LDAP communication.

Parameters:

port - the LDAP port

Returns:

this builder

ldapPortWithStartTls

public ConnectionParameters ldapPortWithStartTls(int port)

Sets the port on which the directory server listens for LDAP with StartTLS communications.

Parameters:

port - the LDAP with StartTLS port

Returns:

this builder

ldapSecurePort

public ConnectionParameters ldapSecurePort(int port)

Sets the port on which the directory server listens for LDAPS (secure) communication.

Parameters:

port - the LDAPS port

Returns:

this builder