Skip navigation links

com.octetstring.vde
Class EntryChanges

java.lang.Object
com.octetstring.vde.EntryChanges

All Implemented Interfaces:

java.io.Serializable

public class EntryChanges

extends java.lang.Object

implements java.io.Serializable

This class contains one set of changes to a single entry. A change may be an add, modify, delete, or rename. In the case of an add change, the entire changed entry is contained. For modify and delete changes, the distinguished name of the entry is contained. Modify changes will contain an array of EntryChange objects detailing each individual change from the original entry.

Author:

Octet String, Inc.

See Also:

Serialized Form

Field Summary

static int	CHANGE_ADD Constant indicating that change is an add operation
static int	CHANGE_DELETE Constant indicating that change is a delete operation
static int	CHANGE_MODIFY Constant indicating that change is a modify operation
static int	CHANGE_RENAME Constant indicating that change is a rename operation

Constructor Summary

EntryChanges(byte[] ecBytes)
Constructor that reads a set of entry bytes from a byte array

EntryChanges(byte[] ecBytes, int version)

EntryChanges(DirectoryString name, DirectoryString newname, Entry afterChange)
Constructor that generates a rename change from old and new DN values.

EntryChanges(DirectoryString name, Entry beforeDelete)
Constructor that generates a delete entry change from a DN

EntryChanges(DirectoryString name, EntryChange[] entryChanges, Entry afterChange)
Constructor that generates a modification change from a DN and an EntryChange array.

EntryChanges(Entry fullEntry)
Constructor that generates an add entry change from a full entry.

Method Summary

byte[]	getAsByteArray() Retrieve this object as an array of bytes suitable for storage on disk or otherwise serialized/persisted.
int	getChangeType() Retrieve the change type of this set of changes
EntryChange[]	getEntryChanges() Retrieve the EntryChanges array for modified entries
Entry	getFullEntry() Retrieve the Entry object for an added entry
DirectoryString	getName() Retrieve the name of a modified or deleted entry
DirectoryString	getNewName()

Methods inherited from class java.lang.Object

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

Field Detail

CHANGE_ADD

public static final int CHANGE_ADD

Constant indicating that change is an add operation

See Also:

Constant Field Values

CHANGE_MODIFY

public static final int CHANGE_MODIFY

Constant indicating that change is a modify operation

See Also:

Constant Field Values

CHANGE_DELETE

public static final int CHANGE_DELETE

Constant indicating that change is a delete operation

See Also:

Constant Field Values

CHANGE_RENAME

public static final int CHANGE_RENAME

Constant indicating that change is a rename operation

See Also:

Constant Field Values

Constructor Detail

EntryChanges

public EntryChanges(byte[] ecBytes)

Constructor that reads a set of entry bytes from a byte array

Parameters:

ecBytes - a byte representation of an EntryChanges representation generated by the getAsByteArray method

EntryChanges

public EntryChanges(byte[] ecBytes,
                    int version)

EntryChanges

public EntryChanges(Entry fullEntry)

Constructor that generates an add entry change from a full entry.

Parameters:

fullEntry - an Entry object that has been added

EntryChanges

public EntryChanges(DirectoryString name,
                    Entry beforeDelete)

Constructor that generates a delete entry change from a DN

Parameters:

name - distinguished name of the deleted entry

EntryChanges

public EntryChanges(DirectoryString name,
                    EntryChange[] entryChanges,
                    Entry afterChange)

Constructor that generates a modification change from a DN and an EntryChange array.

Parameters:

name - distinguished name of the changed entry

entryChanges - array of individual changes to the entry

EntryChanges

public EntryChanges(DirectoryString name,
                    DirectoryString newname,
                    Entry afterChange)

Constructor that generates a rename change from old and new DN values.

Parameters:

name - distinguished name of the changed entry

newname - new name for the changed entry

Method Detail

getChangeType

public int getChangeType()

Retrieve the change type of this set of changes

Returns:

change type number

getEntryChanges

public EntryChange[] getEntryChanges()

Retrieve the EntryChanges array for modified entries

Returns:

entry changes

getFullEntry

public Entry getFullEntry()

Retrieve the Entry object for an added entry

Returns:

full entry

getName

public DirectoryString getName()

Retrieve the name of a modified or deleted entry

Returns:

distinguished name

getNewName

public DirectoryString getNewName()

getAsByteArray

public byte[] getAsByteArray()

Retrieve this object as an array of bytes suitable for storage on disk or otherwise serialized/persisted.

Returns:

byte array representation of this set of changes

Skip navigation links