Interface Encodes.URLEncoder
- Enclosing class:
- Encodes
Encodes.encodeURL(jakarta.servlet.ServletContext, jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse, java.lang.String) will call
to encode the URL.
In a sophisticated environment, e.g.,
Reverse Proxy,
the encoded URL might have to be prefixed with some special prefix.
To do that, you can implement Encodes.URLEncoder, and then
specify the class with the library property called
org.zkoss.web.servlet.http.URLEncoder.
When encodeURL(jakarta.servlet.ServletContext, jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse, java.lang.String, org.zkoss.web.servlet.http.Encodes.URLEncoder) encodes an URL, it will invoke
encodeURL(jakarta.servlet.ServletContext, jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse, java.lang.String, org.zkoss.web.servlet.http.Encodes.URLEncoder) such you can do customized encoding,
such as insert a special prefix.
-
Method Summary
Modifier and TypeMethodDescriptionencodeURL(jakarta.servlet.ServletContext ctx, jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, String url, Encodes.URLEncoder defaultEncoder) Encodes the specified URL by including the session ID and the servlet context path, if necessary.
-
Method Details
-
encodeURL
String encodeURL(jakarta.servlet.ServletContext ctx, jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, String url, Encodes.URLEncoder defaultEncoder) throws Exception Encodes the specified URL by including the session ID and the servlet context path, if necessary.Notice that url might contain "~" and other special characters that the Web server won't support. The implementation might invoke back the default encoding by use of the defaultEcoder parameter.
- Parameters:
url- the URL to encode. It shall not include the servlet context path.defaultEncoder- the default encoder (never null).- Throws:
Exception- Since:
- 5.0.0
-