org.opends.server.types.operation

Interface PreOperationCompareOperation

All Superinterfaces:

PluginOperation, PreOperationOperation

All Known Implementing Classes:

LocalBackendCompareOperation

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public interface PreOperationCompareOperation
extends PreOperationOperation

This class defines a set of methods that are available for use by pre-operation plugins for compare 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

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.ldap.ByteString	getAssertionValue() Retrieves the assertion value for this compare operation.
org.forgerock.opendj.ldap.AttributeDescription	getAttributeDescription() Retrieves the attribute description for this compare operation.
org.forgerock.opendj.ldap.DN	getEntryDN() Retrieves the DN of the entry to compare.
Entry	getEntryToCompare() Retrieves the entry to target with the compare operation.
String	getRawAttributeType() Retrieves the raw attribute type for this compare operation.
org.forgerock.opendj.ldap.ByteString	getRawEntryDN() Retrieves the raw, unprocessed entry DN as included in the client request.
void	setAssertionValue(org.forgerock.opendj.ldap.ByteString assertionValue) Specifies the assertion value for this compare operation.

Methods inherited from interface org.opends.server.types.operation.PreOperationOperation

addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, removeResponseControl, setErrorMessage

Methods inherited from interface org.opends.server.types.operation.PluginOperation

checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString

Method Detail

getRawEntryDN

org.forgerock.opendj.ldap.ByteString getRawEntryDN()

Retrieves the raw, unprocessed entry DN as included in the client request.

Returns:

The raw, unprocessed entry DN as included in the client request.

getEntryDN

org.forgerock.opendj.ldap.DN getEntryDN()

Retrieves the DN of the entry to compare.

Returns:

The DN of the entry to compare.

getRawAttributeType

String getRawAttributeType()

Retrieves the raw attribute type for this compare operation.

Returns:

The raw attribute type for this compare operation.

getAttributeDescription

org.forgerock.opendj.ldap.AttributeDescription getAttributeDescription()

Retrieves the attribute description for this compare operation.

Returns:

The attribute description for this compare operation.

getAssertionValue

org.forgerock.opendj.ldap.ByteString getAssertionValue()

Retrieves the assertion value for this compare operation.

Returns:

The assertion value for this compare operation.

setAssertionValue

void setAssertionValue(org.forgerock.opendj.ldap.ByteString assertionValue)

Specifies the assertion value for this compare operation.

Parameters:

assertionValue - The assertion value for this compare operation.

getEntryToCompare

Entry getEntryToCompare()

Retrieves the entry to target with the compare operation.

Returns:

The entry to target with the compare operation.