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.exception;
21
22
23 import org.apache.directory.api.i18n.I18n;
24 import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
25
26
27 /**
28 * An LDAPException that extends the {@link LdapOperationException}
29 * carrying with it the corresponding result codes for this condition.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public class LdapUnwillingToPerformException extends LdapOperationException
34 {
35 /** The serial version UUID */
36 static final long serialVersionUID = 1L;
37
38
39 /**
40 * Creates a new instance of LdapUnwillingToPerformException, with
41 * a default ResultCode to UNWILING_TO_PERFORM.
42 */
43 public LdapUnwillingToPerformException()
44 {
45 super( ResultCodeEnum.UNWILLING_TO_PERFORM, null );
46 }
47
48
49 /**
50 * Creates a new instance of LdapUnwillingToPerformException.
51 *
52 * @param resultCode the ResultCodeEnum for this exception
53 * @param message The exception message
54 */
55 public LdapUnwillingToPerformException( ResultCodeEnum resultCode, String message )
56 {
57 super( message );
58 checkResultCode( resultCode );
59 this.resultCode = resultCode;
60 }
61
62
63 /**
64 *
65 * @param resultCode the ResultCodeEnum for this exception
66 * @param message The exception message
67 * @param cause The root cause for this exception
68 */
69 public LdapUnwillingToPerformException( ResultCodeEnum resultCode, String message, Throwable cause )
70 {
71 super( message, cause );
72 checkResultCode( resultCode );
73 this.resultCode = resultCode;
74 }
75
76
77 /**
78 * Creates a new instance of LdapUnwillingToPerformException.
79 *
80 * @param message The exception message
81 */
82 public LdapUnwillingToPerformException( String message )
83 {
84 super( ResultCodeEnum.UNWILLING_TO_PERFORM, message );
85 }
86
87
88 /**
89 * Creates a new instance of LdapUnwillingToPerformException.
90 *
91 * @param resultCode the ResultCodeEnum for this exception
92 */
93 public LdapUnwillingToPerformException( ResultCodeEnum resultCode )
94 {
95 super( null );
96 checkResultCode( resultCode );
97 this.resultCode = resultCode;
98 }
99
100
101 /**
102 * Checks to make sure the resultCode value is right for this exception
103 * type.
104 *
105 * @throws IllegalArgumentException
106 * if the result code is not one of
107 * {@link ResultCodeEnum#UNWILLING_TO_PERFORM},
108 * {@link ResultCodeEnum#UNAVAILABLE_CRITICAL_EXTENSION}.
109 */
110 private void checkResultCode( ResultCodeEnum resultCode )
111 {
112 switch ( resultCode )
113 {
114 case UNWILLING_TO_PERFORM:
115 case UNAVAILABLE_CRITICAL_EXTENSION:
116 return;
117
118 default:
119 throw new IllegalArgumentException( I18n.err( I18n.ERR_04140_UNACCEPTABLE_RESULT_CODE, resultCode ) );
120 }
121 }
122 }