1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.model.message.extended;
21
22
23 import org.apache.directory.api.i18n.I18n;
24 import org.apache.directory.api.ldap.model.message.DeleteResponseImpl;
25 import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
26 import org.apache.directory.api.util.Strings;
27
28
29 /**
30 * An extended operation intended for notifying clients of upcoming
31 * disconnection for the Delete response.
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public final class DeleteNoDResponse extends DeleteResponseImpl
35 {
36 /** The OID of the NotiveOfDisconnect extended operation. */
37 public static final String EXTENSION_OID = NoticeOfDisconnect.EXTENSION_OID;
38
39 /** The single instance with unavailable result code. */
40 public static final DeleteNoDResponse UNAVAILABLE = new DeleteNoDResponse( ResultCodeEnum.UNAVAILABLE );
41
42 /** The single instance with protocolError result code. */
43 public static final DeleteNoDResponse PROTOCOLERROR = new DeleteNoDResponse( ResultCodeEnum.PROTOCOL_ERROR );
44
45 /** The single instance with strongAuthRequired result code. */
46 public static final DeleteNoDResponse STRONGAUTHREQUIRED = new DeleteNoDResponse(
47 ResultCodeEnum.STRONG_AUTH_REQUIRED );
48
49
50 /**
51 * Creates a new instance of NoticeOfDisconnect.
52 *
53 * @param rcode The {@link ResultCodeEnum} value to wrap
54 */
55 private DeleteNoDResponse( ResultCodeEnum rcode )
56 {
57 super();
58
59 switch ( rcode )
60 {
61 case UNAVAILABLE:
62 break;
63
64 case PROTOCOL_ERROR:
65 break;
66
67 case STRONG_AUTH_REQUIRED:
68 break;
69
70 default:
71 throw new IllegalArgumentException( I18n.err( I18n.ERR_13503_RESULT_CODE_SHOULD_BE_IN, ResultCodeEnum.UNAVAILABLE,
72 ResultCodeEnum.PROTOCOL_ERROR, ResultCodeEnum.STRONG_AUTH_REQUIRED ) );
73 }
74
75 super.getLdapResult().setDiagnosticMessage( rcode.toString() + ": The server will disconnect!" );
76 super.getLdapResult().setMatchedDn( null );
77 super.getLdapResult().setResultCode( rcode );
78 }
79
80
81 // ------------------------------------------------------------------------
82 // ExtendedResponse Interface Method Implementations
83 // ------------------------------------------------------------------------
84 /**
85 * Gets the reponse OID specific encoded response values.
86 *
87 * @return the response specific encoded response values.
88 */
89 public byte[] getResponse()
90 {
91 return Strings.EMPTY_BYTES;
92 }
93
94
95 /**
96 * Gets the OID uniquely identifying this extended response (a.k.a. its
97 * name).
98 *
99 * @return the OID of the extended response type.
100 */
101 public String getResponseName()
102 {
103 return EXTENSION_OID;
104 }
105 }