netscape.ldap.util

Interface LDIFContent

Known Implementing Classes:
LDIFAddContent, LDIFAttributeContent, LDIFBaseContent, LDIFDeleteContent, LDIFModDNContent, LDIFModifyContent

public interface LDIFContent

This interface represents the content of an LDIF record. An LDIF record can specify an entry or modifications to be made to an entry.

The following classes implement this interface:

Version:
1.0
See Also:
LDIFRecord, LDIFAttributeContent, LDIFAddContent, LDIFModifyContent, LDIFDeleteContent, LDIFModDNContent

Field Summary

static int
ADD_CONTENT
The LDIF record specifies a new entry to be added.
static int
ATTRIBUTE_CONTENT
The LDIF record specifies an entry and its attributes.
static int
DELETE_CONTENT
The LDIF record specifies an entry to be deleted.
static int
MODDN_CONTENT
The LDIF record specifies changes to the DN or RDN of an entry.
static int
MODIFICATION_CONTENT
The LDIF record specifies modifications to an entry.

Method Summary

LDAPControl[]
getControls()
Retrieves the list of controls specified in the content of the LDIF record, if any
int
getType()
Determines the content type.
void
setControls(LDAPControl[] controls)
Sets the list of controls
String
toString()
Returns the string representation of the content of the LDIF record.

Field Details

ADD_CONTENT

public static final int ADD_CONTENT
The LDIF record specifies a new entry to be added.
Field Value:
1

ATTRIBUTE_CONTENT

public static final int ATTRIBUTE_CONTENT
The LDIF record specifies an entry and its attributes.
Field Value:
0

DELETE_CONTENT

public static final int DELETE_CONTENT
The LDIF record specifies an entry to be deleted.
Field Value:
2

MODDN_CONTENT

public static final int MODDN_CONTENT
The LDIF record specifies changes to the DN or RDN of an entry.
Field Value:
4

MODIFICATION_CONTENT

public static final int MODIFICATION_CONTENT
The LDIF record specifies modifications to an entry.
Field Value:
3

Method Details

getControls

public LDAPControl[] getControls()
Retrieves the list of controls specified in the content of the LDIF record, if any
Returns:
an array of LDAPControl objects that represent any controls specified in the the LDIF record, or null if none were specified.

getType

public int getType()
Determines the content type.
Returns:
the content type, identified by one of the following values:
  • ATTRIBUTE_CONTENT (specifies an entry and its attributes)
  • ADD_CONTENT (specifies a new entry to be added)
  • DELETE_CONTENT (specifies an entry to be deleted)
  • MODIFICATION_CONTENT (specifies an entry to be modified)
  • MODDN_CONTENT (specifies a change to the RDN or DN of an entry)

setControls

public void setControls(LDAPControl[] controls)
Sets the list of controls
Parameters:
controls - an array of LDAPControl objects or null if none are to be specified

toString

public String toString()
Returns the string representation of the content of the LDIF record.
Returns:
string representation of the content of the LDIF record.