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