CKFinder 2.x/Developers Guide/Java/System Requirements

2011-04-29T13:05:35Z

Ttomecki:

{{Ckfinder_2.x Requirements Description}}

== Server ==
CKFinder requirments for Java:
* Java 1.5+ for Windows and Linux.
* Tomcat 5.5, 6.0, or 7.0.
*; Also tested on Jetty 7.3.1, GlassFish 3.0.1, and JBoss 6.0.0.

CKFinder 2.x/Developers Guide/Java/Integration

2011-04-29T13:02:43Z

Ttomecki:

__TOC__
{{#CUSTOMTITLE:Integrating CKFinder}}
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 <code>.war</code> file, follow the steps below to integrate it with your application:
* Unpack CKFinder for Java.
* Copy the <code>ckfinder</code> folder to your application.
* Copy the CKFinder <code>config.xml</code> file from its <code>WEB-INF</code> folder into the <code>WEB-INF</code> folder of your application.
* Copy the contents of the CKFinder <code>WEB-INF/lib</code> folder into the <code>WEB-INF/lib</code> folder of your application.
* Copy the <code>ConnectorServlet</code> settings from the CKFinder <code>web.xml</code> file to the <code>web.xml</code> file of your application.
<source lang="xml">
<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>
</source>
* Just like in the sample application, by default CKFinder is disabled due to security reasons. To turn it on, change the <code><enabled></code> element value in the <code>config.xml</code> file to <code>true</code>. Note that it is recommended to use a more fine-grained authentication method by overriding the <code>checkAuthentication</code> method.
<source lang="xml">
<enabled>true</enabled>
</source>
* Similarily, some further adjustments of the <code>config.xml</code> file might be needed, like <code>baseUrl</code> and <code>baseDir</code> paths, for example.

== Installing CKFinder as a JSP Page Tag ==
In order to install CKFinder as a tag inside a <code>.jsp</code> page, follow the steps outlined below:
* Install CKFinder as described in the section above.
* In order to use the tag on the JSP page you should import the tag library by using the following directive:
<source lang="java">
<%@ taglib uri='../../WEB-INF/ckfinder.tld' prefix='ck' %>
</source>

You can now use the CKFinder tag on your JSP page in the following way:
<source lang="java">
<ck:ckfinder basePath="/CKFinderJava-1.0/ckfinder/" />
</source>

The only required attribute is the <code>basePath</code> 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:

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

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

== Extending Configuration ==
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 read more about extending your CKFinder configuration, refer to the [[CKFinder_2.x/Developers_Guide/Java/Configuration/Extending|Extending CKFinder Configuration]] article.

CKSource Docs - User contributions [en]

CKFinder 2.x/Developers Guide/Java/System Requirements

CKFinder 2.x/Developers Guide/Java/Integration