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
023import org.apache.directory.api.i18n.I18n;
024
025
026/**
027 * Lockable UnbindRequest implementation.
028 * 
029 * @author <a href="mailto:dev@directory.apache.org"> Apache Directory Project</a>
030 */
031public class UnbindRequestImpl extends AbstractRequest implements UnbindRequest
032{
033    static final long serialVersionUID = -6217184085100410116L;
034
035
036    /**
037     * Creates an UnbindRequest which takes no parameter other than those in the
038     * outer envelope to disconnect and end a client session on the server
039     * without producing any response.
040     * 
041     * @param id the sequential message identifier.
042     */
043    public UnbindRequestImpl()
044    {
045        super( -1, MessageTypeEnum.UNBIND_REQUEST, false );
046    }
047
048
049    /**
050     * RFC 2251 [Section 4.11]: Abandon, Bind, Unbind, and StartTLS operations
051     * cannot be abandoned.
052     */
053    public void abandon()
054    {
055        throw new UnsupportedOperationException( I18n.err( I18n.ERR_04185 ) );
056    }
057
058
059    /**
060     * {@inheritDoc}
061     */
062    public UnbindRequest setMessageId( int messageId )
063    {
064        super.setMessageId( messageId );
065
066        return this;
067    }
068
069
070    /**
071     * {@inheritDoc}
072     */
073    public UnbindRequest addControl( Control control )
074    {
075        return ( UnbindRequest ) super.addControl( control );
076    }
077
078
079    /**
080     * {@inheritDoc}
081     */
082    public UnbindRequest addAllControls( Control[] controls )
083    {
084        return ( UnbindRequest ) super.addAllControls( controls );
085    }
086
087
088    /**
089     * {@inheritDoc}
090     */
091    public UnbindRequest removeControl( Control control )
092    {
093        return ( UnbindRequest ) super.removeControl( control );
094    }
095
096
097    /**
098     * Get a String representation of a UnBindRequest
099     * 
100     * @return A UnBindRequest String
101     */
102    public String toString()
103    {
104        StringBuilder sb = new StringBuilder();
105
106        sb.append( "    UnBind Request" );
107
108        // The controls
109        sb.append( super.toString() );
110
111        return super.toString( sb.toString() );
112    }
113}