public interface SystemEventListener extends FacesListener
By implementing this class, an object
indicates that it is a listener for one or more kinds of SystemEvent
s. The exact type of event that will cause the
implementing class's processEvent(javax.faces.event.SystemEvent)
method to be called is
indicated by the facesEventClass
argument passed when
the listener is installed using Application.subscribeToEvent(java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Class<?>, javax.faces.event.SystemEventListener)
.
Modifier and Type | Method and Description |
---|---|
boolean |
isListenerForSource(Object source)
This method must return
true if and only if this
listener instance is interested in receiving events from the
instance referenced by the source parameter. |
void |
processEvent(SystemEvent event)
When called, the listener can assume that any guarantees given
in the javadoc for the specific
SystemEvent
subclass are true. |
void processEvent(SystemEvent event) throws AbortProcessingException
When called, the listener can assume that any guarantees given
in the javadoc for the specific SystemEvent
subclass are true.
event
- the SystemEvent
instance that
is being processed.AbortProcessingException
- if lifecycle processing should
cease for this request.boolean isListenerForSource(Object source)
This method must return true
if and only if this
listener instance is interested in receiving events from the
instance referenced by the source
parameter.
source
- the source that is inquiring about the
appropriateness of sending an event to this listener instance.Copyright © 2017 JBoss by Red Hat. All rights reserved.