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 * LDAP specific {@link LdapOperationException} that preserves resultCode
29 * resolution.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public class LdapServiceUnavailableException extends LdapOperationException
34 {
35 /** The serial version UUID */
36 static final long serialVersionUID = 1L;
37
38
39 /**
40 * Creates a new instance of LdapServiceUnavailableException.
41 *
42 * @param resultCode the ResultCodeEnum for this exception
43 * @param message The exception message
44 */
45 public LdapServiceUnavailableException( ResultCodeEnum resultCode, String message )
46 {
47 super( message );
48 checkResultCode( resultCode );
49 this.resultCode = resultCode;
50 }
51
52
53 /**
54 * Creates a new instance of LdapServiceUnavailableException.
55 *
56 * @param resultCode the ResultCodeEnum for this exception
57 */
58 public LdapServiceUnavailableException( ResultCodeEnum resultCode )
59 {
60 super( null );
61 checkResultCode( resultCode );
62 this.resultCode = resultCode;
63 }
64
65
66 /**
67 * Checks to make sure the resultCode value is right for this exception
68 * type.
69 *
70 * @throws IllegalArgumentException
71 * if the result code is not one of
72 * {@link ResultCodeEnum#BUSY},
73 * {@link ResultCodeEnum#UNAVAILABLE}.
74 */
75 private void checkResultCode( ResultCodeEnum resultCode )
76 {
77 switch ( resultCode )
78 {
79 case BUSY:
80 case UNAVAILABLE:
81 return;
82
83 default:
84 throw new IllegalArgumentException( I18n.err( I18n.ERR_04140_UNACCEPTABLE_RESULT_CODE, resultCode ) );
85 }
86 }
87 }