oracle.ldap.ospf

Class LdapOperation

java.lang.Object

oracle.ldap.ospf.LdapOperation

Direct Known Subclasses:

AddLdapOperation, BindLdapOperation, CompareLdapOperation, DeleteLdapOperation, ModdnLdapOperation, ModifyLdapOperation, SearchLdapOperation

public class LdapOperation
extends java.lang.Object

Defines operation specific LDAP information that needs to pass between the Oracle directory server and the Java plug-in. Contains the following information:

• Bind DN
• Server Controls
• Operation Result Code

The WHEN_REPLACE plug-in can return the LdapOperation object with the class's static fields as LDAP result codes. These LDAP result codes are ignored when returned with an LdapOperation object from the PRE, WHEN or POST plug-ins.

Since:

10g Release 3 (10.1.4)

Version:

$Header: LdapOperation.java 05-may-2006.03:24:52 saroy Exp $

Author:

saroy

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	LDAP_ENTRY_ADD Constant to add an Entry
protected static int	LDAP_ENTRY_BIND Constant to bind to an Entry
protected static int	LDAP_ENTRY_COMPARE Constant to compare an attribute value in an Entry
protected static int	LDAP_ENTRY_DELETE Constant to delete an Entry
protected static int	LDAP_ENTRY_MODDN Constant to modify a DN in an Entry
protected static int	LDAP_ENTRY_MODIFY Constant to modify an Entry
protected static int	LDAP_ENTRY_SEARCH Constant to search an Entry/Entries
static int	LDAP_SUCCESS LDAP Success
protected java.lang.String	m_bindDN
protected int	m_ldapOpCode
protected int	m_opResCode
protected java.lang.String	m_opResMsg
protected java.util.Vector	m_srvCtrls

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LdapOperation() Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBindDN() Gets the bind DN from the LdapOperation object
int	getOperationResultCode() Gets the LDAP Operation result code from the LdapOperation object.
protected int	getOperationType() For Internal Use Only - Private Method Retrieve the LDAP Operation Code from the LdapOperation object
java.util.Vector	getServerControls() Gets the server controls from the LdapOperation object.
protected void	setBindDN(java.lang.String bindDN) Set the Bind DN in the LdapOperation object
void	setOperationResultCode(int opResCode) Sets the LDAP Operation result code in the LdapOperation object.
protected void	setOperationType(int ldapOpCode) For Internal Use Only - Private Method Set the LDAP Operation Code in the LdapOperation object
protected void	setServerControls(java.util.Vector srvCtrls) For Internal Use Only - Private Method Set the Server Controls in the LdapOperation

Methods inherited from class java.lang.Object

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

Field Detail

m_bindDN

protected java.lang.String m_bindDN

m_ldapOpCode

protected int m_ldapOpCode

m_srvCtrls

protected java.util.Vector m_srvCtrls

m_opResCode

protected int m_opResCode

m_opResMsg

protected java.lang.String m_opResMsg

LDAP_ENTRY_MODIFY

protected static final int LDAP_ENTRY_MODIFY

Constant to modify an Entry

See Also:

Constant Field Values

LDAP_ENTRY_BIND

protected static final int LDAP_ENTRY_BIND

Constant to bind to an Entry

See Also:

Constant Field Values

LDAP_ENTRY_DELETE

protected static final int LDAP_ENTRY_DELETE

Constant to delete an Entry

See Also:

Constant Field Values

LDAP_ENTRY_SEARCH

protected static final int LDAP_ENTRY_SEARCH

Constant to search an Entry/Entries

See Also:

Constant Field Values

LDAP_ENTRY_COMPARE

protected static final int LDAP_ENTRY_COMPARE

Constant to compare an attribute value in an Entry

See Also:

Constant Field Values

LDAP_ENTRY_ADD

protected static final int LDAP_ENTRY_ADD

Constant to add an Entry

See Also:

Constant Field Values

LDAP_ENTRY_MODDN

protected static final int LDAP_ENTRY_MODDN

Constant to modify a DN in an Entry

See Also:

Constant Field Values

LDAP_SUCCESS

public static final int LDAP_SUCCESS

LDAP Success

See Also:

Constant Field Values

Constructor Detail

LdapOperation

protected LdapOperation()

Constructor

Method Detail

setBindDN

protected void setBindDN(java.lang.String bindDN)

Set the Bind DN in the LdapOperation object

Parameters:

bindDN - - Bind DN

getBindDN

public java.lang.String getBindDN()

Gets the bind DN from the LdapOperation object

Returns:

bindDN - Bind DN

getOperationType

protected int getOperationType()

For Internal Use Only - Private Method Retrieve the LDAP Operation Code from the LdapOperation object

Returns:

ldapOpCode - LDAP operation

setOperationType

protected void setOperationType(int ldapOpCode)

For Internal Use Only - Private Method Set the LDAP Operation Code in the LdapOperation object

Parameters:

ldapOpCode - - LDAP Operation

getServerControls

public java.util.Vector getServerControls()

Gets the server controls from the LdapOperation object. This method will return null if no server controls were specified during the operation

Returns:

srvCtrls - Server controls

setServerControls

protected void setServerControls(java.util.Vector srvCtrls)

For Internal Use Only - Private Method Set the Server Controls in the LdapOperation

Parameters:

srvCtrls - - Server controls

getOperationResultCode

public int getOperationResultCode()

Gets the LDAP Operation result code from the LdapOperation object. This is only relevent in a POST Plug-in.

Returns:

opResCode - LDAP Operation result code

setOperationResultCode

public void setOperationResultCode(int opResCode)

Sets the LDAP Operation result code in the LdapOperation object. This is only relevent in a WHEN_REPLACE Plug-in.

Parameters:

opResCode - - LDAP Operation result code