|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface URLConstructor
Provides an interface through which JSPWiki constructs URLs. JSPWiki calls the methods of this interface whenever an URL that points to any JSPWiki internals is required. For example, if you need to find an URL to the editor page for page "TextFormattingRules", you would call makeURL( WikiContext.EDIT, "TextFormattingRules", false, null );
Method Summary | |
---|---|
String |
getForwardPage(javax.servlet.http.HttpServletRequest request)
Returns information which JSP page should continue handling this type of request. |
void |
initialize(WikiEngine engine,
Properties properties)
Initializes. |
String |
makeURL(String context,
String name,
boolean absolute,
String parameters)
Constructs the URL with a bunch of parameters. |
String |
parsePage(String context,
javax.servlet.http.HttpServletRequest request,
String encoding)
Should parse the "page" parameter from the actual request. |
Method Detail |
---|
void initialize(WikiEngine engine, Properties properties)
engine
- The WikiEngine that this URLConstructor belongs toproperties
- Properties used to initializeString makeURL(String context, String name, boolean absolute, String parameters)
context
- The request context (@see WikiContext) that you want the URL forname
- The page name (or in case of WikiContext.NONE, the auxiliary JSP page
or resource you want to point at. This must be URL encoded. Null is NOT safe.absolute
- True, if you need an absolute URL. False, if both relative and absolute
URLs are fine.parameters
- An URL parameter string (these must be URL-encoded, and separated with &)
String parsePage(String context, javax.servlet.http.HttpServletRequest request, String encoding) throws IOException
context
- In which request context the request was made (this should
help in parsing)request
- The HTTP request that was used when coming hereencoding
- The encoding with which the request was made (UTF-8 or ISO-8859-1).
IOException
- If parsing failesString getForwardPage(javax.servlet.http.HttpServletRequest request)
request
- The HTTP Request that was used to end up in this page.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |