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;
022    
023    
024    import org.apache.directory.shared.ldap.entry.Entry;
025    import org.apache.directory.shared.ldap.name.LdapDN;
026    
027    
028    /**
029     * Add protocol operation request used to add a new entry to the DIT.
030     * 
031     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032     * @version $Revision: 764131 $
033     */
034    public interface InternalAddRequest extends SingleReplyRequest, InternalAbandonableRequest
035    {
036        /** LDAPv3 add request type enum code */
037        MessageTypeEnum TYPE = MessageTypeEnum.ADD_REQUEST;
038    
039        /** LDAPv3 add response type enum code */
040        MessageTypeEnum RESP_TYPE = InternalAddResponse.TYPE;
041    
042    
043        /**
044         * Gets the distinguished name of the entry to add.
045         * 
046         * @return the Dn of the added entry.
047         */
048        LdapDN getEntryDn();
049    
050    
051        /**
052         * Sets the distinguished name of the entry to add.
053         * 
054         * @param entry the Dn of the added entry.
055         */
056        void setEntryDn( LdapDN entry );
057    
058    
059        /**
060         * Gets the entry to add.
061         * 
062         * @return the added Entry
063         */
064        Entry getEntry();
065    
066    
067        /**
068         * Sets the Entry to add.
069         * 
070         * @param entry the added Entry
071         */
072        void setEntry( Entry entry );
073    }