javax.portlet.annotations

Annotation Type PortletSessionScoped

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @NormalScope(passivating=true)
 @Inherited
 @Documented
public @interface PortletSessionScoped

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	value The portlet scope into which the annotated bean is to be placed.

Element Detail

value

public abstract 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:

The portlet scope

See Also:

PortletSession.PORTLET_SCOPE, PortletSession.APPLICATION_SCOPE

Default:

2