001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2006-2008 Sun Microsystems, Inc.
015 * Portions Copyright 2014-2016 ForgeRock AS.
016 */
017package org.opends.server.types.operation;
018
019import org.forgerock.opendj.ldap.AttributeDescription;
020import org.forgerock.opendj.ldap.ByteString;
021import org.forgerock.opendj.ldap.DN;
022import org.opends.server.types.Entry;
023
024/**
025 * This class defines a set of methods that are available for use by
026 * post-response plugins for compare operations.  Note that this
027 * interface is intended only to define an API for use by plugins and
028 * is not intended to be implemented by any custom classes.
029 */
030@org.opends.server.types.PublicAPI(
031     stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
032     mayInstantiate=false,
033     mayExtend=false,
034     mayInvoke=true)
035public interface PostResponseCompareOperation
036       extends PostResponseOperation
037{
038  /**
039   * Retrieves the raw, unprocessed entry DN as included in the client
040   * request.
041   *
042   * @return  The raw, unprocessed entry DN as included in the client
043   *          request.
044   */
045  ByteString getRawEntryDN();
046
047
048
049  /**
050   * Retrieves the DN of the entry to compare.
051   *
052   * @return  The DN of the entry to compare.
053   */
054  DN getEntryDN();
055
056
057
058  /**
059   * Retrieves the raw attribute type for this compare operation.
060   *
061   * @return  The raw attribute type for this compare operation.
062   */
063  String getRawAttributeType();
064
065
066
067  /**
068   * Retrieves the attribute description for this compare operation.
069   *
070   * @return The attribute description for this compare operation.
071   */
072  AttributeDescription getAttributeDescription();
073
074
075
076  /**
077   * Retrieves the assertion value for this compare operation.
078   *
079   * @return  The assertion value for this compare operation.
080   */
081  ByteString getAssertionValue();
082
083
084
085  /**
086   * Retrieves the entry to target with the compare operation.
087   *
088   * @return  The entry to target with the compare operation.
089   */
090  Entry getEntryToCompare();
091}
092