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.ExtendedResponseImpl;
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 Extended response.
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public final class ExtendedNoDResponse extends ExtendedResponseImpl
35 {
36 /** The serial version UID */
37 static final long serialVersionUID = 2L;
38
39 /** The OID of the NotiveOfDisconnect extended operation. */
40 public static final String EXTENSION_OID = NoticeOfDisconnect.EXTENSION_OID;
41
42 /** The single instance with unavailable result code. */
43 public static final ExtendedNoDResponse UNAVAILABLE = new ExtendedNoDResponse( ResultCodeEnum.UNAVAILABLE );
44
45 /** The single instance with protocolError result code. */
46 public static final ExtendedNoDResponse PROTOCOLERROR = new ExtendedNoDResponse( ResultCodeEnum.PROTOCOL_ERROR );
47
48 /** The single instance with strongAuthRequired result code. */
49 public static final ExtendedNoDResponse STRONGAUTHREQUIRED = new ExtendedNoDResponse(
50 ResultCodeEnum.STRONG_AUTH_REQUIRED );
51
52
53 /**
54 * Creates a new instance of NoticeOfDisconnect.
55 */
56 private ExtendedNoDResponse( ResultCodeEnum rcode )
57 {
58 super( EXTENSION_OID );
59
60 switch ( rcode )
61 {
62 case UNAVAILABLE:
63 break;
64
65 case PROTOCOL_ERROR:
66 break;
67
68 case STRONG_AUTH_REQUIRED:
69 break;
70
71 default:
72 throw new IllegalArgumentException( I18n.err( I18n.ERR_04166, ResultCodeEnum.UNAVAILABLE,
73 ResultCodeEnum.PROTOCOL_ERROR, ResultCodeEnum.STRONG_AUTH_REQUIRED ) );
74 }
75
76 super.getLdapResult().setDiagnosticMessage( rcode.toString() + ": The server will disconnect!" );
77 super.getLdapResult().setMatchedDn( null );
78 super.getLdapResult().setResultCode( rcode );
79 }
80
81
82 // ------------------------------------------------------------------------
83 // ExtendedResponse Interface Method Implementations
84 // ------------------------------------------------------------------------
85 /**
86 * Gets the reponse OID specific encoded response values.
87 *
88 * @return the response specific encoded response values.
89 */
90 public byte[] getResponse()
91 {
92 return Strings.EMPTY_BYTES;
93 }
94
95
96 /**
97 * Gets the OID uniquely identifying this extended response (a.k.a. its
98 * name).
99 *
100 * @return the OID of the extended response type.
101 */
102 @Override
103 public String getResponseName()
104 {
105 return EXTENSION_OID;
106 }
107 }