CKFinder 2.x/Developers Guide/Java/Plugins/Writing Java - Revision history

Anna: /* Plugin Command Class */ Minor clarification added

2011-05-23T10:16:17Z

‎Plugin Command Class: Minor clarification added

Anna: /* Plugin Command Class */ Minor clarification added

2011-05-23T10:04:59Z

‎Plugin Command Class: Minor clarification added

Anna: /* Plugin Command Class */ Clarification added

2011-05-23T09:56:47Z

‎Plugin Command Class: Clarification added

Anna: /* Plugin Command Class */

2011-05-23T09:51:07Z

‎Plugin Command Class

Anna: /* Plugin Command Class */ Minor clarification added

2011-05-23T09:46:48Z

‎Plugin Command Class: Minor clarification added

Anna: /* Finding the File Name */ Minor clarification added

2011-05-23T09:40:29Z

‎Finding the File Name: Minor clarification added

Anna: /* Plugin Command Class */ Minor clarification added

2011-05-23T09:39:25Z

‎Plugin Command Class: Minor clarification added

Anna: /* Returning the XML Response */ Article section proof-read

2011-05-18T08:39:05Z

‎Returning the XML Response: Article section proof-read

Anna: /* Plugin Command Class */ Article section proof-read

2011-05-18T08:33:59Z

‎Plugin Command Class: Article section proof-read

Anna: /* Adding the Plugin Definition */ Article section proof-read

2011-05-18T06:55:40Z

‎Adding the Plugin Definition: Article section proof-read

@@ Line 192: / Line 192: @@
 </source>
-After a class is registered as an <code>EventHandler</code>, the <code>runEventHandler</code> methods of the registered classes are run when a given event is invoked by CKFinder. Since more plugins can be registered to handle one event type, it is important for the class to check in the method whether it should proceed. The example below shows that we need to check whether the command name equals <code>FileSize</code>. The <code>runCommand</code> method is called inside <code>runEventHandler</code> in order to invoke all other class methods  (including <code>createXMLChildNodes</code> and <code>getDataForXml</code>) and execute the command. In short, it invokes the following:
+After a class is registered as an <code>EventHandler</code>, the <code>runEventHandler</code> methods of the registered classes are run when a given event is invoked by CKFinder. Since more plugins can be registered to handle one event type, it is important for the class to check in the method whether it should proceed. The example below shows that we need to check whether the command name equals <code>FileSize</code>. The <code>runCommand</code> method is called inside <code>runEventHandler</code> in order to invoke all other class methods and execute the command. In short, it invokes the following:
 <source lang="java">
 initParams();
-createXMLResponse(getDataForXml());
+createXMLResponse(getDataForXml());	// Invokes the createXMLChildNodes method.
 </source>

@@ Line 192: / Line 192: @@
 </source>
-After a class is registered as an <code>EventHandler</code>, the <code>runEventHandler</code> methods of the registered classes are run when a given event is invoked by CKFinder. Since more plugins can be registered to handle one event type, it is important for the class to check in the method whether it should proceed. The example below shows that we need to check whether the command name equals <code>FileSize</code>. The <code>runCommand</code> method is called inside <code>runEventHandler</code> in order to invoke all other class methods and execute the command. In short, it invokes the following:
+After a class is registered as an <code>EventHandler</code>, the <code>runEventHandler</code> methods of the registered classes are run when a given event is invoked by CKFinder. Since more plugins can be registered to handle one event type, it is important for the class to check in the method whether it should proceed. The example below shows that we need to check whether the command name equals <code>FileSize</code>. The <code>runCommand</code> method is called inside <code>runEventHandler</code> in order to invoke all other class methods  (including <code>createXMLChildNodes</code> and <code>getDataForXml</code>) and execute the command. In short, it invokes the following:
 <source lang="java">
 initParams();

@@ Line 180: / Line 180: @@
 The client code expects an answer in the form of XML code (see the <code>xml.selectSingleNode( 'Connector/FileSize/@size' );</code> line from the <code>plugin.js</code> file). This means that FileResizePlugin has to return an XML response. We will use the <code>XMLCommand</code> class to achieve this purpose; extending this class in the plugin <code>FileSizeCommandClass</code> makes us implement its two methods:
-* <code>createXMLChildNodes(int errorCode, Element rootElement)</code> &ndash; this method adds all extra XML nodes to the response that will be read by a plugin on the client side. It has two parameters:
+* <code>createXMLChildNodes(int errorCode, Element rootElement)</code> &ndash; this method (described in more detail in the [[CKFinder_2.x/Developers_Guide/Java/Plugins/Writing_Java#Returning_the_XML_Response|Returning the XML Response]] section below) adds all extra XML nodes to the response that will be read by a plugin on the client side. It has two parameters:
 ** <code>errorCode</code> &ndash; an error number returned from the <code>getDataForXml</code> method;
 ** <code>rootElement</code> which represents the main XML node <code>Connector</code>.
 * <code>getDataForXml()</code> &ndash; should perform validation and execute necessary plugin tasks. If all validation checks were performed correctly and the command tasks were executed without raising an exception, this method should return the <code>CKFINDER_CONNECTOR_ERROR_NONE</code> constant.
 <source lang="java">

@@ Line 184: / Line 184: @@
 ** <code>rootElement</code> which represents the main XML node <code>Connector</code>.
 * <code>getDataForXml()</code> &ndash; should perform validation and execute necessary plugin tasks. If all validation checks were performed correctly and the command tasks were executed without raising an exception, this method should return the <code>CKFINDER_CONNECTOR_ERROR_NONE</code> constant.
 <source lang="java">

@@ Line 179: / Line 179: @@
 It is also worth mentioning that the <code>runEventHandler</code> method of a particular plugin does not have to handle the command sent from the client. As an example, it can be used to just insert something into a database or log information about the user activity.
-The client code expects an answer in the form of XML code (see the <code>xml.selectSingleNode( 'Connector/FileSize/@size' );</code> line from the <code>plugin.js</code> file). This means that FileResizePlugin has to return an XML response. We will use the <code>XMLCommand</code> class to achieve this purpose; extending this class in the plugin makes us implement its two methods:
+The client code expects an answer in the form of XML code (see the <code>xml.selectSingleNode( 'Connector/FileSize/@size' );</code> line from the <code>plugin.js</code> file). This means that FileResizePlugin has to return an XML response. We will use the <code>XMLCommand</code> class to achieve this purpose; extending this class in the plugin <code>FileSizeCommandClass</code> makes us implement its two methods:
 * <code>createXMLChildNodes(int errorCode, Element rootElement)</code> &ndash; this method adds all extra XML nodes to the response that will be read by a plugin on the client side. It has two parameters:
 ** <code>errorCode</code> &ndash; an error number returned from the <code>getDataForXml</code> method;

@@ Line 213: / Line 213: @@
 === Finding the File Name ===
-In order to find out for which file the size was requested, we have to know the file name. This information can be obtained from the request parameter, which in turn can be found in the <code>initParams</code> method of the <code>Command</code> class. This method has to be overridden in our <code>FileSizeCommand</code> class so that we could get the file name parameter. Since the <code>initParams</code> method of the <code>Command</code> class collects information about basic configuration parameters, it is necessary to call it, too. See below:
+In order to find out for which file the size was requested, we have to know the file name. This information can be obtained from the request parameter, which in turn can be found in the <code>initParams</code> method of the parent <code>Command</code> class. This method has to be overridden in our <code>FileSizeCommand</code> class so that we could get the file name parameter. Since the <code>initParams</code> method of the <code>Command</code> class collects information about basic configuration parameters, it is necessary to call it, too. See below:
 <source lang="java">
 @Override

@@ Line 148: / Line 148: @@
 These implementation classes store data gathered from the event caller that are necessary to execute the plugin command.
-The FileSizePlugin has to handle a non-standard server command, which means that the <code>BeforeExecuteCommandEventArgs</code> implementation of the <code>EventArgs</code> class will be needed for this example. This information is crucial since one of the first things we should do in the <code>runEventHandler</code> method is to cast <code>EventArgs</code> to its appropriate implementation.  See the code below:
+The FileSizePlugin has to handle a new non-standard server command, which means that the <code>BeforeExecuteCommandEventArgs</code> implementation of the <code>EventArgs</code> class will be needed for this example. This information is crucial since one of the first things we should do in the <code>runEventHandler</code> method is to cast <code>EventArgs</code> to its appropriate implementation.  See the code below:
 <source lang="java">
 public boolean runEventHandler (EventArgs args, IConfiguration configuration1)

@@ Line 323: / Line 323: @@
 </source>
-The nodes in bold are provided by the <code>XMLCommand</code> class. You can think of them as a template. Our only task here is adding the <code>FileSize</code> node. This can be achieved with the built-in CKFinder classes that help working with XML files (<code>XmlElementData</code>, <code>XmlAttribute</code>, and <code>XMLCreator</code>):
+The <code><Connector></code>, <code><Error></code> and <code><CurrentFolder></code> nodes are provided by the <code>XMLCommand</code> class. You can think of them as a template. Our only task here is adding the <code>FileSize</code> node. This can be achieved with the built-in CKFinder classes that provide XML file support (<code>XmlElementData</code>, <code>XmlAttribute</code>, and <code>XMLCreator</code>):
 <source lang="java">
 @Override
@@ Line 339: / Line 339: @@
 </source>
-The plugin is ready. In order to use it, you have to compile its classes and put them inside the <code>WEB-INF/classes/</code> folder (the correct package folder path has to be preserved). Another solution is to create a <code>.jar</code> file and put it inside the <code>WEB-INF/lib</code> folder.
+The plugin is ready. In order to use it you have to compile its classes and put them inside the <code>WEB-INF/classes/</code> folder (the correct package folder path has to be preserved). Another solution is to create a <code>.jar</code> file and put it inside the <code>WEB-INF/lib</code> folder.
 To see the full contents of the <code>FileSizeCommand</code> class, <hide target="filesizecommand_full">click here</hide>.

@@ Line 151: / Line 151: @@
 <source lang="java">
 public boolean runEventHandler (EventArgs args, IConfiguration configuration1)
-	throws ConnectorException {
+		throws ConnectorException {
-		BeforeExecuteCommandEventArgs args1 = (BeforeExecuteCommandEventArgs) args;
+	BeforeExecuteCommandEventArgs args1 = (BeforeExecuteCommandEventArgs) args;
-		return false;
+	return false;
+}
 </source>
@@ Line 204: / Line 203: @@
 public boolean runEventHandler(EventArgs args, IConfiguration configuration1)
 		throws ConnectorException {
 	BeforeExecuteCommandEventArgs args1 = (BeforeExecuteCommandEventArgs) args;
 	if ("FileSize".equals(args1.getCommand())) {
@@ Line 228: / Line 226: @@
 <source lang="java">
 public class FileSizeCommand extends XMLCommand implements IEventHandler {
 	private String fileName;
 	private long fileSize;
@@ Line 252: / Line 249: @@
 	File file = new File(configuration.getTypes().get(this.type).getPath()
 		 + this.currentFolder,
-		 this.fileName);
+		   this.fileName);
 	this.fileSize = file.length();
 	return Constants.Errors.CKFINDER_CONNECTOR_ERROR_NONE ;
@@ Line 365: / Line 362: @@
 import org.w3c.dom.Element;
-public class FileSizeCommand extends XMLCommand implements IEventHandler{
+public class FileSizeCommand extends XMLCommand implements IEventHandler {
-    private String fileName;
+	private String fileName;
 	private long fileSize;