public class ExceptionQueuedEventContext extends Object implements SystemEventListenerHolder
This helper class provides context to
the ExceptionQueuedEvent
regarding the state of the system at the
point in time when the ExceptionQueuedEvent
occurs and links
the ExceptionQueuedEvent
to the ExceptionHandler
by virtue of implementing
SystemEventListener
.
Modifier and Type | Field and Description |
---|---|
static String |
IN_AFTER_PHASE_KEY
The presence of an entry under this
key in the |
static String |
IN_BEFORE_PHASE_KEY
The presence of an entry under this
key in the |
Constructor and Description |
---|
ExceptionQueuedEventContext(FacesContext context,
Throwable thrown)
Instantiate a new
|
ExceptionQueuedEventContext(FacesContext context,
Throwable thrown,
UIComponent component)
Instantiate a new
|
ExceptionQueuedEventContext(FacesContext context,
Throwable thrown,
UIComponent component,
PhaseId phaseId)
Instantiate a new
|
Modifier and Type | Method and Description |
---|---|
Map<Object,Object> |
getAttributes()
A |
UIComponent |
getComponent()
Return the |
FacesContext |
getContext()
|
Throwable |
getException()
Return the |
List<SystemEventListener> |
getListenersForEventClass(Class<? extends SystemEvent> facesEventClass)
Return a |
PhaseId |
getPhaseId()
Return the |
boolean |
inAfterPhase() |
boolean |
inBeforePhase() |
public static final String IN_BEFORE_PHASE_KEY
The presence of an entry under this
key in the Map
returned from getAttributes()
indicates the event occurred during the “before
phase” part of the current lifecycle phase.
public static final String IN_AFTER_PHASE_KEY
The presence of an entry under this
key in the Map
returned from getAttributes()
indicates the event occurred during the “after
phase” part of the current lifecycle phase.
public ExceptionQueuedEventContext(FacesContext context, Throwable thrown)
Instantiate a new
ExceptionQueuedEventContext
that indicates the argument
Throwable
just occurred.
context
- FacesContext
for the current requestthrown
- the Throwable
that is the context for
this ExceptionQueuedEventContext
instance.public ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component)
Instantiate a new
ExceptionQueuedEventContext
that indicates the argument
Throwable
just occurred, relevant to the argument
component
.
context
- FacesContext
for the current requestthrown
- the Throwable
that is the context for
this ExceptionQueuedEventContext
instance.component
- the UIComponent
instance to which this
ExceptionQueuedEventContext
pertainspublic ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component, PhaseId phaseId)
Instantiate a new
ExceptionQueuedEventContext
that indicates the argument
Throwable
just occurred, relevant to the argument
component
, during the lifecycle phase
phaseId
.
context
- FacesContext
for the current requestthrown
- the Throwable
that is the context for
this ExceptionQueuedEventContext
instance.component
- the UIComponent
that is relevant to
the context.phaseId
- the PhaseId
at the time this
ExeceptionEventContext
is created.public FacesContext getContext()
FacesContext
used to create this
ExceptionQueuedEventContext
instance.public Throwable getException()
Return the exception
property.
public UIComponent getComponent()
Return the UIComponent
which was being processed when the exception was thrown. If none
or not available, this will be null
.
public PhaseId getPhaseId()
Return the PhaseId
which was being processed when the exception was thrown. If none
or not available, this will be null
.
public boolean inBeforePhase()
true
if the exception occurred during the
before phase
processing for a particular lifecycle
phasepublic boolean inAfterPhase()
true
if the exception occurred during the
after phase
processing for a particular lifecycle
phasepublic Map<Object,Object> getAttributes()
A Map
of attributes
relevant to the context of this ExceptionQueuedEvent
.
public List<SystemEventListener> getListenersForEventClass(Class<? extends SystemEvent> facesEventClass)
Return a List
that
contains a single entry, the ExceptionHandler
for the current
request.
getListenersForEventClass
in interface SystemEventListenerHolder
Copyright © 2018 JBoss by Red Hat. All rights reserved.