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.extended;
021
022
023import org.apache.directory.api.i18n.I18n;
024import org.apache.directory.api.ldap.model.message.ExtendedResponseImpl;
025import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
026import org.apache.directory.api.util.Strings;
027
028
029/**
030 * An extended operation intended for notifying clients of upcoming
031 * disconnection for the Extended response. 
032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
033 */
034public final class ExtendedNoDResponse extends ExtendedResponseImpl
035{
036    /** The serial version UID */
037    static final long serialVersionUID = 2L;
038
039    /** The OID of the NotiveOfDisconnect extended operation. */
040    public static final String EXTENSION_OID = NoticeOfDisconnect.EXTENSION_OID;
041
042    /** The single instance with unavailable result code. */
043    public static final ExtendedNoDResponse UNAVAILABLE = new ExtendedNoDResponse( ResultCodeEnum.UNAVAILABLE );
044
045    /** The single instance with protocolError result code. */
046    public static final ExtendedNoDResponse PROTOCOLERROR = new ExtendedNoDResponse( ResultCodeEnum.PROTOCOL_ERROR );
047
048    /** The single instance with strongAuthRequired result code. */
049    public static final ExtendedNoDResponse STRONGAUTHREQUIRED = new ExtendedNoDResponse(
050        ResultCodeEnum.STRONG_AUTH_REQUIRED );
051
052
053    /**
054     * Creates a new instance of NoticeOfDisconnect.
055     */
056    private ExtendedNoDResponse( ResultCodeEnum rcode )
057    {
058        super( EXTENSION_OID );
059
060        switch ( rcode )
061        {
062            case UNAVAILABLE:
063                break;
064
065            case PROTOCOL_ERROR:
066                break;
067
068            case STRONG_AUTH_REQUIRED:
069                break;
070
071            default:
072                throw new IllegalArgumentException( I18n.err( I18n.ERR_04166, ResultCodeEnum.UNAVAILABLE,
073                    ResultCodeEnum.PROTOCOL_ERROR, ResultCodeEnum.STRONG_AUTH_REQUIRED ) );
074        }
075
076        super.getLdapResult().setDiagnosticMessage( rcode.toString() + ": The server will disconnect!" );
077        super.getLdapResult().setMatchedDn( null );
078        super.getLdapResult().setResultCode( rcode );
079    }
080
081
082    // ------------------------------------------------------------------------
083    // ExtendedResponse Interface Method Implementations
084    // ------------------------------------------------------------------------
085    /**
086     * Gets the reponse OID specific encoded response values.
087     * 
088     * @return the response specific encoded response values.
089     */
090    public byte[] getResponse()
091    {
092        return Strings.EMPTY_BYTES;
093    }
094
095
096    /**
097     * Gets the OID uniquely identifying this extended response (a.k.a. its
098     * name).
099     * 
100     * @return the OID of the extended response type.
101     */
102    public String getResponseName()
103    {
104        return EXTENSION_OID;
105    }
106}