oracle.ldap.ospf

Class LdapModification

java.lang.Object

oracle.ldap.ospf.LdapModification

public final class LdapModification
extends java.lang.Object

Defines modification information that needs to be passed between the Oracle directory server and the Java plug-in. Contains the following information:

• Collection of ModificationItems

Since:

10g Release 3 (10.1.4)

Version:

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

Author:

saroy

Field Summary

Fields

Modifier and Type	Field and Description
static int	LDAP_MOD_ADD Attribute/Attribute value addition
static int	LDAP_MOD_DELETE Attribute/Attribute value deletion
static int	LDAP_MOD_REPLACE Attribute value replacement

Constructor Summary

Constructors

Constructor and Description
LdapModification() Constructor for creating a LdapModification

Method Summary

Modifier and Type	Method and Description
void	addModificationItem(int modop, javax.naming.directory.Attribute attr) Adds a ModificationItem in the LdapModification with the LdapModification operation code
javax.naming.directory.ModificationItem[]	getAllModificationItems() Returns an array of Modification Items in the LdapModification
javax.naming.directory.ModificationItem	getModificationItemAt(int index) Gets a copy of the required ModificationItem from the LdapModification
boolean	insertModificationItemAt(int modop, javax.naming.directory.Attribute attr, int index) Inserts a ModificationItem in the LdapModification with the LdapModification operation code at the specified position in the collection.
boolean	removeModificationItemAt(int index) Removes the ModificationItem in the LdapModification from the specified position in the collection.
void	setAllModificationItems(javax.naming.directory.ModificationItem[] modItems) Sets an array of Modification Items in the LdapModification.
boolean	setModificationItemAt(int modop, javax.naming.directory.Attribute attr, int index) Sets a ModificationItem in the LdapModification with the LdapModification operation code at the specified position in the collection.
int	size() Gets the count of the ModificationItems in the LdapModification

Methods inherited from class java.lang.Object

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

Field Detail

LDAP_MOD_ADD

public static final int LDAP_MOD_ADD

Attribute/Attribute value addition

See Also:

Constant Field Values

LDAP_MOD_DELETE

public static final int LDAP_MOD_DELETE

Attribute/Attribute value deletion

See Also:

Constant Field Values

LDAP_MOD_REPLACE

public static final int LDAP_MOD_REPLACE

Attribute value replacement

See Also:

Constant Field Values

Constructor Detail

LdapModification

public LdapModification()

Constructor for creating a LdapModification

Method Detail

getModificationItemAt

public javax.naming.directory.ModificationItem getModificationItemAt(int index)
                                                              throws java.lang.ArrayIndexOutOfBoundsException

Gets a copy of the required ModificationItem from the LdapModification

Returns:

modItem - ModificationItem.

Throws:

java.lang.ArrayIndexOutOfBoundsException

size

public int size()

Gets the count of the ModificationItems in the LdapModification

Returns:

modItemCount - Count of the number of ModificationItems.

addModificationItem

public void addModificationItem(int modop,
                                javax.naming.directory.Attribute attr)

Adds a ModificationItem in the LdapModification with the LdapModification operation code

Parameters:

modop - - LdapModification operation code

Valid LdapModification operation codes

• LDAP_MOD_ADD - 0x01
• LDAP_MOD_REPLACE - 0x02
• LDAP_MOD_DELETE - 0x03

attr - - Attribute to be modified

setModificationItemAt

public boolean setModificationItemAt(int modop,
                                     javax.naming.directory.Attribute attr,
                                     int index)

Sets a ModificationItem in the LdapModification with the LdapModification operation code at the specified position in the collection. The old ModificationItem in the specified index is replaced with the new. Returns false if index is invalid

Parameters:

modop - - LdapModification operation code Valid LdapModification operation codes

• LDAP_MOD_ADD - 0x01
• LDAP_MOD_REPLACE - 0x02
• LDAP_MOD_DELETE - 0x03

attr - - Attribute to be modified

index - - Index where the ModificationItem is to inserted

Returns:

result - True for success, false otherwise

insertModificationItemAt

public boolean insertModificationItemAt(int modop,
                                        javax.naming.directory.Attribute attr,
                                        int index)

Inserts a ModificationItem in the LdapModification with the LdapModification operation code at the specified position in the collection. Each ModificationItem having an index greater than or equal to the specified index is shifted upward to have an index one greater than the value it had previously. Returns false if index is invalid

Parameters:

modop - - LdapModification operation code Valid LdapModification operation codes

• LDAP_MOD_ADD - 0x01
• LDAP_MOD_REPLACE - 0x02
• LDAP_MOD_DELETE - 0x03

attr - - Attribute to be modified

index - - Index where the ModificationItem is to inserted

Returns:

result - True for success, false otherwise

removeModificationItemAt

public boolean removeModificationItemAt(int index)

Removes the ModificationItem in the LdapModification from the specified position in the collection. The subsequent elements are shifted to the left. That is, one is subtracted from each of their indices. Returns false if index is invalid

Parameters:

index - - Index from where the ModificationItem is to be removed

Returns:

result - True for success, false otherwise

setAllModificationItems

public void setAllModificationItems(javax.naming.directory.ModificationItem[] modItems)

Sets an array of Modification Items in the LdapModification. If the LdapModification already contains an existing collection of ModificationItems, this method replaces them with the new collection of ModificationItems.

Parameters:

modItems - - Array of ModificationItems

getAllModificationItems

public javax.naming.directory.ModificationItem[] getAllModificationItems()

Returns an array of Modification Items in the LdapModification

Returns:

modItems - Array of ModificationItems