org.apache.webbeans.spi.plugins.OpenWebBeansPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openejb-lite
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.webbeans.spi.plugins;


/**
 * Interface which all OpenWebBeans plugins have to implement to
 * extend the webbeans-core with additional IOC functionality.
 * 
 * There are 4 different types of functions for this interface:
 * 

 *  
 *    plugin lifecycle like {@code #startUp()} and {@code #shutDown()}
 *  
 *  
 *    injection execution will be called every time a been get's
 *    injected like {@code #injectResource(Type, Annotation[])}
 *  
 *  
 * @see PluginLoader for documentation of the whole mechanism
 */
public interface OpenWebBeansPlugin
{
    /**
     * initialise the plugin.
     * This is called once after the very plugin has been loaded.
     */
    public void startUp();

    /**
     * At shutdown, the plugin must release all locked resources.
     * This is called once before the very plugin gets destroyed.
     * This is usually the case when the WebApplication gets stopped.
     * @throws WebBeansConfigurationException
     */
    public void shutDown();
    

    /**
     * Make sure that the given class is ok for simple web bean conditions, 
     * otherwise throw a {@code WebBeansConfigurationException}
     * @param clazz the class to check
     * @throws WebBeansConfigurationException if the given clazz cannot be used as simple web bean.
     */
    public void isManagedBean(Class clazz);
    
    /**
     * Returns true if plugin provides given service implementation
     * false otherwise.
     * @param serviceClass any service class
     * @return true if plugin provides given service implementation
     */
    public boolean supportService(Class serviceClass);
    
    /**
     * Returns true if given class supports injections,
     * false otherwise.
     * @param targetClass any target class
     * @return true if given class supports injections
     */
    public boolean supportsJavaEeComponentInjections(Class targetClass);
    
    
    /**
     * Gets service instance.
     * @param  type
     * @param serviceClass service class
     * @return service
     */
    public  T getSupportedService(Class serviceClass);
}