rewrite-api-servlet 1.0.3.Final

org.ocpsoft.rewrite.servlet.http.event
Interface HttpServletRewrite

All Superinterfaces:
Rewrite, ServletRewrite<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>
All Known Subinterfaces:
HttpInboundServletRewrite, HttpOutboundServletRewrite

public interface HttpServletRewrite
extends ServletRewrite<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Author:
Lincoln Baxter, III

Method Summary
 String getContextPath()
          Return the application context root HttpServletRequest.getContextPath()
 String getRequestPath()
          Portion of the request URL representing request path within the application.
 String getRequestQueryString()
          Portion of the request URL representing the query string.
 String getRequestQueryStringSeparator()
          Portion of the request URL joining the getRequestPath() and getRequestQueryString().
 String getURL()
          For HttpInboundServletRewrite events, return the request URL excluding context path, but including query string: getRequestPath() + getRequestQueryStringSeparator() + getRequestQueryString()
 
Methods inherited from interface org.ocpsoft.rewrite.servlet.event.ServletRewrite
abort, getFlow, getRequest, getResponse, handled, proceed, setFlow
 
Methods inherited from interface org.ocpsoft.rewrite.event.Rewrite
getRewriteContext
 

Method Detail

getContextPath

String getContextPath()
Return the application context root HttpServletRequest.getContextPath()


getRequestPath

String getRequestPath()
Portion of the request URL representing request path within the application. The context path is not included, and should be retrieved using getContextPath()


getRequestQueryString

String getRequestQueryString()
Portion of the request URL representing the query string.


getRequestQueryStringSeparator

String getRequestQueryStringSeparator()
Portion of the request URL joining the getRequestPath() and getRequestQueryString(). If getRequestQueryString() is valued, this will return "?"; otherwise, if getRequestQueryString() is empty, this too will return an empty string.


getURL

String getURL()
For HttpInboundServletRewrite events, return the request URL excluding context path, but including query string: getRequestPath() + getRequestQueryStringSeparator() + getRequestQueryString()

For HttpOutboundServletRewrite events, this method returns HttpOutboundServletRewrite.getOutboundURL()


rewrite-api-servlet 1.0.3.Final

Copyright © 2012 OCPsoft. All Rights Reserved.