org.jboss.weld.injection.spi.InjectionServices Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weld-servlet-shaded Show documentation
This jar bundles all the bits of Weld and CDI required for running in a Servlet container.
There is a newer version: 6.0.0.Beta4
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2010, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * Licensed 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.jboss.weld.injection.spi;

import javax.enterprise.inject.spi.AnnotatedType;
import javax.enterprise.inject.spi.DefinitionException;
import javax.enterprise.inject.spi.InjectionTarget;
import javax.enterprise.inject.spi.InjectionTargetFactory;

import org.jboss.weld.bootstrap.api.Service;

/**
 * Provides callbacks to the container when Weld performs injection on an InjectionTarget, managed bean or session bean
 *
 * This service may be used to provide EE-style injection.
 *
 * The container must respect any modifications made to type via the container lifecycle events. Container lifecycle
 * events may alter the annotations placed on the type, it's members, and the formal parameters of it's members.
 * {@link InjectionContext#getAnnotatedType()} gives access to the modified state of the type.
 *
 * {@link InjectionServices} is a per-BeanDeploymentArchive service.
 *
 * @author Pete Muir
 * @author Jozef Hartinger
 *
 */
public interface InjectionServices extends Service {

    /**
     * Callback for injection.
     *
     * Call {@link InjectionContext#proceed()} to cause CDI-style injection to occur.
     *
     * @param  the type of the injected instance
     * @param injectionContext the context in which injection occurs
     */
     void aroundInject(InjectionContext injectionContext);

    /**
     * 
     * This method is invoked during Weld bootstrap and allows an integrator to process an {@link InjectionTarget} that may be
     * injected at runtime. The implementation may want to read the metadata on resource injection point and cache it so that it
     * does not need to repeat metadata parsing on each {@link #aroundInject(InjectionContext)} invocation.
     * 
     *
     * 
     * Furthermore, the integrator is responsible for validating resource injection points (as defined in CDI 1.1 3.7.1).
     * 
     *
     * 
     * For each resource injection of a type:
     * 
     *
     * 
     * @Resource
     * @PersistenceContext
     * @PersistenceUnit
     * @EJB injection
     * @WebServiceRef
     * 
     *
     * 
     * the implementation must validate the type of the injection point. If the injection point type differs from the type of
     * the matching object in the Java EE component environment, the implementation throws {@link DefinitionException}.
     * 
     *
     * 
     * Note that this method may be called at runtime if the application uses an {@link InjectionTargetFactory} to create
     * injection target instances at runtime.
     * 
     *
     * @param  the type of the injected instance
     * @param injectionTarget the injection target to be processed
     * @param annotatedType the {@link AnnotatedType} metadata for the given injection target
     */
     void registerInjectionTarget(InjectionTarget injectionTarget, AnnotatedType annotatedType);

}