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.forgerock.opendj.ldap.ByteString;
032
033
034/**
035 * This class defines a set of methods that are available for use by
036 * pre-parse plugins for compare operations.  Note that this interface
037 * is intended only to define an API for use by plugins and is not
038 * intended to be implemented by any custom classes.
039 */
040@org.opends.server.types.PublicAPI(
041     stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
042     mayInstantiate=false,
043     mayExtend=false,
044     mayInvoke=true)
045public interface PreParseCompareOperation
046       extends PreParseOperation
047{
048  /**
049   * Retrieves the raw, unprocessed entry DN as included in the client
050   * request.
051   *
052   * @return  The raw, unprocessed entry DN as included in the client
053   *          request.
054   */
055  ByteString getRawEntryDN();
056
057
058
059  /**
060   * Specifies the raw, unprocessed entry DN as included in the client
061   * request.
062   *
063   * @param  rawEntryDN  The raw entry DN for this compare operation.
064   */
065  void setRawEntryDN(ByteString rawEntryDN);
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   * Specifies the raw attribute type for this compare operation.
080   *
081   * @param  rawAttributeType  The raw attribute type for this compare
082   *                           operation.
083   */
084  void setRawAttributeType(String rawAttributeType);
085
086
087
088  /**
089   * Retrieves the assertion value for this compare operation.
090   *
091   * @return  The assertion value for this compare operation.
092   */
093  ByteString getAssertionValue();
094
095
096
097  /**
098   * Specifies the assertion value for this compare operation.
099   *
100   * @param  assertionValue  The assertion value for this compare
101   *                         operation.
102   */
103  void setAssertionValue(ByteString assertionValue);
104}
105