@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDIFAddChangeRecord extends LDIFChangeRecord
LDIFChangeRecord
class for an example demonstrating the process for interacting with LDIF
change records.Constructor and Description |
---|
LDIFAddChangeRecord(AddRequest addRequest)
Creates a new LDIF add change record from the provided add request.
|
LDIFAddChangeRecord(Entry entry)
Creates a new LDIF add change record from the provided entry.
|
LDIFAddChangeRecord(Entry entry,
java.util.List<Control> controls)
Creates a new LDIF add change record from the provided entry.
|
LDIFAddChangeRecord(java.lang.String dn,
Attribute... attributes)
Creates a new LDIF add change record with the provided DN and attributes.
|
LDIFAddChangeRecord(java.lang.String dn,
Attribute[] attributes,
java.util.List<Control> controls)
Creates a new LDIF add change record with the provided DN and attributes.
|
LDIFAddChangeRecord(java.lang.String dn,
java.util.List<Attribute> attributes)
Creates a new LDIF add change record with the provided DN and attributes.
|
LDIFAddChangeRecord(java.lang.String dn,
java.util.List<Attribute> attributes,
java.util.List<Control> controls)
Creates a new LDIF add change record with the provided DN and attributes.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this LDIF change record.
|
Attribute[] |
getAttributes()
Retrieves the set of attributes for this add change record.
|
ChangeType |
getChangeType()
Retrieves the type of operation represented by this LDIF change record.
|
Entry |
getEntryToAdd()
Retrieves the entry that would be created by this add change record.
|
int |
hashCode()
Retrieves a hash code for this change record.
|
LDAPResult |
processChange(LDAPInterface connection,
boolean includeControls)
Apply the change represented by this LDIF change record to a directory
server using the provided connection, optionally including any change
record controls in the request.
|
AddRequest |
toAddRequest()
Creates an add request from this LDIF add change record.
|
AddRequest |
toAddRequest(boolean includeControls)
Creates an add request from this LDIF add change record, optionally
including any change record controls in the request.
|
void |
toLDIF(ByteStringBuffer buffer,
int wrapColumn)
Appends an LDIF string representation of this change record to the provided
buffer.
|
java.lang.String[] |
toLDIF(int wrapColumn)
Retrieves a string array whose lines contain an LDIF representation of this
change record.
|
void |
toLDIFString(java.lang.StringBuilder buffer,
int wrapColumn)
Appends an LDIF string representation of this change record to the provided
buffer.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a single-line string representation of this change record to the
provided buffer.
|
getControls, getDN, getParsedDN, processChange, toLDIF, toLDIF, toLDIFString, toLDIFString, toLDIFString, toString
public LDIFAddChangeRecord(java.lang.String dn, Attribute... attributes)
dn
- The DN for this LDIF add change record. It must not be
null
.attributes
- The set of attributes for this LDIF add change record.
It must not be null
or empty.public LDIFAddChangeRecord(java.lang.String dn, Attribute[] attributes, java.util.List<Control> controls)
dn
- The DN for this LDIF add change record. It must not be
null
.attributes
- The set of attributes for this LDIF add change record.
It must not be null
or empty.controls
- The set of controls for this LDIF add change record.
It may be null
or empty if there are no
controls.public LDIFAddChangeRecord(java.lang.String dn, java.util.List<Attribute> attributes)
dn
- The DN for this LDIF add change record. It must not be
null
.attributes
- The set of attributes for this LDIF add change record.
It must not be null
or empty.public LDIFAddChangeRecord(java.lang.String dn, java.util.List<Attribute> attributes, java.util.List<Control> controls)
dn
- The DN for this LDIF add change record. It must not be
null
.attributes
- The set of attributes for this LDIF add change record.
It must not be null
or empty.controls
- The set of controls for this LDIF add change record.
It may be null
or empty if there are no
controls.public LDIFAddChangeRecord(Entry entry)
entry
- The entry to use to create this LDIF add change record. It
must not be null
.public LDIFAddChangeRecord(Entry entry, java.util.List<Control> controls)
entry
- The entry to use to create this LDIF add change record.
It must not be null
.controls
- The set of controls for this LDIF add change record. It
may be null
or empty if there are no controls.public LDIFAddChangeRecord(AddRequest addRequest)
addRequest
- The add request to use to create this LDIF add change
record. It must not be null
.public Attribute[] getAttributes()
public Entry getEntryToAdd()
public AddRequest toAddRequest()
public AddRequest toAddRequest(boolean includeControls)
includeControls
- Indicates whether to include any controls in the
request.public ChangeType getChangeType()
getChangeType
in class LDIFChangeRecord
public LDAPResult processChange(LDAPInterface connection, boolean includeControls) throws LDAPException
processChange
in class LDIFChangeRecord
connection
- The connection to use to apply the change.includeControls
- Indicates whether to include any controls in the
request.LDAPException
- If an error occurs while processing this change
in the associated directory server.public java.lang.String[] toLDIF(int wrapColumn)
toLDIF
in interface LDIFRecord
toLDIF
in class LDIFChangeRecord
wrapColumn
- The column at which to wrap long lines. A value that
is less than or equal to two indicates that no
wrapping should be performed.public void toLDIF(ByteStringBuffer buffer, int wrapColumn)
toLDIF
in interface LDIFRecord
toLDIF
in class LDIFChangeRecord
buffer
- The buffer to which to append an LDIF representation of
this change record.wrapColumn
- The column at which to wrap long lines. A value that
is less than or equal to two indicates that no
wrapping should be performed.public void toLDIFString(java.lang.StringBuilder buffer, int wrapColumn)
toLDIFString
in interface LDIFRecord
toLDIFString
in class LDIFChangeRecord
buffer
- The buffer to which to append an LDIF representation of
this change record.wrapColumn
- The column at which to wrap long lines. A value that
is less than or equal to two indicates that no
wrapping should be performed.public int hashCode()
hashCode
in class LDIFChangeRecord
public boolean equals(java.lang.Object o)
equals
in class LDIFChangeRecord
o
- The object for which to make the determination.true
if the provided object is equal to this LDIF change
record, or false
if not.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDIFRecord
toString
in class LDIFChangeRecord
buffer
- The buffer to which the information should be written.