org.esigate.impl

Class UrlRewriter

java.lang.Object

org.esigate.impl.UrlRewriter

public class UrlRewriter
extends Object

"fixes" links to resources, images and pages in pages retrieved by esigate :

• Current-path-relative urls are converted to full path relative urls ( img/test.img -> /myapp/curentpath/img/test.img)
• All relative urls can be converted to absolute urls (including server name)

This enables use of esigate without any special modifications of the generated urls on the provider side. All href and src attributes are processed, except javascript links.

Author:

Nicolas Richeton

Constructor Summary

Constructors

Constructor and Description
UrlRewriter() Rewrites urls from the response for the client or from the request to the target server.

Method Summary

Modifier and Type	Method and Description
CharSequence	rewriteHtml(CharSequence input, String requestUrl, String baseUrlParam, String visibleBaseUrl, boolean absolute) Fixes all resources urls and returns the result.
String	rewriteReferer(String referer, String baseUrl, String visibleBaseUrl) Fixes a referer url in a request.
String	rewriteRefresh(String input, String requestUrl, String baseUrl, String visibleBaseUrl) Rewrites a "Refresh" HTTP header or a <meta http-equiv="refresh"... tag.
String	rewriteUrl(String url, String requestUrl, String baseUrl, String visibleBaseUrl, boolean absolute) Fixes an url according to the chosen mode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UrlRewriter

public UrlRewriter()

Rewrites urls from the response for the client or from the request to the target server. If mode is ABSOLUTE, all relative urls will be replaced by the full urls :

• images/image.png is replaced by http://server/context/images/image.png
• /context/images/image.png is replaced by http://server/context/images/image.png

If mode is RELATIVE, context will be added to relative urls :

• images/image.png is replaced by /context/images/image.png

Method Detail

rewriteReferer

public String rewriteReferer(String referer,
                             String baseUrl,
                             String visibleBaseUrl)

Fixes a referer url in a request.

Parameters:

referer - the url to fix (can be anything found in an html page, relative, absolute, empty...)

baseUrl - The base URL selected for this request.

visibleBaseUrl - The base URL viewed by the browser.

Returns:

the fixed url.

rewriteUrl

public String rewriteUrl(String url,
                         String requestUrl,
                         String baseUrl,
                         String visibleBaseUrl,
                         boolean absolute)

Fixes an url according to the chosen mode.

Note: urls starting with an ESI variable are not rewriten.

Parameters:

url - the url to fix (can be anything found in an html page, relative, absolute, empty...)

requestUrl - The incoming request URL (could be absolute or relative to visible base url).

baseUrl - The base URL selected for this request.

visibleBaseUrl - The base URL viewed by the browser.

absolute - Should the rewritten urls contain the scheme host and port

Returns:

the fixed url.

rewriteHtml

public CharSequence rewriteHtml(CharSequence input,
                                String requestUrl,
                                String baseUrlParam,
                                String visibleBaseUrl,
                                boolean absolute)

Fixes all resources urls and returns the result.

Parameters:

input - The html to be processed.

requestUrl - The request URL.

baseUrlParam - The base URL selected for this request.

visibleBaseUrl - The base URL viewed by the browser.

absolute - Should the rewritten urls contain the scheme host and port

Returns:

the result of this renderer.

rewriteRefresh

public String rewriteRefresh(String input,
                             String requestUrl,
                             String baseUrl,
                             String visibleBaseUrl)

Rewrites a "Refresh" HTTP header or a <meta http-equiv="refresh"... tag. The value should have the following format: Refresh: 5; url=http://www.example.com

Parameters:

input - The refresh value to be rewritten.

requestUrl - The request URL.

baseUrl - The base URL selected for this request.

visibleBaseUrl - The base URL viewed by the browser.

Returns:

the rewritten refresh value