org.jboss.weld.manager.api.WeldManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weld-servlet Show documentation
There is a newer version: 3.0.0.Alpha1
/*
 * 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.manager.api;

import java.io.Serializable;
import java.lang.annotation.Annotation;

import javax.enterprise.context.ContextNotActiveException;
import javax.enterprise.context.spi.Contextual;
import javax.enterprise.inject.Instance;
import javax.enterprise.inject.spi.AnnotatedType;
import javax.enterprise.inject.spi.Bean;
import javax.enterprise.inject.spi.BeanManager;
import javax.enterprise.inject.spi.InjectionTarget;

import org.jboss.weld.bootstrap.api.ServiceRegistry;
import org.jboss.weld.construction.api.WeldCreationalContext;
import org.jboss.weld.ejb.spi.EjbDescriptor;
import org.jboss.weld.serialization.spi.BeanIdentifier;

/**
 * Functionality provided by the Weld Manager over and above the JSR-299 Manager.
 *
 * @author Pete Muir
 *
 */
public interface WeldManager extends BeanManager, Serializable {

    /**
     * Create a new child activity. A child activity inherits all beans, interceptors, decorators, observers, and contexts
     * defined by its direct and indirect parent activities.
     *
     * This method should not be called by the application.
     *
     * @return the child activity
     */
    WeldManager createActivity();

    /**
     * Associate an activity with the current context for a normal scope
     *
     * @param scopeType the scope to associate the activity with
     * @return the activity
     * @throws ContextNotActiveException if the given scope is inactive
     * @throws IllegalArgumentException if the given scope is not a normal scope
     */
    WeldManager setCurrent(Class scopeType);

    /**
     * The injection target for the given EJB, or null if Weld was not given this descriptor in the deployment.
     *
     * This should only be used to create an inject contextual EJBs by the EJB container. {@link #fireProcessInjectionTarget()}
     * must be used to obtain an {@link InjectionTarget} for non-contextual EJB injection.
     *
     * @param 
     * @param descriptor
     * @return
     */
     InjectionTarget createInjectionTarget(EjbDescriptor descriptor);

    /**
     * Get the Bean object for the given EJB, or null if Weld was not given this descriptor in the deployment.
     *
     * @param 
     * @param descriptor
     * @return
     */
     Bean getBean(EjbDescriptor descriptor);

    /**
     * Get the EjbDescriptor for the given ejb name
     *
     * @param 
     * @param ejbName
     * @return
     */
     EjbDescriptor getEjbDescriptor(String ejbName);

    /**
     * Get the services registered for this manager
     *
     * @return
     */
    ServiceRegistry getServices();

    /**
     *
     * @return the {@link WeldManager} that corresponds to the current activity
     */
    WeldManager getCurrent();

    /**
     * Fire a ProcessInjectionTarget event for the given type.
     *
     * A helper method to allow integration code to easily fire the ProcessInjectionTarget for Java EE component classes
     * supporting injection
     *
     * The container must use the returned InjectionTarget to inject the Java EE component.
     *
     * @param 
     * @param type
     * @return
     */
     InjectionTarget fireProcessInjectionTarget(AnnotatedType type);

    /**
     * Fire a ProcessInjectionTarget event for the given type.
     *
     * A helper method to allow integration code to easily fire the ProcessInjectionTarget for Java EE component classes
     * supporting injection
     *
     * The container must use the returned InjectionTarget to inject the Java EE component.
     *
     * @param 
     * @param type
     * @param injectionTarget
     * @return
     */
     InjectionTarget fireProcessInjectionTarget(AnnotatedType annotatedType, InjectionTarget injectionTarget);

    /**
     * The ID of the manager, identical to the ID provided by the BDA
     *
     * @return
     */
    String getId();

    Instance