| java.lang.Object
 org.apache.beehive.netui.pageflow.PageFlowEventReporter
All known Subclasses: org.apache.beehive.netui.pageflow.DefaultPageFlowEventReporter,
| PageFlowEventReporter | | abstract public class PageFlowEventReporter (Code) | | An event reporter, which will be notified of events like "page flow created", "action raised", etc.
|
| Method Summary | |
| abstract public void | actionRaised(RequestContext requestContext, FlowController flowController, ActionMapping actionMapping, ActionForm form)
Event fired when an action is raised on a FlowController (a page flow or a shared flow).
Parameters:
requestContext - the current request context.
Parameters:
flowController - the FlowController on which the action is being raised (aPageFlowController or a SharedFlowController).
Parameters:
actionMapping - the org.apache.struts.action.ActionMapping that represents the action beingraised. | | abstract public void | actionSuccess(RequestContext requestContext, FlowController flowController, ActionMapping actionMapping, ActionForm form, ActionForward result, long timeTakenMillis)
Event fired when an action successfully completes on a FlowController (a page flow or a shared flow).
Parameters:
requestContext - the current request context.
Parameters:
flowController - the FlowController on which the action was raised (aPageFlowController or a SharedFlowController).
Parameters:
actionMapping - the org.apache.struts.action.ActionMapping that represents the action that wasraised. | | abstract public void | beginActionRequest(RequestContext requestContext)
Event fired at the beginning of an action request. | | abstract public void | beginPageRequest(RequestContext requestContext)
Event fired at the end of an action request. | | abstract public void | endActionRequest(RequestContext requestContext, long timeTakenMillis)
Event fired at the end of an action request. | | abstract public void | endPageRequest(RequestContext requestContext, long timeTakenMillis)
Event fired at the end of a page request. | | abstract public void | exceptionHandled(RequestContext requestContext, Throwable ex, ActionMapping actionMapping, ActionForm form, FlowController flowController, ActionForward result, long timeTakenMillis)
Event fired when an exception is handled successfully during processing of an action request.
Parameters:
requestContext - the current request context.
Parameters:
ex - the Throwable that was raised.
Parameters:
actionMapping - the org.apache.struts.action.ActionMapping that represents the action that wasraised. | | abstract public void | exceptionRaised(RequestContext requestContext, Throwable ex, ActionMapping actionMapping, ActionForm form, FlowController flowController)
Event fired when an exception is raised during processing of an action request.
Parameters:
requestContext - the current request context.
Parameters:
ex - the Throwable that was raised.
Parameters:
actionMapping - the org.apache.struts.action.ActionMapping that represents the action that wasraised. | | abstract public void | flowControllerCreated(RequestContext requestContext, FlowController flowController)
Event fired when a FlowController (a page flow or a shared flow) is created. | | abstract public void | flowControllerDestroyed(FlowController flowController, Object storageLocation)
Event fired when a FlowController (a page flow or a shared flow) is "destroyed", i.e., removed from wherever it
is being stored.
Parameters:
flowController - the FlowController (a PageFlowController or a SharedFlowController)that is being destroyed.
Parameters:
storageLocation - The storage location. | | abstract public void | flowControllerRegistered(String modulePath, String controllerClassName, ModuleConfig moduleConfig)
Event fired when a page flow or shared flow is registered lazily (once per webapp deployment). | | protected ServletContext | getServletContext()
|
| actionRaised | | abstract public void actionRaised(RequestContext requestContext, FlowController flowController, ActionMapping actionMapping, ActionForm form)(Code) | | Event fired when an action is raised on a FlowController (a page flow or a shared flow).
Parameters:
requestContext - the current request context.
Parameters:
flowController - the FlowController on which the action is being raised (aPageFlowController or a SharedFlowController).
Parameters:
actionMapping - the org.apache.struts.action.ActionMapping that represents the action beingraised. The name of the action, prefixed by a '/', can be found by calling getPathon this object.
Parameters:
form - the form bean that was passed to the action, or null if there was none. |
| actionSuccess | | abstract public void actionSuccess(RequestContext requestContext, FlowController flowController, ActionMapping actionMapping, ActionForm form, ActionForward result, long timeTakenMillis)(Code) | | Event fired when an action successfully completes on a FlowController (a page flow or a shared flow).
Parameters:
requestContext - the current request context.
Parameters:
flowController - the FlowController on which the action was raised (aPageFlowController or a SharedFlowController).
Parameters:
actionMapping - the org.apache.struts.action.ActionMapping that represents the action that wasraised. The name of the action, prefixed by a '/', can be found by calling getPathon this object.
Parameters:
form - the form bean that was passed to the action, or null if there was none.
Parameters:
result - the ActionForward result returned from the action.
Parameters:
timeTakenMillis - the length of time in milliseconds for the action to be run. |
| beginActionRequest | | abstract public void beginActionRequest(RequestContext requestContext)(Code) | | Event fired at the beginning of an action request. Note that this is called on all action requests, even those
that do not successfully run actions.
Parameters:
requestContext - the current request context. |
| beginPageRequest | | abstract public void beginPageRequest(RequestContext requestContext)(Code) | | Event fired at the end of an action request. Note that this is called on all action requests, even those
that do not successfully run actions.
Parameters:
requestContext - the current request context. |
| endActionRequest | | abstract public void endActionRequest(RequestContext requestContext, long timeTakenMillis)(Code) | | Event fired at the end of an action request. Note that this is called on all action requests, even those
that do not successfully run actions.
Parameters:
requestContext - the current request context.
Parameters:
timeTakenMillis - the length of time in milliseconds for the action request to be processed. |
| endPageRequest | | abstract public void endPageRequest(RequestContext requestContext, long timeTakenMillis)(Code) | | Event fired at the end of a page request.
Parameters:
requestContext - the current request context.
Parameters:
timeTakenMillis - the length of time in milliseconds for the page request to be processed. |
| exceptionHandled | | abstract public void exceptionHandled(RequestContext requestContext, Throwable ex, ActionMapping actionMapping, ActionForm form, FlowController flowController, ActionForward result, long timeTakenMillis)(Code) | | Event fired when an exception is handled successfully during processing of an action request.
Parameters:
requestContext - the current request context.
Parameters:
ex - the Throwable that was raised.
Parameters:
actionMapping - the org.apache.struts.action.ActionMapping that represents the action that wasraised. The name of the action, prefixed by a '/', can be found by calling getPathon this object. This parameter will be null if the request did not get to the pointwhere an action was actuallly raised.
Parameters:
form - the form bean that was passed to the action, or null if there was none.
Parameters:
flowController - the FlowController associated with the action request. This parameter will benull if the request did not get to the point where a FlowController could be created orlooked up.
Parameters:
result - the ActionForward result returned from the exception handler.
Parameters:
timeTakenMillis - the length of time in milliseconds for the exception to be handled.
See Also: PageFlowEventReporter.beginActionRequest |
| exceptionRaised | | abstract public void exceptionRaised(RequestContext requestContext, Throwable ex, ActionMapping actionMapping, ActionForm form, FlowController flowController)(Code) | | Event fired when an exception is raised during processing of an action request.
Parameters:
requestContext - the current request context.
Parameters:
ex - the Throwable that was raised.
Parameters:
actionMapping - the org.apache.struts.action.ActionMapping that represents the action that wasraised. The name of the action, prefixed by a '/', can be found by calling getPathon this object. This parameter will be null if the request did not get to the pointwhere an action was actuallly raised.
Parameters:
form - the form bean that was passed to the action, or null if there was none.
Parameters:
flowController - the FlowController associated with the action request. This parameter will benull if the request did not get to the point where a FlowController could be created orlooked up.
See Also: PageFlowEventReporter.beginActionRequest |
| flowControllerCreated | | abstract public void flowControllerCreated(RequestContext requestContext, FlowController flowController)(Code) | | Event fired when a FlowController (a page flow or a shared flow) is created.
Parameters:
requestContext - the current request context.
Parameters:
flowController - the FlowController (a PageFlowController or a SharedFlowController)that was created. |
| flowControllerDestroyed | | abstract public void flowControllerDestroyed(FlowController flowController, Object storageLocation)(Code) | | Event fired when a FlowController (a page flow or a shared flow) is "destroyed", i.e., removed from wherever it
is being stored.
Parameters:
flowController - the FlowController (a PageFlowController or a SharedFlowController)that is being destroyed.
Parameters:
storageLocation - The storage location. For session-scoped FlowControllers, this is ajavax.servlet.http.HttpSession. |
| flowControllerRegistered | | abstract public void flowControllerRegistered(String modulePath, String controllerClassName, ModuleConfig moduleConfig)(Code) | | Event fired when a page flow or shared flow is registered lazily (once per webapp deployment).
Parameters:
modulePath - the module path, which is the "parent directory" for actions on the controller.
Parameters:
controllerClassName - the name of the controller class.
Parameters:
moduleConfig - the Struts ModuleConfig that corresponds to the controller. |
|
|