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 java.util.List;
032
033import org.forgerock.opendj.ldap.ByteString;
034import org.opends.server.types.RawModification;
035
036
037/**
038 * This class defines a set of methods that are available for use by
039 * pre-parse plugins for modify operations.  Note that this interface
040 * is intended only to define an API for use by plugins and is not
041 * intended to be implemented by any custom classes.
042 */
043@org.opends.server.types.PublicAPI(
044     stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
045     mayInstantiate=false,
046     mayExtend=false,
047     mayInvoke=true)
048public interface PreParseModifyOperation
049       extends PreParseOperation
050{
051  /**
052   * Retrieves the raw, unprocessed entry DN as included in the client
053   * request.  The DN that is returned may or may not be a valid DN,
054   * since no validation will have been performed upon it.
055   *
056   * @return  The raw, unprocessed entry DN as included in the client
057   *          request.
058   */
059  ByteString getRawEntryDN();
060
061
062
063  /**
064   * Specifies the raw, unprocessed entry DN as included in the client
065   * request.
066   *
067   * @param  rawEntryDN  The raw, unprocessed entry DN as included in
068   *                     the client request.
069   */
070  void setRawEntryDN(ByteString rawEntryDN);
071
072
073
074  /**
075   * Retrieves the set of raw, unprocessed modifications as included
076   * in the client request.  Note that this may contain one or more
077   * invalid modifications, as no validation will have been performed
078   * on this information.  The list returned must not be altered by
079   * the caller.
080   *
081   * @return  The set of raw, unprocessed modifications as included
082   *          in the client request.
083   */
084  List<RawModification> getRawModifications();
085
086
087
088  /**
089   * Adds the provided modification to the set of raw modifications
090   * for this modify operation.
091   *
092   * @param  rawModification  The modification to add to the set of
093   *                          raw modifications for this modify
094   *                          operation.
095   */
096  void addRawModification(RawModification rawModification);
097
098
099
100  /**
101   * Specifies the set of raw modifications for this modify operation.
102   *
103   * @param  rawModifications  The raw modifications for this modify
104   *                           operation.
105   */
106  void setRawModifications(List<RawModification> rawModifications);
107}