org.gatein.api.cdi.context.PortletLifecycleScoped Maven / Gradle / Ivy

Go to download

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

There is a newer version: 1.1.0.Final

package org.gatein.api.cdi.context;

import javax.enterprise.context.NormalScope;
import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

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;

/**
 * Specifies that a bean is portlet lifecycle scoped.
 *
 * The portlet lifecycle scope is active during:
 *
 * 
 * the Portlet.processAction() method,
 * the EventPortlet.processEvent() method,
 * the Portlet.render() method or
 * the ResourceServingPortlet.serveResource() method
 * 
 *
 * of any portlet request.
 *
 * The portlet lifecycle scope is also active during:
 *
 * 
 * the ActionFilter.doFilter() method,
 * the EventFilter.doFilter() method,
 * the RenderFilter.doFilter() method, and
 * the ResourceFilter.doFilter() method.
 * 
 *
 * of any portlet filter.
 *
 * The portlet lifecycle scope is destroyed at the end of the portlet request, after any:
 *
 * 
 * Portlet.processAction() method,
 * EventPortlet.processEvent() method,
 * Portlet.render() method or
 * ResourceServingPortlet.serveResource() method.
 * 
 *
 * and after all:
 *
 * 
 * ActionFilter.doFilter() methods,
 * EventFilter.doFilter() methods,
 * RenderFilter.doFilter() methods, and
 * ResourceFilter.doFilter() methods.
 * 
 *
 * There are two method call sequences in which the portlet lifecycle scope is active:
 *
 * 
 * during ActionRequest -> EventRequest -> RenderRequest,
 * along with their associated doFilter() methods, and
 * during ResourceRequest, along with its associated doFilter() method.
 * 
 *
 * @author Ken Finnigan
 */

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