|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tapestry.engine.RequestCycle
Provides the logic for processing a single request cycle. Provides access to the
engine
and the RequestContext
.
Constructor Summary | |
RequestCycle()
Alternate constructor used only for testing purposes . |
|
RequestCycle(IEngine engine,
RequestContext requestContext,
QueryParameterMap parameters,
IEngineService service,
Infrastructure infrastructure,
PropertyPersistenceStrategySource strategySource,
org.apache.hivemind.ErrorHandler errorHandler,
IMonitor monitor)
Standard constructor used to render a response page. |
Method Summary | |
void |
activate(IPage page)
Sets the active page for the request. |
void |
activate(java.lang.String name)
A convienience for invoking activate(IPage) . |
void |
cleanup()
Called at the end of the request cycle (i.e., after all responses have been sent back to the client), to release all pages loaded during the request cycle. |
void |
commitPageChanges()
Invokes IPageRecorder.commit() on each page recorder loaded during the request cycle
(even recorders marked for discard). |
void |
discardPage(java.lang.String name)
As of 3.1, just a synonym for forgetPage(String) . |
java.lang.String |
encodeURL(java.lang.String URL)
Passes the String through HttpServletResponse.encodeURL(java.lang.String) , which ensures
that the session id is encoded in the URL (if necessary). |
void |
forgetPage(java.lang.String pageName)
Forgets any stored changes to the specified page. |
java.lang.String |
getAbsoluteURL(java.lang.String partialURL)
Converts a partial URL into an absoluate URL. |
java.lang.Object |
getAttribute(java.lang.String name)
Retrieves a previously stored attribute, returning null if not found. |
IEngine |
getEngine()
Returns the engine which is processing this request cycle. |
Infrastructure |
getInfrastructure()
Returns the central Infrastructure object
used to manage the processing of the request. |
IMonitor |
getMonitor()
|
java.lang.String |
getNextActionId()
Returns the next action id. |
IPage |
getPage()
Identifies the active page, the page which will ultimately render the response. |
IPage |
getPage(java.lang.String name)
Gets the page from the engines's IPageSource . |
protected IPageRecorder |
getPageRecorder(java.lang.String name)
Returns the page recorder for the named page. |
java.lang.String |
getParameter(java.lang.String name)
Returns a query parameter value, or null if not provided in the request. |
java.lang.String[] |
getParameters(java.lang.String name)
Returns all query parameter values for the given name. |
RequestContext |
getRequestContext()
|
IEngineService |
getService()
Returns the service which initiated this request cycle. |
java.lang.Object[] |
getServiceParameters()
Returns parameters previously stored by setServiceParameters(Object[]) . |
boolean |
isRewinding()
Returns true if the context is being used to rewind a prior state of the page. |
boolean |
isRewound(IComponent component)
Checks to see if the current action id matches the target action id. |
void |
removeAttribute(java.lang.String name)
Removes a previously stored attribute, if one with the given name exists. |
void |
renderPage(IMarkupWriter writer)
Renders the page by invoking IPage.renderPage(IMarkupWriter, IRequestCycle) . |
void |
rewindForm(IForm form,
java.lang.String targetActionId)
Rewinds an individual form by invoking IForm.rewind(IMarkupWriter, IRequestCycle) . |
void |
rewindPage(java.lang.String targetActionId,
IComponent targetComponent)
Rewinds the page by invoking IPage.renderPage(IMarkupWriter, IRequestCycle) . |
void |
setAttribute(java.lang.String name,
java.lang.Object value)
Allows a temporary object to be stored in the request cycle, which allows otherwise unrelated objects to communicate. |
void |
setPage(IPage value)
Sets the page to be rendered. |
void |
setPage(java.lang.String name)
Sets the page to be rendered. |
void |
setServiceParameters(java.lang.Object[] serviceParameters)
Invoked by a service to store an array of application-specific
parameters. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public RequestCycle(IEngine engine, RequestContext requestContext, QueryParameterMap parameters, IEngineService service, Infrastructure infrastructure, PropertyPersistenceStrategySource strategySource, org.apache.hivemind.ErrorHandler errorHandler, IMonitor monitor)
public RequestCycle()
Method Detail |
public void cleanup()
cleanup
in interface IRequestCycle
public IEngineService getService()
IRequestCycle
getService
in interface IRequestCycle
public java.lang.String encodeURL(java.lang.String URL)
IRequestCycle
HttpServletResponse.encodeURL(java.lang.String)
, which ensures
that the session id is encoded in the URL (if necessary).
encodeURL
in interface IRequestCycle
public IEngine getEngine()
IRequestCycle
getEngine
in interface IRequestCycle
public java.lang.Object getAttribute(java.lang.String name)
IRequestCycle
getAttribute
in interface IRequestCycle
public IMonitor getMonitor()
getMonitor
in interface IRequestCycle
public java.lang.String getNextActionId()
IRequestCycle
getNextActionId
in interface IRequestCycle
public IPage getPage()
IRequestCycle
getPage
in interface IRequestCycle
public IPage getPage(java.lang.String name)
IPageSource
.
getPage
in interface IRequestCycle
protected IPageRecorder getPageRecorder(java.lang.String name)
public RequestContext getRequestContext()
getRequestContext
in interface IRequestCycle
public boolean isRewinding()
IRequestCycle
isRewinding
in interface IRequestCycle
public boolean isRewound(IComponent component) throws StaleLinkException
IRequestCycle
If theres a match on action id, then the component is compared against the target component.
If there's a mismatch then a StaleLinkException
is thrown.
isRewound
in interface IRequestCycle
StaleLinkException
public void removeAttribute(java.lang.String name)
IRequestCycle
removeAttribute
in interface IRequestCycle
public void renderPage(IMarkupWriter writer)
IPage.renderPage(IMarkupWriter, IRequestCycle)
. This
clears all attributes.
renderPage
in interface IRequestCycle
public void rewindForm(IForm form, java.lang.String targetActionId)
IForm.rewind(IMarkupWriter, IRequestCycle)
.
The process is expected to end with a RenderRewoundException
. If the entire page is
renderred without this exception being thrown, it means that the target action id was not
valid, and a ApplicationRuntimeException
is thrown.
This clears all attributes.
rewindForm
in interface IRequestCycle
public void rewindPage(java.lang.String targetActionId, IComponent targetComponent)
IPage.renderPage(IMarkupWriter, IRequestCycle)
.
The process is expected to end with a RenderRewoundException
. If the entire page is
renderred without this exception being thrown, it means that the target action id was not
valid, and a ApplicationRuntimeException
is thrown.
This clears all attributes.
rewindPage
in interface IRequestCycle
IAction
public void setAttribute(java.lang.String name, java.lang.Object value)
IRequestCycle
HttpServletRequest.setAttribute()
,
except that values can be changed and removed as well.
This is used by components to locate each other. A component, such as
Body
, will write itself under a well-known name into the
request cycle, and components it wraps can locate it by that name.
setAttribute
in interface IRequestCycle
public void setPage(IPage value)
IRequestCycle
setPage
in interface IRequestCycle
public void setPage(java.lang.String name)
IRequestCycle
setPage
in interface IRequestCycle
public void commitPageChanges()
IPageRecorder.commit()
on each page recorder loaded during the request cycle
(even recorders marked for discard).
commitPageChanges
in interface IRequestCycle
IPageRecorder.commit()
public void discardPage(java.lang.String name)
forgetPage(String)
.
discardPage
in interface IRequestCycle
public java.lang.Object[] getServiceParameters()
IRequestCycle
IRequestCycle.setServiceParameters(Object[])
.
Through release 2.1, the return type was String[]. This is an incompatible change in 2.2.
getServiceParameters
in interface IRequestCycle
public void setServiceParameters(java.lang.Object[] serviceParameters)
IRequestCycle
service
to store an array of application-specific
parameters. These can later be retrieved (typically, by an application-specific listener
method) by invoking IRequestCycle.getServiceParameters()
.
Through release 2.1, parameters was of type String[]. This is an incompatible change in 2.2.
setServiceParameters
in interface IRequestCycle
DirectService
public void activate(java.lang.String name)
IRequestCycle
IRequestCycle.activate(IPage)
. Invokes IRequestCycle.getPage(String)
to
get an instance of the named page.
activate
in interface IRequestCycle
public void activate(IPage page)
IRequestCycle
service
.
Frequently, the active page is changed (from a listener method) to choose an alternate page
to render the response).
IPage.validate(IRequestCycle)
is invoked on the page to be activated.
PageRedirectException
is caught and the page specified in the exception will be the
active page instead (that is, a page may "pass the baton" to another page using the
exception). The new page is also validated. This continues until a page does not throw
PageRedirectException
.
Validation loops can occur, where page A redirects to page B and then page B redirects back
to page A (possibly with intermediate steps). This is detected and results in an
ApplicationRuntimeException
.
activate
in interface IRequestCycle
public java.lang.String getParameter(java.lang.String name)
IRequestCycle
getParameter
in interface IRequestCycle
public java.lang.String[] getParameters(java.lang.String name)
IRequestCycle
getParameters
in interface IRequestCycle
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getAbsoluteURL(java.lang.String partialURL)
IRequestCycle
getAbsoluteURL
in interface IRequestCycle
public void forgetPage(java.lang.String pageName)
IRequestCycle
forgetPage
in interface IRequestCycle
public Infrastructure getInfrastructure()
IRequestCycle
Infrastructure
object
used to manage the processing of the request.
getInfrastructure
in interface IRequestCycle
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |