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 */
020package org.apache.directory.api.ldap.model.message;
021
022
023/**
024 * Unbind protocol request message used to end a client session.
025 * 
026 * @author <a href="mailto:dev@directory.apache.org"> Apache Directory Project</a>
027 */
028public interface UnbindRequest extends Request
029{
030    /** Unbind request protocol message type */
031    MessageTypeEnum TYPE = MessageTypeEnum.UNBIND_REQUEST;
032
033
034    /**
035     * {@inheritDoc}
036     */
037    UnbindRequest setMessageId( int messageId );
038
039
040    /**
041     * {@inheritDoc}
042     */
043    UnbindRequest addControl( Control control );
044
045
046    /**
047     * {@inheritDoc}
048     */
049    UnbindRequest addAllControls( Control[] controls );
050
051
052    /**
053     * {@inheritDoc}
054     */
055    UnbindRequest removeControl( Control control );
056}