@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreOperationAddOperation extends PreOperationOperation
Modifier and Type | Method and Description |
---|---|
void |
addObjectClass(ObjectClass objectClass,
String name)
Adds the provided objectclass to the entry to add.
|
Iterable<Attribute> |
getAllAttributes()
Retrieves the set of attributes as read from the client request.
|
Entry |
getEntry()
Deprecated.
this will be removed when add operation will be closer to an add request
|
Dn |
getEntryDN()
Retrieves the DN of the entry to add.
|
Entry |
getEntryToAdd()
Retrieves the entry to be added to the server.
|
void |
removeAttribute(AttributeType attributeType)
Removes the specified attribute from the entry to add.
|
void |
removeObjectClass(ObjectClass objectClass)
Removes the provided objectclass from the entry to add.
|
void |
replaceAttribute(Attribute attribute)
Adds all of the attribute values contained in
attribute to this entry, replacing any existing attribute
values (optional operation). |
addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, removeResponseControl, setErrorMessage
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
Dn getEntryDN()
@Deprecated Entry getEntry()
void addObjectClass(ObjectClass objectClass, String name)
objectClass
- The objectclass to add to the entry.name
- The name to use for the objectclass.void removeObjectClass(ObjectClass objectClass)
objectClass
- The objectclass to remove from the entry.Iterable<Attribute> getAllAttributes()
void replaceAttribute(Attribute attribute)
attribute
to this entry, replacing any existing attribute
values (optional operation). If attribute
is empty then the entire attribute will be removed if it is
present.
NOTE: This method implements LDAP Modify replace semantics as described in RFC 4511 - Section 4.6. Modify Operation.
attribute
- The attribute values to be added to this entry, replacing any existing attribute values, and which may
be empty if the entire attribute is to be removed.UnsupportedOperationException
- If this entry does not permit attributes or their values to be replaced.NullPointerException
- If attribute
was null
.void removeAttribute(AttributeType attributeType)
attributeType
- The attribute tyep for the attribute to remove.Entry getEntryToAdd()
Copyright 2010-2018 ForgeRock AS.