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