| java.lang.Object
 org.apache.roller.ui.core.RollerRequest
| RollerRequest | | public class RollerRequest (Code) | | Access to objects and values specified by request. Parses out arguments from
request URL needed for various parts of Roller and makes them available via
getter methods.
These forms of pathinfo get special support (where 'handle' indicates website):
[handle] - get default page for user for today's date
[handle]/[date] - get default page for user for specified date
[handle]/[pagelink] - get specified page for today's date
[handle]/[pagelink]/[date] - get specified page for specified date
[handle]/[pagelink]/[anchor] - get specified page & entry (by anchor)
[handle]/[pagelink]/[date]/[anchor] - get specified page & entry (by anchor)
author:
David M Johnson |
| Method Summary | |
| public BookmarkData | getBookmark()
Gets the BookmarkData specified by the request, or null. | | public Date | getDate()
Gets the date specified by the request, or null. | | public Date | getDate(boolean orToday)
Gets the date specified by the request
Parameters:
orToday - If no date specified, then use today's date. | | public String | getDateString1()
| | public FolderData | getFolder()
Gets the FolderData specified by the request, or null. | | public Template | getPage()
Gets the WeblogTemplate specified by the request, or null. | | public PageContext | getPageContext()
| | public String | getPageLink()
Gets the page link name specified by the request, or null. | | public String | getPathInfo()
Gets the path-info specified by the request, or null. | | public String | getRefererURL()
Gets the Referer URL specified by the request, or null. | | public HttpServletRequest | getRequest()
| | public String | getRequestURL()
Gets the Request URL specified by the request, or null. | | public static RollerRequest | getRollerRequest(HttpServletRequest r, ServletContext ctx)
Get the RollerRequest object that is stored in the request. | | public static RollerRequest | getRollerRequest(HttpServletRequest r)
Get the RollerRequest object that is stored in the request. | | public static RollerRequest | getRollerRequest(PageContext p)
Get the RollerRequest object that is stored in the request. | | public static RollerRequest | getRollerRequest()
Get RollerRequest object for the current thread using EVIL MAGIC,
do not use unless you absolutely, positively, cannot use on of the
getRollerRequest() methods. | | public ServletContext | getServletContext()
Get the RollerRequest object that is stored in the requeset. | | public WeblogCategoryData | getWeblogCategory()
Gets the WeblogCategoryData specified by the request, or null. | | public WeblogEntryData | getWeblogEntry()
Gets the WeblogEntryData specified by the request, or null.
Why is this done lazily in the parseRequestParameters() method?
Because: that method is called from init(), which is called from
a ServletFilter, and sometimes request parameters are not available
in a ServletFiler. | | public int | getWeblogEntryCount()
| | public WebsiteData | getWebsite()
Gets the WebsiteData specified in the path info of the request URI, this is
NOT the same thing as the "current website" (i.e. | | public boolean | isDaySpecified()
| | public boolean | isEnableLinkback()
| | public boolean | isMonthSpecified()
| | public void | setPage(org.apache.roller.pojos.Template page)
Allow comment servlet to inject page that it has chosen. | | public void | setPageContext(PageContext p)
| | public void | setWebsite(WebsiteData wd)
| | public String | toString()
|
| ROLLER_REQUEST | | final public static String ROLLER_REQUEST(Code) | | |
| getBookmark | | public BookmarkData getBookmark()(Code) | | Gets the BookmarkData specified by the request, or null.
BookmarkData |
| getDate | | public Date getDate()(Code) | | Gets the date specified by the request, or null.
Date |
| getDate | | public Date getDate(boolean orToday)(Code) | | Gets the date specified by the request
Parameters:
orToday - If no date specified, then use today's date. Date |
| getFolder | | public FolderData getFolder()(Code) | | Gets the FolderData specified by the request, or null.
FolderData |
| getPage | | public Template getPage()(Code) | | Gets the WeblogTemplate specified by the request, or null.
WeblogTemplate |
| getPageContext | | public PageContext getPageContext()(Code) | | Get HttpServletmRequest that is wrapped by this RollerRequest
|
| getPageLink | | public String getPageLink()(Code) | | Gets the page link name specified by the request, or null.
String |
| getPathInfo | | public String getPathInfo()(Code) | | Gets the path-info specified by the request, or null.
String |
| getRefererURL | | public String getRefererURL()(Code) | | Gets the Referer URL specified by the request, or null.
String |
| getRequestURL | | public String getRequestURL()(Code) | | Gets the Request URL specified by the request, or null.
String |
| getRollerRequest | | public static RollerRequest getRollerRequest(HttpServletRequest r)(Code) | | Get the RollerRequest object that is stored in the request. Creates
RollerRequest if one not found in mRequest.
|
| getRollerRequest | | public static RollerRequest getRollerRequest()(Code) | | Get RollerRequest object for the current thread using EVIL MAGIC,
do not use unless you absolutely, positively, cannot use on of the
getRollerRequest() methods.
|
| getServletContext | | public ServletContext getServletContext()(Code) | | Get the RollerRequest object that is stored in the requeset.
Creates RollerRequest if one not found in mRequest.
|
| getWeblogCategory | | public WeblogCategoryData getWeblogCategory()(Code) | | Gets the WeblogCategoryData specified by the request, or null.
|
| getWeblogEntry | | public WeblogEntryData getWeblogEntry()(Code) | | Gets the WeblogEntryData specified by the request, or null.
Why is this done lazily in the parseRequestParameters() method?
Because: that method is called from init(), which is called from
a ServletFilter, and sometimes request parameters are not available
in a ServletFiler. They ARE available when the URL points to a JSP,
but they ARE NOT available when the URL points to the PageServlet.
This may be a Tomcat bug, I'm not sure.
WeblogEntryData |
| getWeblogEntryCount | | public int getWeblogEntryCount()(Code) | | |
| getWebsite | | public WebsiteData getWebsite()(Code) | | Gets the WebsiteData specified in the path info of the request URI, this is
NOT the same thing as the "current website" (i.e. the one that the session's
authenticated user is currently editing).
WebsiteData object specified by request URI. |
| isDaySpecified | | public boolean isDaySpecified()(Code) | | |
| isEnableLinkback | | public boolean isEnableLinkback()(Code) | |
See Also: org.apache.roller.pojos.ParsedRequest.isLinkbackEnabled |
| isMonthSpecified | | public boolean isMonthSpecified()(Code) | | |
|
|