org.ldaptive.provider.jndi

Class JndiStartTLSConnection

java.lang.Object

org.ldaptive.provider.jndi.JndiConnection

org.ldaptive.provider.jndi.JndiStartTLSConnection

All Implemented Interfaces:

ProviderConnection

public class JndiStartTLSConnection
extends JndiConnection

JNDI provider implementation of ldap operations using startTLS.

Nested Class Summary

Nested classes/interfaces inherited from class org.ldaptive.provider.jndi.JndiConnection

JndiConnection.JndiExtendedRequest, JndiConnection.JndiExtendedResponse, JndiConnection.JndiSearchIterator

Field Summary

Fields

Modifier and Type	Field and Description
private javax.naming.ldap.StartTlsResponse	startTlsResponse Start TLS response.
private boolean	stopTLSOnClose Whether to call StartTlsResponse.close() when close(RequestControl[]) is called.

Fields inherited from class org.ldaptive.provider.jndi.JndiConnection

AUTHENTICATION, BINARY_ATTRIBUTES, CREDENTIALS, DELETE_RDN, DEREF_ALIASES, logger, PRINCIPAL, REFERRAL, SASL_AUTHZ_ID, SASL_MUTUAL_AUTH, SASL_QOP, SASL_REALM, SASL_STRENGTH, TYPES_ONLY

Constructor Summary

Constructors

Constructor and Description
JndiStartTLSConnection(javax.naming.ldap.LdapContext lc, JndiProviderConfig pc) Creates a new jndi startTLS connection.
JndiStartTLSConnection(javax.naming.ldap.LdapContext lc, JndiProviderConfig pc, javax.naming.ldap.StartTlsResponse tlsResponse) Creates a new jndi startTLS connection.

Method Summary

Modifier and Type	Method and Description
void	close(RequestControl[] controls) Tear down this connection to an LDAP.
javax.naming.ldap.StartTlsResponse	getStartTlsResponse() Returns the start tls response used by this connection.
boolean	getStopTLSOnClose() Returns whether to call StartTlsResponse.close() when close(RequestControl[]) is called.
void	setStartTlsResponse(javax.naming.ldap.StartTlsResponse str) Sets the start tls response.
void	setStopTLSOnClose(boolean b) Sets whether to call StartTlsResponse.close() when close(RequestControl[]) is called.

Methods inherited from class org.ldaptive.provider.jndi.JndiConnection

abandon, add, addUnsolicitedNotificationListener, anonymousBind, bind, compare, createResponse, delete, extendedOperation, getCompareSearchControls, getLdapContext, getSaslProperties, initializeContext, modify, modifyDn, processNamingException, processResponseControls, removeUnsolicitedNotificationListener, saslBind, search, searchAsync, simpleBind

Methods inherited from class java.lang.Object

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

Field Detail

startTlsResponse

private javax.naming.ldap.StartTlsResponse startTlsResponse

Start TLS response.

stopTLSOnClose

private boolean stopTLSOnClose

Whether to call StartTlsResponse.close() when close(RequestControl[]) is called.

Constructor Detail

JndiStartTLSConnection

public JndiStartTLSConnection(javax.naming.ldap.LdapContext lc,
                              JndiProviderConfig pc)

Creates a new jndi startTLS connection.

Parameters:

lc - ldap context

pc - provider configuration

JndiStartTLSConnection

public JndiStartTLSConnection(javax.naming.ldap.LdapContext lc,
                              JndiProviderConfig pc,
                              javax.naming.ldap.StartTlsResponse tlsResponse)

Creates a new jndi startTLS connection.

Parameters:

lc - ldap context

pc - provider configuration

tlsResponse - of successful TLS handshake

Method Detail

getStopTLSOnClose

public boolean getStopTLSOnClose()

Returns whether to call StartTlsResponse.close() when close(RequestControl[]) is called.

Returns:

stop TLS on close

setStopTLSOnClose

public void setStopTLSOnClose(boolean b)

Sets whether to call StartTlsResponse.close() when close(RequestControl[]) is called.

Parameters:

b - stop TLS on close

getStartTlsResponse

public javax.naming.ldap.StartTlsResponse getStartTlsResponse()

Returns the start tls response used by this connection.

Returns:

start tls response

setStartTlsResponse

public void setStartTlsResponse(javax.naming.ldap.StartTlsResponse str)

Sets the start tls response.

Parameters:

str - start tls response

close

public void close(RequestControl[] controls)
           throws LdapException

Description copied from interface: ProviderConnection

Tear down this connection to an LDAP.

Specified by:

close in interface ProviderConnection

Overrides:

close in class JndiConnection

Parameters:

controls - request controls

Throws:

LdapException - if an LDAP error occurs