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
021package org.apache.directory.api.ldap.model.message;
022
023
024import org.apache.directory.api.ldap.model.entry.Entry;
025import org.apache.directory.api.ldap.model.name.Dn;
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 */
033public interface AddRequest extends SingleReplyRequest<AddResponse>, AbandonableRequest
034{
035    /** LDAPv3 add request type enum code */
036    MessageTypeEnum TYPE = MessageTypeEnum.ADD_REQUEST;
037
038    /** LDAPv3 add response type enum code */
039    MessageTypeEnum RESP_TYPE = AddResponse.TYPE;
040
041
042    /**
043     * Gets the distinguished name of the entry to add.
044     * 
045     * @return the Dn of the added entry.
046     */
047    Dn getEntryDn();
048
049
050    /**
051     * Sets the distinguished name of the entry to add.
052     * 
053     * @param entry the Dn of the added entry.
054     * @return The AddRequest instance
055     */
056    AddRequest setEntryDn( Dn 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     * @return The AddRequest instance
072     */
073    AddRequest setEntry( Entry entry );
074
075
076    /**
077     * {@inheritDoc}
078     */
079    AddRequest setMessageId( int messageId );
080
081
082    /**
083     * {@inheritDoc}
084     */
085    AddRequest addControl( Control control );
086
087
088    /**
089     * {@inheritDoc}
090     */
091    AddRequest addAllControls( Control[] controls );
092
093
094    /**
095     * {@inheritDoc}
096     */
097    AddRequest removeControl( Control control );
098}