Revision as of 22:00, 1 April 2011

This article describes various ways of integrating CKFinder for Java with your page.

Integrating CKFinder with your Application

After you download the CKFinder for Java .war file, follow the steps below to integrate it with your application:

• Unpack CKFinder for Java.
• Copy the ckfinder folder to your application.
• Copy the CKFinder config.xml file from its WEB-INF folder into the WEB-INF folder of your application.
• Copy the contents of the CKFinder WEB-INF/lib folder into the WEB-INF/lib folder of your application.
• Copy the ConnectorServlet settings from the CKFinder web.xml file to the web.xml file of your application. Note that the <servlet-class> path and <url-pattern> will need to be adjusted to your application.

<servlet>
	<servlet-name>ConnectorServlet</servlet-name>
	<servlet-class>com.ckfinder.connector.ConnectorServlet</servlet-class>
	<init-param>
		<param-name>XMLConfig</param-name>
		<param-value>/WEB-INF/config.xml</param-value>
	</init-param>
	<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
	<servlet-name>ConnectorServlet</servlet-name>
	<url-pattern>
		/ckfinder/core/connector/java/connector.java
	</url-pattern>
</servlet-mapping>

• Just like in the sample application, by default CKFinder is disabled due to security reasons. To turn it on, change the <enabled> element value in the config.xml file to true. Note that more sensitive authentication method by overriding the checkAuthentication method in recommended.

<enabled>true</enabled>

• Similarily, some further adjustments of the config.xml file might be needed, like baseUrl and baseDir paths, for example.

Extending Configuration

CKFinder implements some access control that is available from your application. You can create a class that inherits and extends the Configuration class. A sample code can be seen below:

public class MyConfiguration extends Configuration {

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

	@Override
	public Boolean checkAuthentication() {
		return false;
	}
}

Special attention should be paid to the checkAuthentication 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 option is obviously not the only one that you can control. You can override each of the Configuration class methods that represent CKFinder setting, including enabling and disabling CKFinder.

Installing CKFinder as a JSP Page Tag

In order to install CKFinder as a tag inside a .jsp page, follow the steps outlined below:

• Install CKFinder as described in the section above.
• Copy the ckfinder.tld from the WEB-INF folder of CKFinder and paste it into the WEB-INF folder of your application.
• In the web.xml file of your application add the following entry:

<jsp-config>
     <taglib>
           <taglib-uri>/WEB-INF/ckfinder</taglib-uri>
           <taglib-location>/WEB-INF/ckfinder.tld</taglib-location>
     </taglib>
</jsp-config>

• In order to use the tag on the JSP page you should import the tag library by using the following directive:

<%@ taglib uri='../../WEB-INF/ckfinder.tld' prefix='ck' %>

You can now use the CKFinder tag on your JSP page in the following way:

<ck:ckfinder basePath="/CKFinderJava-1.0/ckfinder/" />

The only required attribute is the basePath that specifies the path to the CKFinder folder. Numerous optional attributes are also available and can be used to customize CKFinder to your needs, like in the example below:

<ck:ckfinder basePath="/CKFinderJava-1.0/ckfinder/" width="700" height="500" />

This code creates a CKFinder instance with a width of 700 pixels and height of 500 pixels.