org.ldaptive.provider.jndi

Class JndiProviderConfig

java.lang.Object

org.ldaptive.AbstractConfig

org.ldaptive.provider.ProviderConfig<javax.naming.ldap.Control>

org.ldaptive.provider.jndi.JndiProviderConfig

public class JndiProviderConfig
extends ProviderConfig<javax.naming.ldap.Control>

Contains configuration data for the JNDI provider.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ALLOW_ANY_HOSTNAME Boolean property that indicates whether hostname verification should be disabled for StartTLS connections.
private java.util.Map<java.lang.String,java.lang.Object>	environment Context environment.
private javax.net.ssl.HostnameVerifier	hostnameVerifier hostname verifier for startTLS connections.
private boolean	removeDnUrls Whether to remove the URL from any DNs which are not relative.
private ResultCode[]	searchIgnoreResultCodes Search result codes to ignore.
private javax.net.ssl.SSLSocketFactory	sslSocketFactory ldap socket factory used for SSL and startTLS.
private java.io.OutputStream	tracePackets Stream to print LDAP ASN.1 BER packets.

Fields inherited from class org.ldaptive.provider.ProviderConfig

logger

Constructor Summary

Constructors

Constructor and Description
JndiProviderConfig() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getEnvironment() Returns the context environment.
javax.net.ssl.HostnameVerifier	getHostnameVerifier() Returns the hostname verifier to use for startTLS connections.
boolean	getRemoveDnUrls() Returns whether the URL will be removed from any DNs which are not relative.
ResultCode[]	getSearchIgnoreResultCodes() Returns the search ignore result codes.
javax.net.ssl.SSLSocketFactory	getSslSocketFactory() Returns the SSL socket factory to use for SSL and startTLS connections.
java.io.OutputStream	getTracePackets() Returns the output stream used to print ASN.1 BER packets.
void	setEnvironment(java.util.Map<java.lang.String,java.lang.Object> env) Sets the context environment.
void	setHostnameVerifier(javax.net.ssl.HostnameVerifier verifier) Sets the hostname verifier to use for startTLS connections.
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> props) Sets provider specific properties.
void	setRemoveDnUrls(boolean b) Sets whether the URL will be removed from any DNs which are not relative The default value is true.
void	setSearchIgnoreResultCodes(ResultCode... codes) Sets the search ignore result codes.
void	setSslSocketFactory(javax.net.ssl.SSLSocketFactory sf) Sets the SSL socket factory to use for SSL and startTLS connections.
void	setTracePackets(java.io.OutputStream stream) Sets the output stream to print ASN.1 BER packets to.
java.lang.String	toString()

Methods inherited from class org.ldaptive.provider.ProviderConfig

getConnectionStrategy, getControlProcessor, getOperationExceptionResultCodes, getProperties, setConnectionStrategy, setControlProcessor, setOperationExceptionResultCodes

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

ALLOW_ANY_HOSTNAME

protected static final java.lang.String ALLOW_ANY_HOSTNAME

Boolean property that indicates whether hostname verification should be disabled for StartTLS connections. The value of this constant is "jndi.starttls.allowAnyHostname".

See Also:

Constant Field Values

environment

private java.util.Map<java.lang.String,java.lang.Object> environment

Context environment.

tracePackets

private java.io.OutputStream tracePackets

Stream to print LDAP ASN.1 BER packets.

removeDnUrls

private boolean removeDnUrls

Whether to remove the URL from any DNs which are not relative.

searchIgnoreResultCodes

private ResultCode[] searchIgnoreResultCodes

Search result codes to ignore.

sslSocketFactory

private javax.net.ssl.SSLSocketFactory sslSocketFactory

ldap socket factory used for SSL and startTLS.

hostnameVerifier

private javax.net.ssl.HostnameVerifier hostnameVerifier

hostname verifier for startTLS connections.

Constructor Detail

JndiProviderConfig

public JndiProviderConfig()

Default constructor.

Method Detail

getEnvironment

public java.util.Map<java.lang.String,java.lang.Object> getEnvironment()

Returns the context environment.

Returns:

ldap context environment

setEnvironment

public void setEnvironment(java.util.Map<java.lang.String,java.lang.Object> env)

Sets the context environment.

Parameters:

env - ldap context environment

getTracePackets

public java.io.OutputStream getTracePackets()

Returns the output stream used to print ASN.1 BER packets.

Returns:

output stream

setTracePackets

public void setTracePackets(java.io.OutputStream stream)

Sets the output stream to print ASN.1 BER packets to.

Parameters:

stream - to output to

getRemoveDnUrls

public boolean getRemoveDnUrls()

Returns whether the URL will be removed from any DNs which are not relative. The default value is true.

Returns:

whether the URL will be removed from DNs

setRemoveDnUrls

public void setRemoveDnUrls(boolean b)

Sets whether the URL will be removed from any DNs which are not relative The default value is true.

Parameters:

b - whether the URL will be removed from DNs

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

getSslSocketFactory

public javax.net.ssl.SSLSocketFactory getSslSocketFactory()

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

Returns:

SSL socket factory

setSslSocketFactory

public void setSslSocketFactory(javax.net.ssl.SSLSocketFactory sf)

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

Parameters:

sf - SSL socket factory

getHostnameVerifier

public javax.net.ssl.HostnameVerifier getHostnameVerifier()

Returns the hostname verifier to use for startTLS connections.

Returns:

hostname verifier

setHostnameVerifier

public void setHostnameVerifier(javax.net.ssl.HostnameVerifier verifier)

Sets the hostname verifier to use for startTLS connections.

Parameters:

verifier - for hostnames

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Description copied from class: ProviderConfig

Sets provider specific properties.

Overrides:

setProperties in class ProviderConfig<javax.naming.ldap.Control>

Parameters:

props - map of additional provider properties

toString

public java.lang.String toString()

Overrides:

toString in class ProviderConfig<javax.naming.ldap.Control>