View Javadoc

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  package org.apache.shiro.util;
20  
21  import org.apache.shiro.ShiroException;
22  
23  /**
24   * Shiro container-agnostic interface that indicates that this object requires initialization.
25   *
26   * @since 0.2
27   */
28  public interface Initializable {
29  
30      /**
31       * Initializes this object.
32       *
33       * @throws org.apache.shiro.ShiroException
34       *          if an exception occurs during initialization.
35       */
36      void init() throws ShiroException;
37  
38  }