Annotation Interface ViewScoped
When this annotation, along with ManagedBean is found on a class,
the runtime must act as if a <managed-bean-scope>view<managed-bean-scope> element was
declared for the corresponding managed bean.
If ProjectStage is not ProjectStage.Production, verify that the current
UIViewRoot does not have its transient property set to true. If so, add a FacesMessage
for the current viewId to the FacesContext stating @ViewScoped beans cannot work if the
view is marked as transient. Also log a Level.WARNING message to the log. If ProjectStage
is ProjectStage.Production, do not do this verification.
The bean must be stored in the map returned from jakarta.faces.component.UIViewRoot.getViewMap(boolean).
The runtime must ensure that any methods on the bean annotated with PostConstruct or PreDestroy are
called when the scope begins and ends, respectively. Two circumstances can cause the scope to end.
-
FacesContext.setViewRoot()is called with the newUIViewRootbeing different than the current one. -
The session, that happened to be active when the bean was created, expires. If no session existed when the bean was created, then this circumstance does not apply.
In the session expiration case, the runtime must ensure that FacesContext.getCurrentInstance() returns a
valid instance if it is called during the processing of the @PreDestroy annotated method. The set of methods
on FacesContext that are valid to call in this circumstance is identical to those documented as "valid to
call this method during application startup or shutdown". On the ExternalContext returned from that
FacesContext, all of the methods documented as "valid to call this method during application startup or
shutdown" are valid to call. In addition, the method
ExternalContext.getSessionMap() is also valid to call.
- Since:
- 2.0
jakarta.faces.view.ViewScoped. The functionality of this corresponding annotation is identical to this one, but it is implemented as a CDI custom scope.