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
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2006-2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.types.operation;
028
029
030
031 import java.util.List;
032
033 import org.opends.server.types.ByteString;
034 import org.opends.server.types.RawModification;
035
036
037
038 /**
039 * This class defines a set of methods that are available for use by
040 * pre-parse plugins for modify operations. Note that this interface
041 * is intended only to define an API for use by plugins and is not
042 * intended to be implemented by any custom classes.
043 */
044 @org.opends.server.types.PublicAPI(
045 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
046 mayInstantiate=false,
047 mayExtend=false,
048 mayInvoke=true)
049 public interface PreParseModifyOperation
050 extends PreParseOperation
051 {
052 /**
053 * Retrieves the raw, unprocessed entry DN as included in the client
054 * request. The DN that is returned may or may not be a valid DN,
055 * since no validation will have been performed upon it.
056 *
057 * @return The raw, unprocessed entry DN as included in the client
058 * request.
059 */
060 public ByteString getRawEntryDN();
061
062
063
064 /**
065 * Specifies the raw, unprocessed entry DN as included in the client
066 * request.
067 *
068 * @param rawEntryDN The raw, unprocessed entry DN as included in
069 * the client request.
070 */
071 public void setRawEntryDN(ByteString rawEntryDN);
072
073
074
075 /**
076 * Retrieves the set of raw, unprocessed modifications as included
077 * in the client request. Note that this may contain one or more
078 * invalid modifications, as no validation will have been performed
079 * on this information. The list returned must not be altered by
080 * the caller.
081 *
082 * @return The set of raw, unprocessed modifications as included
083 * in the client request.
084 */
085 public List<RawModification> getRawModifications();
086
087
088
089 /**
090 * Adds the provided modification to the set of raw modifications
091 * for this modify operation.
092 *
093 * @param rawModification The modification to add to the set of
094 * raw modifications for this modify
095 * operation.
096 */
097 public void addRawModification(RawModification rawModification);
098
099
100
101 /**
102 * Specifies the set of raw modifications for this modify operation.
103 *
104 * @param rawModifications The raw modifications for this modify
105 * operation.
106 */
107 public void setRawModifications(
108 List<RawModification> rawModifications);
109 }
110