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.myfaces.config.annotation;
20  
21  import java.lang.reflect.InvocationTargetException;
22  
23  import javax.naming.NamingException;
24  
25  /**
26   * Proposed interface to annotation service. An implementation of this class needs to know the appropriate classloader,
27   * dependencies to be injected, and lifecycle methods to be called.
28   *
29   * @version $Rev: 1187700 $ $Date: 2011-10-22 07:19:37 -0500 (Sat, 22 Oct 2011) $
30   */
31  public interface LifecycleProvider {
32  
33      /**
34       * Create an object of the class with the supplied name, inject dependencies as appropriate,
35       * and call a postContruct method as appropriate.
36       *
37       * @param className name of the class of the desired object
38       * @return a fully constructed, dependency-injected, and initialized object.
39       */
40      Object newInstance(String className) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NamingException, InvocationTargetException;
41  
42      /**
43       * Take whatever steps are needed to shut down the object, including calling a preDestroy method.
44       *
45       * @param o object to shut down.
46       */
47      void destroyInstance(Object o) throws IllegalAccessException, InvocationTargetException;
48  }