Skip navigation links


oracle.idm.connection.ldap
Class LdapConnection

java.lang.Object
  extended by oracle.idm.connection.Connection
      extended by oracle.idm.connection.ldap.LdapConnection

All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, XmlPrintable

public class LdapConnection
extends Connection

This class represents LDAP connections.


Nested Class Summary

 

Nested classes/interfaces inherited from class oracle.idm.connection.Connection
Connection.BusyInfo, Connection.CaptureInfo, Connection.CloseInfo, Connection.CountInfo, Connection.IdleInfo, Connection.InvalidateInfo, Connection.Match, Connection.OpenInfo, Connection.Operation, Connection.OperationInfo, Connection.Parameter, Connection.ProxyInfo, Connection.ReleaseInfo, Connection.RemoveInfo, Connection.ReturnInfo, Connection.Status, Connection.ValidateInfo

 

Field Summary
static java.lang.String TYPE
          Use for LDAP connection type parameter value.

 

Fields inherited from class oracle.idm.connection.Connection
tag

 

Constructor Summary
protected LdapConnection(LdapConnectionManager manager, java.util.Map parameters)
          Creates an LDAP connection.

 

Method Summary
 java.lang.Object clone()
          Cloned LDAP connections will not contain a reference to the LDAP context.
protected  void cloneEnvironment()
          This method clones the LDAP context environment of this connection.
 void finalize()
          Finalizes the LDAP connection.
 java.util.Map getEnvironment()
          This method gets the LDAP context environment of this connection.
 javax.naming.ldap.LdapContext getLdapContext()
          Returns the LDAP context of this connection.
protected  java.util.Map getRecordedState()
          Returns recorded state of this connection.
 java.lang.String getType()
          Returns the connection type.
protected  void recordState()
          Records the connection state, called upon capture and remove operations.
protected  void setLdapContext(javax.naming.ldap.LdapContext context)
          Sets the LDAP context for this connection.
protected  void unrecordState()
          Unrecords the connection state, called upon release and return operations.
protected  void xprintBody(XmlPrintWriter out)
          This method prints the connection XML tag body.

 

Methods inherited from class oracle.idm.connection.Connection
check, compareTo, getBusyInfo, getCaptureInfo, getCloseInfo, getConnectionDelegate, getConnectionGroup, getConnectionPool, getIdleInfo, getInvalidateInfo, getLogger, getOpenInfo, getOperationInfo, getProxyInfo, getReleaseInfo, getRemoveInfo, getReturnInfo, getSerialNumber, getValidateInfo, isClone, isMatchingType, recordCapture, recordClose, recordInvalidate, recordOpen, recordProxy, recordRelease, recordRemove, recordReturn, recordValidate, xprint

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

TYPE

public static final java.lang.String TYPE
Use for LDAP connection type parameter value.
See Also:
Constant Field Values

Constructor Detail

LdapConnection

protected LdapConnection(LdapConnectionManager manager,
                         java.util.Map parameters)
Creates an LDAP connection.

Method Detail

finalize

public void finalize()
              throws java.lang.Throwable
Finalizes the LDAP connection.
Overrides:
finalize in class Connection
Throws:
java.lang.Throwable

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Cloned LDAP connections will not contain a reference to the LDAP context.

Connections are cloned when referenced in connection events and exceptions.

Overrides:
clone in class Connection
Returns:
cloned connection
Throws:
java.lang.CloneNotSupportedException

getType

public java.lang.String getType()
Description copied from class: Connection
Returns the connection type.
Specified by:
getType in class Connection
Returns:
string representing the connection type

getLdapContext

public javax.naming.ldap.LdapContext getLdapContext()
Returns the LDAP context of this connection.
Returns:
ldap context of this connection

setLdapContext

protected void setLdapContext(javax.naming.ldap.LdapContext context)
Sets the LDAP context for this connection.

getEnvironment

public java.util.Map getEnvironment()
This method gets the LDAP context environment of this connection.

It will hide all sensitive parameters.

Returns:
cloned environment map

cloneEnvironment

protected void cloneEnvironment()
This method clones the LDAP context environment of this connection.

It will hide all sensitive parameters.


getRecordedState

protected java.util.Map getRecordedState()
Returns recorded state of this connection.

recordState

protected void recordState()
                    throws ConnectionException
Records the connection state, called upon capture and remove operations.

This recorded state is used to check if the LDAP context has been altered by the connection users after the capture and remove operations.

Overrides:
recordState in class Connection
Throws:
ConnectionException

unrecordState

protected void unrecordState()
                      throws ConnectionException
Unrecords the connection state, called upon release and return operations.
Overrides:
unrecordState in class Connection
Throws:
ConnectionException

xprintBody

protected void xprintBody(XmlPrintWriter out)
Description copied from class: Connection
This method prints the connection XML tag body.
Overrides:
xprintBody in class Connection

Skip navigation links