com.sun.enterprise.container.common.spi.util.InjectionManager Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2014 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.container.common.spi.util;
import org.jvnet.hk2.annotations.Contract;
import com.sun.enterprise.deployment.JndiNameEnvironment;
/**
* InjectionManager provides runtime resource injection (@Resource, @EJB, etc.) and generic
* callback (PostConstruct/PreDestroy) services.
*
*
* It performs the actual injection into the fields and methods of designated Java EE 5+ component
* instances and managed class instances. The decision as to when injection takes place is
* determined by the caller.
*
*
* @author Kenneth Saks
*/
@Contract
public interface InjectionManager {
/**
* Inject the given object instance with the resources from its component environment. The applicable component naming
* environment information will be retrieved from the current invocation context.
*
* Any @PostConstruct methods on the instance's class(and super-classes) will be invoked after injection.
*
* @exception InjectionException
* Thrown if an error occurs during injection
*
*/
void injectInstance(Object instance) throws InjectionException;
/**
* Inject the given object instance with the resources from its component environment. The applicable component naming
* environment information will be retrieved from the current invocation context.
*
* If invokePostConstruct is true, any @PostConstruct methods on the instance's class(and super-classes) will be invoked
* after injection.
*
* @exception InjectionException
* Thrown if an error occurs during injection
*
*/
void injectInstance(Object instance, boolean invokePostConstruct) throws InjectionException;
/**
* Inject the injectable resources from the given component environment into an object instance. The specified
* componentEnv must match the environment that is associated with the component on top of the invocation stack at the
* time this method is invoked.
*
* Any @PostConstruct methods on the instance's class(and super-classes) will be invoked after injection.
*
*
* @exception InjectionException
* Thrown if an error occurs during injection
*
*/
void injectInstance(Object instance, JndiNameEnvironment componentEnv) throws InjectionException;
/**
* Inject the injectable resources from the given component environment into an object instance. The specified
* componentEnv must match the environment that is associated with the component on top of the invocation stack at the
* time this method is invoked.
*
* @param invokePostConstruct
* if true, invoke any @PostConstruct methods on the instance's class(and super-classes) after injection.
*
* @exception InjectionException
* Thrown if an error occurs during injection
*
*/
void injectInstance(Object instance, JndiNameEnvironment componentEnv, boolean invokePostConstruct) throws InjectionException;
/**
* Inject the injectable resources for the given component id into an object instance.
*
* @param invokePostConstruct
* if true, invoke any @PostConstruct methods on the instance's class(and super-classes) after injection.
*
* @exception InjectionException
* Thrown if an error occurs during injection
*
*/
void injectInstance(Object instance, String componentId, boolean invokePostConstruct) throws InjectionException;
/**
* Inject the injectable resources from the given component id into a Class instance. Only class-level(static)
* fields/methods are supported. E.g., this injection operation would be used for the Application Client Container main
* class.
*
* @param invokePostConstruct
* if true, invoke any @PostConstruct methods on the class(and super-classes) after injection.
* @exception InjectionException
* Thrown if an error occurs during injection
*
*/
void injectClass(Class clazz, String componentId, boolean invokePostConstruct) throws InjectionException;
/**
* Inject the injectable resources from the given component environment into a Class instance. Only class-level(static)
* fields/methods are supported. E.g., this injection operation would be used for the Application Client Container main
* class.
*
* Any @PostConstruct methods on the class(and super-classes) will be invoked after injection.
*
* @exception InjectionException
* Thrown if an error occurs during injection
*/
void injectClass(Class clazz, JndiNameEnvironment componentEnv) throws InjectionException;
/**
* Inject the injectable resources from the given component environment into a Class instance. Only class-level(static)
* fields/methods are supported. E.g., this injection operation would be used for the Application Client Container main
* class.
*
* @param invokePostConstruct
* if true, invoke any @PostConstruct methods on the class(and super-classes) after injection.
*
* @exception InjectionException
* Thrown if an error occurs during injection
*/
void injectClass(Class clazz, JndiNameEnvironment componentEnv, boolean invokePostConstruct) throws InjectionException;
/**
*
* Invoke any @PreDestroy methods defined on the instance's class (and super-classes). Invocation information will be
* retrieved from the current component invocation context.
*
* @exception InjectionException
* Thrown if an error occurs
*
*/
void invokeInstancePreDestroy(Object instance) throws InjectionException;
/**
*
* Invoke any @PreDestroy methods defined on the instance's class (and super-classes). Invocation information will be
* retrieved from the current component invocation context.
*
* @param validate
* if false, do nothing if the instance is not registered
*
* @exception InjectionException
* Thrown if an error occurs
*
*/
void invokeInstancePreDestroy(Object instance, boolean validate) throws InjectionException;
/**
*
* Invoke any @PreDestroy methods defined on the instance's class (and super-classes). The specified componentEnv must
* match the environment that is associated with the component on top of the invocation stack at the time this method is
* invoked.
*
* @exception InjectionException
* Thrown if an error occurs
*
*/
void invokeInstancePreDestroy(Object instance, JndiNameEnvironment componentEnv) throws InjectionException;
/**
*
* Invoke any @PostConstruct methods defined on the instance's class (and super-classes). The specified componentEnv
* must match the environment that is associated with the component on top of the invocation stack at the time this
* method is invoked.
*
* @exception InjectionException
* Thrown if an error occurs
*
*/
void invokeInstancePostConstruct(Object instance, JndiNameEnvironment componentEnv) throws InjectionException;
/**
*
* Invoke any static @PreDestroy methods defined on the class (and super-classes). The specified componentEnv must match
* the environment that is associated with the component on top of the invocation stack at the time this method is
* invoked.
*
* @exception InjectionException
* Thrown if an error occurs
*
*/
void invokeClassPreDestroy(Class clazz, JndiNameEnvironment componentEnv) throws InjectionException;
/**
* Create a managed object for the given class. The object will be injected and any PostConstruct methods will be
* called. The returned object can be cast to the clazz type but is not necessarily a direct reference to the managed
* instance. All invocations on the returned object should be on its public methods.
*
* It is the responsibility of the caller to destroy the returned object by calling destroyManagedObject(Object
* managedObject).
*
* @param clazz
* Class to be instantiated
* @return managed object
* @throws InjectionException
*/
T createManagedObject(Class clazz) throws InjectionException;
/**
* Create a managed object for the given class. The object will be injected and if invokePostConstruct is true,
* any @PostConstruct methods on the instance's class(and super-classes) will be invoked after injection. The returned
* object can be cast to the clazz type but is not necessarily a direct reference to the managed instance. All
* invocations on the returned object should be on its public methods.
*
* It is the responsibility of the caller to destroy the returned object by calling destroyManagedObject(Object
* managedObject).
*
* @param clazz
* Class to be instantiated
* @param invokePostConstruct
* if true, invoke any @PostConstruct methods on the instance's class(and super-classes) after injection.
* @return managed object
* @throws InjectionException
*/
T createManagedObject(Class clazz, boolean invokePostConstruct) throws InjectionException;
/**
* Destroy a managed object that was created via createManagedObject. Any PreDestroy methods will be called.
*
* @param managedObject
* @throws InjectionException
*/
void destroyManagedObject(Object managedObject) throws InjectionException;
/**
* Destroy a managed object that may have been created via createManagedObject. Any PreDestroy methods will be called.
*
* @param managedObject
* @param validate
* if false the object might not been created by createManagedObject() call
* @throws InjectionException
*/
void destroyManagedObject(Object managedObject, boolean validate) throws InjectionException;
/**
* Perform injection.
*
* @param clazz
* The class of the instance to perform injection. This is needed b/c of static injection.
* @param instance
* The instance on which to perform injection.
* @param envDescriptor
* The descriptor containing the injection information.
* @param componentId
* The id of the component in whose jndi environment injection actually occurs. Null indicates the current
* jndi environment.
* @param invokePostConstruct
* if true, invoke any @PostConstruct methods
* @throws InjectionException
*/
void inject(final Class clazz, final Object instance, JndiNameEnvironment envDescriptor, String componentId, boolean invokePostConstruct) throws InjectionException;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy