javax.enterprise.context.RequestScoped Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdi-api Show documentation

APIs for CDI (Contexts and Dependency Injection for Java EE)

There is a newer version: 2.0.SP1

/*
 * 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 javax.enterprise.context;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * 
 * Specifies that a bean is request scoped.
 * 
 * 
 * 
 * The request scope is active:
 * 
 * 
 * 
 * during the service() method of any servlet in the web application, during the doFilter() method of any
 * servlet filter and when the container calls any ServletRequestListener or AsyncListener,
 * during any Java EE web service invocation,
 * during any remote method invocation of any EJB, during any asynchronous method invocation of any EJB, during any call to
 * an EJB timeout method and during message delivery to any EJB message-driven bean, and
 * during any message delivery to a MessageListener for a JMS topic or queue obtained from the Java EE component
 * environment.
 * 
 * 
 * 
 * The request context is destroyed:
 * 
 * 
 * 
 * at the end of the servlet request, after the service() method, all doFilter() methods, and all
 * requestDestroyed() and onComplete() notifications return,
 * after the web service invocation completes,
 * after the EJB remote method invocation, asynchronous method invocation, timeout or message delivery completes, or
 * after the message delivery to the MessageListener completes.
 * 
 * 
 * @author Gavin King
 * @author Pete Muir
 */

@Target({ TYPE, METHOD, FIELD })
@Retention(RUNTIME)
@Documented
@NormalScope
@Inherited
public @interface RequestScoped {
}