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.RawAttribute; 035 036 037/** 038 * This class defines a set of methods that are available for use by 039 * pre-parse plugins for add operations. Note that this interface is 040 * 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 PreParseAddOperation 049 extends PreParseOperation 050{ 051 /** 052 * Retrieves the DN of the entry to add in a raw, unparsed form as 053 * it was included in the request. This may or may not actually 054 * contain a valid DN, since no validation will have been performed 055 * on it. 056 * 057 * @return The DN of the entry in a raw, unparsed form. 058 */ 059 ByteString getRawEntryDN(); 060 061 062 063 /** 064 * Specifies the raw entry DN for the entry to add. 065 * 066 * @param rawEntryDN The raw entry DN for the entry to add. 067 */ 068 void setRawEntryDN(ByteString rawEntryDN); 069 070 071 072 /** 073 * Retrieves the set of attributes in their raw, unparsed form as 074 * read from the client request. Some of these attributes may be 075 * invalid as no validation will have been performed on them. The 076 * returned list must not be altered by the caller. 077 * 078 * @return The set of attributes in their raw, unparsed form as 079 * read from the client request. 080 */ 081 List<RawAttribute> getRawAttributes(); 082 083 084 085 /** 086 * Adds the provided attribute to the set of raw attributes for this 087 * add operation. 088 * 089 * @param rawAttribute The attribute to add to the set of raw 090 * attributes for this add operation. 091 */ 092 void addRawAttribute(RawAttribute rawAttribute); 093 094 095 096 /** 097 * Replaces the set of raw attributes for this add operation. 098 * 099 * @param rawAttributes The set of raw attributes for this add 100 * operation. 101 */ 102 void setRawAttributes(List<RawAttribute> rawAttributes); 103} 104