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 * http://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.CompareResponseImpl;
25 import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
26
27
28 /**
29 * An extended operation intended for notifying clients of upcoming
30 * disconnection for the Compare response.
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public class CompareNoDResponse extends CompareResponseImpl
34 {
35 /** The OID of the NotiveOfDisconnect extended operation. */
36 public static final String EXTENSION_OID = NoticeOfDisconnect.EXTENSION_OID;
37
38 /** The empty response */
39 private static final byte[] EMPTY_RESPONSE = new byte[0];
40
41 /** The single instance with unavailable result code. */
42 public static final CompareNoDResponse UNAVAILABLE = new CompareNoDResponse( ResultCodeEnum.UNAVAILABLE );
43
44 /** The single instance with protocolError result code. */
45 public static final CompareNoDResponse PROTOCOLERROR = new CompareNoDResponse( ResultCodeEnum.PROTOCOL_ERROR );
46
47 /** The single instance with strongAuthRequired result code. */
48 public static final CompareNoDResponse STRONGAUTHREQUIRED = new CompareNoDResponse(
49 ResultCodeEnum.STRONG_AUTH_REQUIRED );
50
51
52 /**
53 * Creates a new instance of NoticeOfDisconnect.
54 */
55 private CompareNoDResponse( 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_04166, 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 EMPTY_RESPONSE;
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 }