URLRewriterService Class

com.bea.struts.adapter.util.rewriter
URLRewriterService Class

public class URLRewriterService

    extends Object

Methods for registering URL rewriters, and for rewriting URLs using registered rewriters.

Hierarchy
Object
  URLRewriterService

Constructor Summary
URLRewriterService()
 

Method Summary
public static String
createActionURL(PageContext pageContext, String action, String type)
public static String
getActionMappingName(String action)
Return the form action converted into an action mapping path.
public static final URLRewriter
getDefaultRewriter()
Get the default URLRewriter.
protected static URLRewriter
getRewriter(ServletRequest request)
public static boolean
isStandAloneForward(ServletRequest request)
Used to determine whether or not a tag is to be rendered within a nested environment, such as a portal.
public static void
registerURLRewriter(ServletRequest request, URLRewriter rewriter)
Register a URLRewriter in the request.
public static String
rewriteName(ServletContext servletContext, ServletRequest request, String name)
Rewrite the given parameter name, using the registered URLRewriter.
public static String
rewriteURL(ServletContext servletContext, ServletRequest request, ServletResponse response, String url, String type)
Rewrite the given URL, using the registered URLRewriter.
public static String
rewriteURL(ServletContext servletContext, ServletRequest request, ServletResponse response, String url, String type, boolean doEncode)
Rewrite the given URL, using the registered URLRewriter.
public static URLRewriter
unregisterURLRewriter(ServletRequest request)
Unregister the URLRewriter from the request.
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail

URLRewriterService

public URLRewriterService()
 

Method Detail

createActionURL(PageContext, String, String) Method

public static String createActionURL(PageContext pageContext, 
                                     String action, 
                                     String type)

getActionMappingName(String) Method

public static String getActionMappingName(String action)
Return the form action converted into an action mapping path. The value of the action property is manipulated as follows in computing the name of the requested mapping:

Parameters

action
the action name to be converted.

Returns

an action path, suitable for lookup in the Struts configuration file.

getDefaultRewriter() Method

public static final URLRewriter getDefaultRewriter()
Get the default URLRewriter.

Returns

an instance of DefaultURLRewriter.

getRewriter(ServletRequest) Method

protected static URLRewriter getRewriter(ServletRequest request)

isStandAloneForward(ServletRequest) Method

public static boolean isStandAloneForward(ServletRequest request)
Used to determine whether or not a tag is to be rendered within a nested environment, such as a portal.

registerURLRewriter(ServletRequest, URLRewriter) Method

public static void registerURLRewriter(ServletRequest request, 
                                       URLRewriter rewriter)
Register a URLRewriter in the request. This rewriter will be used if URLRewriterService.rewriteURL(ServletContext, ServletRequest, ServletResponse, String, String) is called.

Parameters

request
the current HttpServletRequest.
rewriter
the URLRewriter to register.

rewriteName(ServletContext, ServletRequest, String) Method

public static String rewriteName(ServletContext servletContext, 
                                 ServletRequest request, 
                                 String name)
Rewrite the given parameter name, using the registered URLRewriter.

Parameters

servletContext
the current ServletContext.
request
the current HttpServletRequest.
name
the parameter name to rewrite.

Returns

the rewritten parameter name.

rewriteURL(ServletContext, ServletRequest, ServletResponse, String, String) Method

public static String rewriteURL(ServletContext servletContext, 
                                ServletRequest request, 
                                ServletResponse response, 
                                String url, 
                                String type)
Rewrite the given URL, using the registered URLRewriter.

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:

Returns

the rewritten URL.

Related Topics

URLRewriterService.registerURLRewriter(ServletRequest, URLRewriter)

rewriteURL(ServletContext, ServletRequest, ServletResponse, String, String, boolean) Method

public static String rewriteURL(ServletContext servletContext, 
                                ServletRequest request, 
                                ServletResponse response, 
                                String url, 
                                String type, 
                                boolean doEncode)
Rewrite the given URL, using the registered URLRewriter.

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:
doEncode
if true, the rewritten URL will be encoded using HttpServletResponse.encodeRedirectURL(String).

Returns

the rewritten URL.

Related Topics

URLRewriterService.registerURLRewriter(ServletRequest, URLRewriter)

unregisterURLRewriter(ServletRequest) Method

public static URLRewriter unregisterURLRewriter(ServletRequest request)
Unregister the URLRewriter from the request.

Parameters

request
the current HttpServletRequest.

Returns

the URLRewriter that was unregistered, or null if there was none registered.

Related Topics

URLRewriterService.registerURLRewriter(ServletRequest, URLRewriter)