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