001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020 021 package org.apache.directory.shared.ldap.message.internal; 022 023 024 import org.apache.directory.shared.ldap.codec.MessageTypeEnum; 025 import org.apache.directory.shared.ldap.entry.Entry; 026 import org.apache.directory.shared.ldap.message.SingleReplyRequest; 027 import org.apache.directory.shared.ldap.name.DN; 028 029 030 /** 031 * Add protocol operation request used to add a new entry to the DIT. 032 * 033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 034 * @version $Revision: 918756 $ 035 */ 036 public interface InternalAddRequest extends SingleReplyRequest, InternalAbandonableRequest 037 { 038 /** LDAPv3 add request type enum code */ 039 MessageTypeEnum TYPE = MessageTypeEnum.ADD_REQUEST; 040 041 /** LDAPv3 add response type enum code */ 042 MessageTypeEnum RESP_TYPE = InternalAddResponse.TYPE; 043 044 045 /** 046 * Gets the distinguished name of the entry to add. 047 * 048 * @return the Dn of the added entry. 049 */ 050 DN getEntryDn(); 051 052 053 /** 054 * Sets the distinguished name of the entry to add. 055 * 056 * @param entry the Dn of the added entry. 057 */ 058 void setEntryDn( DN entry ); 059 060 061 /** 062 * Gets the entry to add. 063 * 064 * @return the added Entry 065 */ 066 Entry getEntry(); 067 068 069 /** 070 * Sets the Entry to add. 071 * 072 * @param entry the added Entry 073 */ 074 void setEntry( Entry entry ); 075 }