|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreOperationAddOperation
This class defines a set of methods that are available for use by pre-operation plugins for add operations. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.
Method Summary | |
---|---|
void |
addObjectClass(ObjectClass objectClass,
java.lang.String name)
Adds the provided objectclass to the entry to add. |
DN |
getEntryDN()
Retrieves the DN of the entry to add. |
Entry |
getEntryToAdd()
Retrieves the entry to be added to the server. |
java.util.Map<ObjectClass,java.lang.String> |
getObjectClasses()
Retrieves the set of processed objectclasses for the entry to add. |
java.util.Map<AttributeType,java.util.List<Attribute>> |
getOperationalAttributes()
Retrieves the set of processed operational attributes for the entry to add. |
java.util.List<RawAttribute> |
getRawAttributes()
Retrieves the set of attributes in their raw, unparsed form as read from the client request. |
ByteString |
getRawEntryDN()
Retrieves the DN of the entry to add in a raw, unparsed form as it was included in the request. |
java.util.Map<AttributeType,java.util.List<Attribute>> |
getUserAttributes()
Retrieves the set of processed user attributes for the entry to add. |
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 |
setAttribute(AttributeType attributeType,
java.util.List<Attribute> attributeList)
Sets the specified attribute in the entry to add, overwriting any existing attribute of the specified type if necessary. |
Methods inherited from interface org.opends.server.types.operation.PreOperationOperation |
---|
addResponseControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getAuthorizationDN, getErrorMessage, removeResponseControl, setAdditionalLogMessage, setErrorMessage |
Methods inherited from interface org.opends.server.types.operation.PluginOperation |
---|
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString |
Method Detail |
---|
ByteString getRawEntryDN()
java.util.List<RawAttribute> getRawAttributes()
DN getEntryDN()
java.util.Map<ObjectClass,java.lang.String> getObjectClasses()
void addObjectClass(ObjectClass objectClass, java.lang.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.java.util.Map<AttributeType,java.util.List<Attribute>> getUserAttributes()
java.util.Map<AttributeType,java.util.List<Attribute>> getOperationalAttributes()
void setAttribute(AttributeType attributeType, java.util.List<Attribute> attributeList)
attributeType
- The attribute type for the attribute.attributeList
- The attribute list for the provided
attribute type.void removeAttribute(AttributeType attributeType)
attributeType
- The attribute tyep for the attribute to
remove.Entry getEntryToAdd()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |