|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.barracuda.core.event.DefaultEventContext
The context contains information about the event (event, queue, plus request and response info if appropriate). The context also implements StateMap, so you can use it to pass information between event handlers. The scope of the context is only for the duration of an event dispatch cycle (ie. from Http Request to Http Response)
Note that because DefaultEventContext implements ViewEventContext it can safely be cast to its two parent interfaces: EventContext and ControlEventContext. This is in fact what the DefaultEventDispatcher actually does to control access to the appropriate information (ie. a ControlEvent handler should get a reference to an ControlEventContext, NOT an ViewEventContext, since the control handlers shouldn't have access to the HttpServletResponse object.)
Field Summary | |
protected static org.apache.log4j.Logger |
logger
|
Fields inherited from interface org.enhydra.barracuda.core.event.ViewEventContext |
HTTP_SERVLET_RESPONSE |
Fields inherited from interface org.enhydra.barracuda.core.event.ControlEventContext |
HTTP_SERVLET_REQUEST, SERVLET_CONFIG |
Fields inherited from interface org.enhydra.barracuda.core.event.EventContext |
BASE_EVENT, DISPATCH_QUEUE, VIEW_CAPABILITIES |
Constructor Summary | |
DefaultEventContext(DispatchQueue queue,
ViewCapabilities vc,
javax.servlet.ServletConfig config,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
HttpResponseEvent defaultResponseEvent)
Public constructor. |
Method Summary | |
javax.servlet.ServletConfig |
getConfig()
Get the associated ServletConfig structure |
BaseEvent |
getEvent()
Get the underlying BaseEvent |
DispatchQueue |
getQueue()
Get the underlying DispatchQueue |
javax.servlet.http.HttpServletRequest |
getRequest()
Get the associated HttpServletRequest |
javax.servlet.http.HttpServletResponse |
getResponse()
Get the associated HttpServletResponse |
java.lang.Object |
getState(java.lang.Object key)
get a property in this StateMap |
java.util.List |
getStateKeys()
get a list of the keys for this StateMap |
java.util.Map |
getStateValues()
get a copy of the underlying Map |
ViewCapabilities |
getViewCapabilities()
Get the underlying ViewCapabilities |
void |
persistContext()
The event context must be able to persist its state in the user's session |
void |
putState(java.lang.Object key,
java.lang.Object val)
set a property in this StateMap |
java.lang.Object |
removeState(java.lang.Object key)
remove a property in this StateMap |
void |
restoreContext(javax.servlet.http.HttpServletRequest req)
The event context must also be able to restore state from the user's session. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static org.apache.log4j.Logger logger
Constructor Detail |
public DefaultEventContext(DispatchQueue queue, ViewCapabilities vc, javax.servlet.ServletConfig config, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, HttpResponseEvent defaultResponseEvent)
queue
- the event dispatch queueconfig
- the servlet config structurereq
- the HttpServletRequestresp
- the HttpServlet ResponsedefaultResponseEvent
- the default response event to be used
if none is generated by the control event handlersMethod Detail |
public BaseEvent getEvent()
getEvent
in interface EventContext
public DispatchQueue getQueue()
getQueue
in interface EventContext
public ViewCapabilities getViewCapabilities()
getViewCapabilities
in interface EventContext
public javax.servlet.ServletConfig getConfig()
getConfig
in interface ControlEventContext
public javax.servlet.http.HttpServletRequest getRequest()
getRequest
in interface ControlEventContext
public javax.servlet.http.HttpServletResponse getResponse()
getResponse
in interface ViewEventContext
public void persistContext()
persistContext
in interface EventContext
public void restoreContext(javax.servlet.http.HttpServletRequest req)
public void putState(java.lang.Object key, java.lang.Object val)
putState
in interface StateMap
key
- the state key objectval
- the state value objectpublic java.lang.Object getState(java.lang.Object key)
getState
in interface StateMap
key
- the state key object
public java.lang.Object removeState(java.lang.Object key)
removeState
in interface StateMap
key
- the key object
public java.util.List getStateKeys()
getStateKeys
in interface StateMap
public java.util.Map getStateValues()
getStateValues
in interface StateMap
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |