Package org.ldaptive.provider.unboundid

Class UnboundIDProviderConfig

java.lang.Object

org.ldaptive.AbstractConfig

org.ldaptive.provider.ProviderConfig<com.unboundid.ldap.sdk.Control>

org.ldaptive.provider.unboundid.UnboundIDProviderConfig

public class UnboundIDProviderConfig
extends ProviderConfig<com.unboundid.ldap.sdk.Control>

Contains configuration data for the UnboundID provider.

Field Summary

Fields

Modifier and Type	Field	Description
private com.unboundid.ldap.sdk.LDAPConnectionOptions	connectionOptions	Connection options.
private ResultCode[]	searchIgnoreResultCodes	Search result codes to ignore.
private SocketFactory	socketFactory	socket factory for ldap connections.
private SSLSocketFactory	sslSocketFactory	socket factory for ldaps and startTLS connections.

Fields inherited from class org.ldaptive.provider.ProviderConfig

logger

Constructor Summary

Constructors

Constructor	Description
UnboundIDProviderConfig()	Default constructor.

Method Summary

Modifier and Type	Method	Description
com.unboundid.ldap.sdk.LDAPConnectionOptions	getConnectionOptions()	Returns the connection options.
ResultCode[]	getSearchIgnoreResultCodes()	Returns the search ignore result codes.
SocketFactory	getSocketFactory()	Returns the socket factory to use for LDAP connections.
SSLSocketFactory	getSSLSocketFactory()	Returns the SSL socket factory to use for LDAPS and startTLS connections.
void	setConnectionOptions(com.unboundid.ldap.sdk.LDAPConnectionOptions options)	Sets the connection options.
void	setSearchIgnoreResultCodes(ResultCode[] codes)	Sets the search ignore result codes.
void	setSocketFactory(SocketFactory sf)	Sets the socket factory to use for LDAP connections.
void	setSSLSocketFactory(SSLSocketFactory sf)	Sets the SSL socket factory to use for LDAPS and startTLS connections.
String	toString()

Methods inherited from class org.ldaptive.provider.ProviderConfig

getControlProcessor, getOperationExceptionResultCodes, getProperties, setControlProcessor, setOperationExceptionResultCodes, setProperties

Methods inherited from class org.ldaptive.AbstractConfig

checkImmutable, checkStringInput, makeImmutable

Methods inherited from class java.lang.Object

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

Field Detail

connectionOptions

private com.unboundid.ldap.sdk.LDAPConnectionOptions connectionOptions

Connection options.

socketFactory

private SocketFactory socketFactory

socket factory for ldap connections.

sslSocketFactory

private SSLSocketFactory sslSocketFactory

socket factory for ldaps and startTLS connections.

searchIgnoreResultCodes

private ResultCode[] searchIgnoreResultCodes

Search result codes to ignore.

Constructor Detail

UnboundIDProviderConfig

public UnboundIDProviderConfig()

Default constructor.

Method Detail

getConnectionOptions

public com.unboundid.ldap.sdk.LDAPConnectionOptions getConnectionOptions()

Returns the connection options.

Returns:

ldap connection options

setConnectionOptions

public void setConnectionOptions(com.unboundid.ldap.sdk.LDAPConnectionOptions options)

Sets the connection options.

Parameters:

options - ldap connection options

getSocketFactory

public SocketFactory getSocketFactory()

Returns the socket factory to use for LDAP connections.

Returns:

socket factory

setSocketFactory

public void setSocketFactory(SocketFactory sf)

Sets the socket factory to use for LDAP connections.

Parameters:

sf - socket factory

getSSLSocketFactory

public SSLSocketFactory getSSLSocketFactory()

Returns the SSL socket factory to use for LDAPS and startTLS connections.

Returns:

SSL socket factory

setSSLSocketFactory

public void setSSLSocketFactory(SSLSocketFactory sf)

Sets the SSL socket factory to use for LDAPS and startTLS connections.

Parameters:

sf - socket factory

getSearchIgnoreResultCodes

public ResultCode[] getSearchIgnoreResultCodes()

Returns the search ignore result codes.

Returns:

result codes to ignore

setSearchIgnoreResultCodes

public void setSearchIgnoreResultCodes(ResultCode[] codes)

Sets the search ignore result codes.

Parameters:

codes - to ignore

toString

public String toString()

Overrides:

toString in class ProviderConfig<com.unboundid.ldap.sdk.Control>