org.zkoss.web.servlet.http
Interface Encodes.URLEncoder

Enclosing class:

Encodes

public static interface Encodes.URLEncoder

The URL encoder used to post-process the encoded URL of Encodes.encodeURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String) before returning.

When Encodes.encodeURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String) encodes an URL, it will check any URL encoder is defined (by Encodes.setURLEncoder(org.zkoss.web.servlet.http.Encodes.URLEncoder). If any, it will invoke encodeURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String) with the encoded URL to give it the last chance to 'manipulate' it.

Since:

3.0.1

See Also:

Encodes.setURLEncoder(org.zkoss.web.servlet.http.Encodes.URLEncoder), Encodes.encodeURL(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String)

Method Summary

java.lang.String

encodeURL(javax.servlet.ServletContext ctx, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.String url) Returns the encoded URL.

Method Detail

encodeURL

java.lang.String encodeURL(javax.servlet.ServletContext ctx,
                           javax.servlet.ServletRequest request,
                           javax.servlet.ServletResponse response,
                           java.lang.String url)

Returns the encoded URL.

Parameters:

url - it must be null, empty, starts with "/", or starts with "xxx:" (e.g., "http://", "javascript:"