wicket.protocol.http.portlet
Class PortletRequestCycle

java.lang.Object
  wicket.RequestCycle
      wicket.protocol.http.portlet.PortletRequestCycle

Direct Known Subclasses:

PortletActionRequestCycle, PortletRenderRequestCycle

public abstract class PortletRequestCycle
extends RequestCycle

Base RequestCycle implementation for portlets. There is two implementations of this abstract class, PortletRenderRequestCycle for portlet render requests, and PortletActionRequesCycle for portlet action requests.

Author:

Janne Hietamäki

See Also:

PortletRenderRequestCycle, PortletActionRequestCycle

Field Summary

Fields inherited from class wicket.RequestCycle

application, processor, request, response, session

Constructor Summary

PortletRequestCycle(WicketPortletSession session, WicketPortletRequest request, Response response)
Constructor which simply passes arguments to superclass for storage there.

Method Summary

WicketPortletRequest	getPortletRequest()
WicketPortletResponse	getPortletResponse()
WicketPortletSession	getPortletSession()
protected ClientInfo	newClientInfo() Creates a new agent info object based on this request.
void	redirectTo(Page page) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.

Methods inherited from class wicket.RequestCycle

get, getApplication, getClientInfo, getOriginalResponse, getProcessor, getRedirect, getRequest, getRequestTarget, getResponse, getResponsePage, getResponsePageClass, getSession, getStartTime, onBeginRequest, onEndRequest, onRuntimeException, request, request, request, setRedirect, setRequest, setRequestTarget, setResponse, setResponsePage, setResponsePage, setResponsePage, setUpdateSession, toString, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PortletRequestCycle

public PortletRequestCycle(WicketPortletSession session,
                           WicketPortletRequest request,
                           Response response)

Constructor which simply passes arguments to superclass for storage there.

Parameters:

session - The session

request - The request

response - The response

Method Detail

getPortletRequest

public WicketPortletRequest getPortletRequest()

Returns:

Request as a PortletRequest

getPortletResponse

public WicketPortletResponse getPortletResponse()

Returns:

Response as a PortletResponse

getPortletSession

public WicketPortletSession getPortletSession()

Returns:

Session as a PortletSession

redirectTo

public final void redirectTo(Page page)

Description copied from class: RequestCycle

THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.

Redirects browser to the given page. Don't use this method directly, but use RequestCycle.setResponsePage(Page) instead.

Specified by:

redirectTo in class RequestCycle

Parameters:

page - The page to redirect to

newClientInfo

protected ClientInfo newClientInfo()

Description copied from class: RequestCycle

Creates a new agent info object based on this request. Typically, this method is called once by the session and the returned object will be cached in the session after that call; we can expect the client to stay the same for the whole session, and implementations of RequestCycle.newClientInfo() might be relatively expensive.

Specified by:

newClientInfo in class RequestCycle

Returns:

the agent info object based on this request

See Also:

RequestCycle.newClientInfo()