Top Description Methods
javax.portlet.annotations

public @Interface PortletSessionScoped

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE
@NormalScope
passivating:true
@Inherited
@Documented
Imports
java.lang.annotation.Documented, .Inherited, .Retention, .Target, javax.enterprise.context.NormalScope, javax.portlet.PortletSession
Provides a CDI custom scope that is scoped to the portlet session rather than to the servlet session.

Note that a portlet session scoped bean must implement java.io.Serializable, since it will be stored in the portlet session.

Since
3.0

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The portlet scope
value()

The portlet scope into which the annotated bean is to be placed.
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public int value()

The portlet scope into which the annotated bean is to be placed. Can be set to the following values:
  • PortletSession.PORTLET_SCOPE - scopes the bean to the portlet session
  • PortletSession.APPLICATION_SCOPE - Scopes the bean to the portlet application session. The effect of this scope is the same as using the CDI @SessionScoped annotation.
Returns:int

The portlet scope

See Also
PortletSession#PORTLET_SCOPE, PortletSession#APPLICATION_SCOPE