Package netscape.ldap.util
Interface LDIFContent
- All 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:
LDIFAttributeContent
(represents the content of an LDIF record that specifies an entry)LDIFAddContent
(represents the content of an LDIF record that adds a new entry)LDIFModifyContent
(represents the content of an LDIF record that modifies an entry)LDIFDeleteContent
(represents the content of an LDIF record that deletes an entry)LDIFModDNContent
(represents the content of an LDIF record that changes the RDN or DN of an entry)
- Version:
- 1.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The LDIF record specifies a new entry to be added.static final int
The LDIF record specifies an entry and its attributes.static final int
The LDIF record specifies an entry to be deleted.static final int
The LDIF record specifies changes to the DN or RDN of an entry.static final int
The LDIF record specifies modifications to an entry. -
Method Summary
Modifier and TypeMethodDescriptionRetrieves the list of controls specified in the content of the LDIF record, if anyint
getType()
Determines the content type.void
setControls
(LDAPControl[] controls) Sets the list of controlstoString()
Returns the string representation of the content of the LDIF record.
-
Field Details
-
ATTRIBUTE_CONTENT
static final int ATTRIBUTE_CONTENTThe LDIF record specifies an entry and its attributes.- See Also:
-
ADD_CONTENT
static final int ADD_CONTENTThe LDIF record specifies a new entry to be added.- See Also:
-
DELETE_CONTENT
static final int DELETE_CONTENTThe LDIF record specifies an entry to be deleted.- See Also:
-
MODIFICATION_CONTENT
static final int MODIFICATION_CONTENTThe LDIF record specifies modifications to an entry.- See Also:
-
MODDN_CONTENT
static final int MODDN_CONTENTThe LDIF record specifies changes to the DN or RDN of an entry.- See Also:
-
-
Method Details
-
getType
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)
-
getControls
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, ornull
if none were specified.
-
setControls
Sets the list of controls- Parameters:
controls
- an array ofLDAPControl
objects ornull
if none are to be specified
-
toString
String toString()Returns the string representation of the content of the LDIF record.
-