CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding - Revision history

J.swiderski at 22:51, 19 November 2015

2015-11-19T22:51:36Z

J.swiderski at 22:26, 19 November 2015

2015-11-19T22:26:16Z

J.swiderski at 06:50, 19 November 2015

2015-11-19T06:50:13Z

J.swiderski at 23:32, 18 November 2015

2015-11-18T23:32:39Z

J.swiderski at 21:47, 18 November 2015

2015-11-18T21:47:31Z

J.swiderski at 23:34, 15 November 2015

2015-11-15T23:34:28Z

J.swiderski at 15:55, 5 November 2015

2015-11-05T15:55:40Z

J.swiderski at 22:51, 4 November 2015

2015-11-04T22:51:54Z

J.swiderski at 16:43, 2 November 2015

2015-11-02T16:43:46Z

J.swiderski at 20:45, 22 November 2013

2013-11-22T20:45:51Z

@@ Line 54: / Line 54: @@
 ===WildFly===
-The WildFly belongs to the group of servers which use UTF-8 encoding for handling request parameters. Configuration setting responsible for the encoding is [https://docs.jboss.org/author/display/WFLY9/Undertow+%28web%29+subsystem+configuration#Undertow%28web%29subsystemconfiguration-Commonsettings url-charset]. In order to use international file names in CKFinder, one must leave <code>url-charset</code> setting with its default value and use [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses in the application.
+The WildFly belongs to the group of servers which use UTF-8 encoding for handling request parameters. Configuration setting responsible for the encoding is [https://docs.jboss.org/author/display/WFLY9/Undertow+%28web%29+subsystem+configuration#Undertow%28web%29subsystemconfiguration-Commonsettings url-charset]. In order to use international file names in CKFinder, one must leave <code>url-charset</code> setting with its default value and use [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses in the application. CKFinder is using the mentioned methods however since request parameters sent in the request body (occurs with an HTTP POST request) are parsed only once, it is very important that proper encoding is set as early as possible (best in a filter), before any reading of the parameters is performed.
 ===Weblogic===

@@ Line 54: / Line 54: @@
 ===WildFly===
-The WildFly belongs to the group of servers which use UTF-8 for handling request parameters. Configuration setting responsible for the encoding is [https://docs.jboss.org/author/display/WFLY9/Undertow+%28web%29+subsystem+configuration#Undertow%28web%29subsystemconfiguration-Commonsettings url-charset]. In order to have parameters properly encoded, one must leave <code>url-charset</code> setting with its default value and use [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses in the application.
+The WildFly belongs to the group of servers which use UTF-8 encoding for handling request parameters. Configuration setting responsible for the encoding is [https://docs.jboss.org/author/display/WFLY9/Undertow+%28web%29+subsystem+configuration#Undertow%28web%29subsystemconfiguration-Commonsettings url-charset]. In order to use international file names in CKFinder, one must leave <code>url-charset</code> setting with its default value and use [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses in the application.
 ===Weblogic===

@@ Line 54: / Line 54: @@
 ===WildFly===
-The WildFly belongs to the group of servers which by default use UTF-8 for handling request parameters. Configuration setting responsible for the encoding is [https://docs.jboss.org/author/display/WFLY9/Undertow+%28web%29+subsystem+configuration#Undertow%28web%29subsystemconfiguration-Commonsettings url-charset]. In order to have parameters properly encoded, one must leave <code>url-charset</code> setting with its default value and use [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses in the application.
+The WildFly belongs to the group of servers which use UTF-8 for handling request parameters. Configuration setting responsible for the encoding is [https://docs.jboss.org/author/display/WFLY9/Undertow+%28web%29+subsystem+configuration#Undertow%28web%29subsystemconfiguration-Commonsettings url-charset]. In order to have parameters properly encoded, one must leave <code>url-charset</code> setting with its default value and use [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses in the application.
 ===Weblogic===

@@ Line 52: / Line 52: @@
 </source>
 Please note that the <code>system-properties</code> node has to be placed directly under the <code>extensions</code> node, in standalone.xml file, or you will get parse errors.
 ===Weblogic===

@@ Line 1: / Line 1: @@
 By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''.  To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. <br />
 You will find more detailed instructions below.
 ===GlassFish 3.0===
@@ Line 52: / Line 39: @@
 In Tomcat 8 the default value of <code>URIEncoding</code> attribute depends on <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> [https://tomcat.apache.org/tomcat-8.0-doc/config/systemprops.html#Specifications system property]. When "strict servlet compliance" is off (default value), <code>URIEncoding</code> is now UTF-8. If "strict servlet compliance" is enabled, the <code>URIEncoding</code> is ISO-8859-1.<br />
 In other words, the <code>URIEncoding</code> in Tomcat 8+ is now optional but if you are getting encoding problems (e.g. because <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> was enabled) you can set this attribute explicitly to UTF-8 in the <code>Connector</code> element.
 ===Weblogic===

@@ Line 2: / Line 2: @@
 You will find more detailed instructions below.
-===JBOSS 7===
+===JBOSS EAP 6===
 By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used.<br />
-As you probably know, JBOSS 7 can run in two modes ("domain" and "standalone") and can use various configurations.
+As you probably know, JBOSS EAP can run in two modes ("domain" and "standalone") and can use various configurations.
 To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. <br />
 Below is the code that needs to be added to the configuration file you use:
@@ Line 13: / Line 13: @@
 </system-properties>
 </source>
 ===GlassFish 3.0===

@@ Line 40: / Line 40: @@
 ===Tomcat===
-According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], for handling HTTP requests by default Tomcat uses  the ISO-8859-1 encoding.
+According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], Tomcat 5-7 by default use the ISO-8859-1 encoding for handling HTTP request parameters.
 Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.
@@ Line 48: / Line 48: @@
 <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000"  redirectPort="8443" URIEncoding="UTF-8" />
 </source>
 ===Weblogic===

@@ Line 29: / Line 29: @@
 ===GlassFish 3.1+===
 By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code>  [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. <br />
-CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or 4.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy  <code>glassfish-web.xml</code> as well. <br />
+CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or above, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy  <code>glassfish-web.xml</code> as well. <br />
 Below is the code for the <code>glassfish-web.xml</code> file:
 <source lang="xml">

@@ Line 1: / Line 1: @@
 By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''.  To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. <br />
 You will find more detailed instructions below.
 ===JBOSS 7===
@@ Line 65: / Line 56: @@
 ===Jetty===
-All supported Jetty versions (7,8 and 9) use UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.
+The Jetty server uses UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.
 ===Alternative Solution (CKFinder Adjustment)===

@@ Line 1: / Line 1: @@
 According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], for handling HTTP requests by default Tomcat uses  the ISO-8859-1 encoding.
 Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.
-In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file.
+In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
 '''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''
-If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml</code> file. This parameter accepts the encoding of your query parameters. For GlassFish, Jetty, Tomcat, and JBoss with <code>URIEncoding</code> set to UTF-8 you should set <code>uriEncoding</code> to UTF-8 as well.
+If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. <br />
 <source lang="xml">
 <uriEncoding>ISO-8859-1</uriEncoding>
 </source>