View Javadoc
1   /*
2    * Copyright 2012-2025 CodeLibs Project and the Others.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific language
14   * governing permissions and limitations under the License.
15   */
16  package org.codelibs.fess.exception;
17  
18  /**
19   * Exception thrown when a dependency injection container or component is not available.
20   * This exception indicates that the required container or a specific component within it cannot be accessed.
21   */
22  public class ContainerNotAvailableException extends FessSystemException {
23  
24      private static final long serialVersionUID = 1L;
25  
26      /** The name of the component that is not available. */
27      private String componentName;
28  
29      /**
30       * Constructor with component name.
31       * @param componentName The name of the component that is not available.
32       */
33      public ContainerNotAvailableException(final String componentName) {
34          super(componentName + " is not available.");
35          this.componentName = componentName;
36      }
37  
38      /**
39       * Constructor with component name and cause.
40       * @param componentName The name of the component that is not available.
41       * @param cause The cause of the exception.
42       */
43      public ContainerNotAvailableException(final String componentName, final Throwable cause) {
44          super(componentName + " is not available.", cause);
45          this.componentName = componentName;
46      }
47  
48      /**
49       * Constructor with cause only.
50       * @param cause The cause of the exception.
51       */
52      public ContainerNotAvailableException(final Throwable cause) {
53          super("Container is not available.");
54          componentName = "container";
55      }
56  
57      /**
58       * Gets the name of the component that is not available.
59       * @return The component name.
60       */
61      public String getComponentName() {
62          return componentName;
63      }
64  
65  }