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

Wiktor: Removed -X.Y

2011-05-02T19:34:30Z

Removed -X.Y

Anna: /* Extending the checkAuthentication Method */ Some introductory text added

2011-04-22T11:04:38Z

‎Extending the checkAuthentication Method: Some introductory text added

Anna: Licence -> License

2011-04-19T09:12:25Z

Licence -> License

Anna: licenseName -> licenceName

2011-04-19T08:58:04Z

licenseName -> licenceName

Anna: Code indentation corrected

2011-04-19T08:45:16Z

Code indentation corrected

Anna: /* Changing the Configuration in the prepareConfigurationForRequest Method */ Text corrected

2011-04-18T13:50:19Z

‎Changing the Configuration in the prepareConfigurationForRequest Method: Text corrected

Anna: Spacing under note added

2011-04-18T13:33:46Z

Spacing under note added

Anna: /* Creating a Custom PathBuilder Class */ 2.0 -> X.Y

2011-04-18T13:32:43Z

‎Creating a Custom PathBuilder Class: 2.0 -> X.Y

Anna: /* Changing Configuration in the init Method */ 2.0 -> X.Y

2011-04-18T13:29:57Z

‎Changing Configuration in the init Method: 2.0 -> X.Y

Anna: Article contents added

2011-04-18T13:14:34Z

Article contents added

New page

{{#CUSTOMTITLE:Extending CKFinder Configuration}}
__TOC__
The <code>MyConfiguration</code> class lets you change the base CKFinder configuration, or, in other words, change the settings from the XML file at the Java class level.

To make CKFinder aware of the new configuration settings it is necessary to add the following entry to the <code>web.xml</code> file.
<source lang="xml">
<init-param>
<param-name>configuration</param-name>
<param-value>com.ckfinder.connector.configuration.MyConfiguration</param-value>
</init-param>
</source>

This entry assumes that your <code>MyConfiguration</code> class was created in the <code>com.ckfinder.connector.configuration</code> package.

The basic structure of a class that extends CKFinder configuration looks like this:
<source lang="java">
public class MyConfiguration extends Configuration {

public MyConfiguration(ServletConfig servletConfig) {
super(servletConfig);
}

@Override
protected Configuration createConfigurationInstance() {
return new MyConfiguration(this.servletConf);
}
}
</source>

Based on the above template, two important things should be noted.

First of all, at least theoretically you can avoid overriding the <code>createConfigurationInstance</code> method, but in this case almost none of the changes introduced in <code>MyConfiguration</code> class will have any effect. The only exception to this is the <code>init</code> method, where the changes ''will'' be visible, because it operates directly on the class fields. This technique is not recommended and was only mentioned for clarification purposes. This article assumes that you have extended the <code>createConfigurationInstance</code> method as described.

Secondly, at the moment the class uses the base configuration. In order to introduce custom settings you need to extend the <code>Configuration</code> class methods, like <code>init</code>, <code>checkAuthentication</code>, <code>prepareConfigurationForRequest</code>, and specific getter methods. For examples on extending some of these methods check the section below.

== Changing Configuration in the init Method ==
This section describes how to override the whole XML file based configuration or just a part of it.

The first operation in the <code>init</code> method should be to call the <code>init</code> method of the base class by using the following instruction:
<source lang="java">
super.init();
</source>

This instruction will read the configuration from the XML file. If you want to create your own configuration from scratch, without reading the default one from the XML file, this step can omitted.

The example below shows how to modify the path for the <code>baseURL</code> setting and add the <code>zip</code> and <code>7z</code> extensions to <code>allowedExtensions</code>. It is assumed that the <code>Files</code> resource type was added to the default configuration.
<source lang="java">
@Override
public void init() throws Exception {
super.init();
this.baseURL = "/CKFinderJava-2.0/userfiles/";
ResourceType resourceType = this.types.get("Files");
resourceType.setAllowedExtensions(
resourceType.getAllowedExtensions().concat(",zip,7z"));
}
</source>

== Extending the checkAuthentication Method ==
This method allows you to run your own checks to see whether the user should have access to CKFinder. The checks are executed on the application level.

The example below checks whether the user is logged into the application by testing the session attribute named <code>loggedIn</code>.
<source lang="java">
@Override
public boolean checkAuthentication(final HttpServletRequest request) {
return request.getSession().getAttribute("loggedIn") != null;
}
</source>

== Extending the Access Method for a Specific Configuration Class Field ==
Any value defined in the XML tags, like <code><licenseName>sampleLicenseName</licenseName></code>, can be overridden in the <code>MyConfiguration</code> class.

The example below shows how to define the license name at the class level.
<source lang="java">
@Override
public String getLicenseName() {
return "MyLicenseName";
}
</source>

== Modifying the baseDir and baseURL Values ==
These two parameters deserve special attention since they are crucial for CKFinder configuration and at the same time can be modified in a few different ways.

<note>For an explanation of the role of <code>baseDir</code> and <code>baseURL</code> parameters refer to the [[CKFinder_2.x/Developers_Guide/Java/Configuration/Quick_Start|Quick Start guide article]].
</note>

The <code>baseDir</code> and <code>baseURL</code> parameters can be configured by using the following methods described below.

=== Overriding the getBaseDir and getBaseURL Methods ===
Use the following code to override the <code>getBaseDir</code> and <code>getBaseURL</code> methods.
<source lang="java">
@Override
public String getBaseDir() {
return "C:\\tomcat\\webapps\\MyApplication\\userfiles";
}

@Override
public String getBaseURL() {
return "/MyApplication/userfiles/";
}
</source>

=== Setting the baseDir or baseURL Value in the init Method ===
Use the following code to set the <code>baseDir</code> and <code>baseURL</code> values directly in the <code>init()</code> method:
<source lang="java">
this.baseURL = "/MyApplication/userfiles/";
</source>

=== Creating a Custom PathBuilder Class ===
This approach requires you to create a class that implements the following interface:
<source>com.ckfinder.connector.configuration.IBasePathBuilder</source>
or extend an existing class that already implements this interface.

The following CKFinder classes already implement this interface:
* <code>com.ckfinder.connector.configuration.DefaultPathBuilder</code>
*; This class creates a <code>baseURL</code> in the following form: <code>/application name/userfiles</code> (e.g. <code>/CKFinderJava-2.0/userfiles</code>) and a <code>baseDir</code> in the form of an absolute path to the <code>userfiles</code> directory.
* <code>com.ckfinder.connector.configuration.ConfigurationPathBuilder</code>
*; This class gets the values from the <code>Configuration</code> class object or, if available, from the object of a class that inherits from the <code>Configuration</code> class.

When creating a class that extends the <code>DefaultPathBuilder</code> class it is necessary to implement the <code>getBaseDir</code> and <code>getBaseURL</code> methods. These methods must not return empty values.

When the class is ready, the <code> basePathBuilderImpl</code> value should be set in the <code>config.xml</code> file.
<source lang="xml">
<basePathBuilderImpl>my.sample.NewPathBuilder</basePathBuilderImpl>
</source>

The example below shows a new class named <code>NewPathBuilder</code> located in the <code>my.sample</code> package.
<source lang="java">
package my.sample;

import javax.servlet.http.HttpServletRequest;

import com.ckfinder.connector.configuration.DefaultPathBuilder;

public class NewPathBuilder extends DefaultPathBuilder {

@Override
public String getBaseDir(HttpServletRequest arg0) {
return "C:\\tomcat\\webapps\\MyApplication\\myFiles";
}

@Override
public String getBaseURL(HttpServletRequest request) {
return "/MyApplication/myFiles/";
}
}
</source>
With the above configuration CKFinder will use the <code>myFiles</code> directory as the main user files container instead of using the default <code>userfiles</code> directory.

<note>The <code>baseDir</code> and <code>baseURL</code> parameters should not be modified in the <code>prepareConfigurationForRequest</code> method as this will cause the changes to be ignored.</note>

== Changing the Configuration in the prepareConfigurationForRequest Method ==
While extending the <code>prepareConfigurationForRequest</code> method it is not necessary to call the base class method as it is empty.

The example below shows how to change the maximum image size based on its resource type. For the <code>Images</code> resource type the maximum dimensions will be set for 800x600 pixels, while for the <code>Files</code> type the size will be set to 600x480 pixels.

The code below also shows how to change the direct access to thumbnails by calling an additional parameter in the request. As mentioned above, this change will have no effect and will be ignored.
<source lang="java">
@Override
public void prepareConfigurationForRequest(HttpServletRequest request) {
if (request.getParameter("directThumbAccess") != null) {
this.thumbsDirectAccess = true;
}
String type = request.getParameter("type");
if ("Files".equals(type)) {
this.imgHeight = 480;
this.imgWidth = 600;
}
if ("Images".equals(type)) {
this.imgWidth = 800;
this.imgHeight = 600;
}
this.baseURL = "/webapps/ckfinder/"; //This will not work!
this.baseDir = "c:\ckfinder"; //This will not work!
}
</source>

← Older revision		Revision as of 11:04, 22 April 2011
Line 59:		Line 59:

	== Extending the checkAuthentication Method ==		== Extending the checkAuthentication Method ==
		+	CKFinder implements some access control that is available from your application. You can create a class that inherits and extends the <code>Configuration</code> class with your custom <code>checkAuthentication</code> method. It can be used to specify the pre-requisites (like administrator rights) that have to be met in order to make CKFinder available.
		+
	This method allows you to run your own checks to see whether the user should have access to CKFinder. The checks are executed on the application level.		This method allows you to run your own checks to see whether the user should have access to CKFinder. The checks are executed on the application level.

@@ Line 51: / Line 51: @@
 public void init() throws Exception {
 	super.init();
-	this.baseURL = "/CKFinderJava-X.Y/userfiles/";
+	this.baseURL = "/CKFinderJava/userfiles/";
 	ResourceType resourceType = this.types.get("Files");
 	resourceType.setAllowedExtensions(
@@ Line 118: / Line 118: @@
 The following CKFinder classes already implement this interface:
 * <code>com.ckfinder.connector.configuration.DefaultPathBuilder</code>
-*; This class creates a <code>baseURL</code> in the following form: <code>/application name/userfiles</code> (e.g. <code>/CKFinderJava-X.Y/userfiles</code>) and a <code>baseDir</code> in the form of an absolute path to the <code>userfiles</code> directory.
+*; This class creates a <code>baseURL</code> in the following form: <code>/application name/userfiles</code> (e.g. <code>/CKFinderJava/userfiles</code>) and a <code>baseDir</code> in the form of an absolute path to the <code>userfiles</code> directory.
 * <code>com.ckfinder.connector.configuration.ConfigurationPathBuilder</code>
 *; This class gets the values from the <code>Configuration</code> class object or, if available, from the object of a class that inherits from the <code>Configuration</code> class.

@@ Line 70: / Line 70: @@
 == Extending the Access Method for a Specific Configuration Class Field ==
-Any value defined in the XML tags, like <code><licenceName>sampleLicenseName</licenceName></code>, can be overridden in the <code>MyConfiguration</code> class.
+Any value defined in the XML tags, like <code><licenseName>sampleLicenseName</licenseName></code>, can be overridden in the <code>MyConfiguration</code> class.
 The example below shows how to define the license name at the class level.

@@ Line 75: / Line 75: @@
 <source lang="java">
 @Override
-	public String getLicenseName() {
+public String getLicenseName() {
-		return "MyLicenseName";
+	return "MyLicenseName";
-−
+}
 </source>
@@ Line 161: / Line 161: @@
 <source lang="java">
 @Override
-	public void prepareConfigurationForRequest(HttpServletRequest  request) {
+public void prepareConfigurationForRequest(HttpServletRequest  request) {
-		if (request.getParameter("directThumbAccess") != null) {
+	if (request.getParameter("directThumbAccess") != null) {
-			this.thumbsDirectAccess = true;
+		this.thumbsDirectAccess = true;
-−
+	}
-		String type = request.getParameter("type");
+	String type = request.getParameter("type");
-		if ("Files".equals(type)) {
+	if ("Files".equals(type)) {
-			this.imgHeight = 480;
+		this.imgHeight = 480;
-			this.imgWidth = 600;
+		this.imgWidth = 600;
-−
+	}
-		if ("Images".equals(type)) {
+	if ("Images".equals(type)) {
-			this.imgWidth = 800;
+		this.imgWidth = 800;
-			this.imgHeight = 600;
+		this.imgHeight = 600;
-−
+	}
 	this.baseURL = "/webapps/ckfinder/";	//This will not work!
 	this.baseDir = "c:\ckfinder";		//This will not work!
-−
+}
 </source>
 Additionally, this example also contains some code that attempts to modify the <code>baseDir</code> and <code>baseURL</code> parameters. As mentioned above, this change will have no effect and will be ignored.

@@ Line 158: / Line 158: @@
 The example below shows how to change the maximum image size based on its resource type. For the <code>Images</code> resource type the maximum dimensions will be set for 800x600 pixels, while for the <code>Files</code> type the size will be set to 600x480 pixels.
-The code below also shows how to change the direct access to thumbnails by calling an additional parameter in the request. As mentioned above, this change will have no effect and will be ignored.
+The code below also shows how to change the direct access to thumbnails by calling an additional parameter in the request.
 <source lang="java">
 @Override
@@ Line 178: / Line 178: @@
+	}
 </source>

← Older revision		Revision as of 13:33, 18 April 2011
Line 151:		Line 151:

	<note>The <code>baseDir</code> and <code>baseURL</code> parameters should not be modified in the <code>prepareConfigurationForRequest</code> method as this will cause the changes to be ignored.</note>		<note>The <code>baseDir</code> and <code>baseURL</code> parameters should not be modified in the <code>prepareConfigurationForRequest</code> method as this will cause the changes to be ignored.</note>
		+

	== Changing the Configuration in the prepareConfigurationForRequest Method ==		== Changing the Configuration in the prepareConfigurationForRequest Method ==