org.apache.beehive.netui.pageflow.util
Class URLRewriter

Object
  extended by URLRewriter
Direct Known Subclasses:
DefaultURLRewriter

Deprecated. Use URLRewriter instead.

public abstract class URLRewriter
extends Object

URL rewriter interface. Offers methods for rewriting URLs/query parameters, and adding URL rewriters to the chain.


Field Summary
static String ACTION_SECURE
          Deprecated. Passed to rewriteURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.String) for normal (non-resource) secure URLs.
static String ACTION_UNSECURE
          Deprecated. Passed to rewriteURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.String) for normal (non-resource) non-secure URLs.
static String RESOURCE_SECURE
          Deprecated. Passed to rewriteURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.String) for resource (e.g., image) secure URLs.
static String RESOURCE_UNSECURE
          Deprecated. Passed to rewriteURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.String) for resource (e.g., image) non-secure URLs.
 
Constructor Summary
URLRewriter()
          Deprecated.  
 
Method Summary
 boolean allowParamsOnFormAction(ServletContext servletContext, ServletRequest request)
          Deprecated. Tell whether rewritten form actions should be allowed to have query parameters.
 URLRewriter getNextRewriter()
          Deprecated. Get the next URLRewriter in the chain.
abstract  String rewriteName(ServletContext servletContext, ServletRequest request, String name)
          Deprecated. Rewrite the given query parameter name.
abstract  String rewriteURL(ServletContext servletContext, ServletRequest request, ServletResponse response, String url, String type)
          Deprecated. Rewrite the given URL.
 void setNextRewriter(URLRewriter nextRewriter)
          Deprecated. Set the next URLRewriter in the chain.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_UNSECURE

public static String ACTION_UNSECURE
Deprecated. 
Passed to rewriteURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.String) for normal (non-resource) non-secure URLs.


ACTION_SECURE

public static String ACTION_SECURE
Deprecated. 
Passed to rewriteURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.String) for normal (non-resource) secure URLs.


RESOURCE_UNSECURE

public static String RESOURCE_UNSECURE
Deprecated. 
Passed to rewriteURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.String) for resource (e.g., image) non-secure URLs.


RESOURCE_SECURE

public static String RESOURCE_SECURE
Deprecated. 
Passed to rewriteURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.String) for resource (e.g., image) secure URLs.

Constructor Detail

URLRewriter

public URLRewriter()
Deprecated. 
Method Detail

rewriteName

public abstract String rewriteName(ServletContext servletContext,
                                   ServletRequest request,
                                   String name)
Deprecated. 
Rewrite the given query parameter name.

Parameters:
servletContext - the current ServletContext.
request - the current HttpServletRequest.
name - the query parameter name to rewrite.
Returns:
the rewritten query parameter name.

rewriteURL

public abstract String rewriteURL(ServletContext servletContext,
                                  ServletRequest request,
                                  ServletResponse response,
                                  String url,
                                  String type)
Deprecated. 
Rewrite the given URL.

Parameters:
servletContext - the current ServletContext.
request - the current HttpServletRequest.
response - the current HttpServletResponse.
url - the URL to rewrite.
type - the type of URL to be rewritten. This is one of the following values:
  • action: a standard (non-resource) URL, for which SSL is not required
  • secure-action: a standard (non-resource) URL, for which SSL is required
  • resource: a resource (e.g., image) URL, for which SSL is not required
  • secure-resource: a resource (e.g., image) URL, for which SSL is required
Returns:
the rewritten URL.

getNextRewriter

public URLRewriter getNextRewriter()
Deprecated. 
Get the next URLRewriter in the chain.

See Also:
setNextRewriter(org.apache.beehive.netui.pageflow.util.URLRewriter)

setNextRewriter

public void setNextRewriter(URLRewriter nextRewriter)
Deprecated. 
Set the next URLRewriter in the chain. When URLRewriterService.rewriteURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.String) is called, it will start with the URLRewriter registered in the request (URLRewriterService.registerURLRewriter(javax.servlet.ServletRequest, org.apache.beehive.netui.pageflow.util.URLRewriter)), and call rewriteURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.String) on each URLRewriter in the chain.


allowParamsOnFormAction

public boolean allowParamsOnFormAction(ServletContext servletContext,
                                       ServletRequest request)
Deprecated. 
Tell whether rewritten form actions should be allowed to have query parameters. If this returns false, then a form-tag implementation should render query parameters into hidden fields on the form instead of allowing them to remain in the URL.