Index: /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/connector/Connector.java =================================================================== --- /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/connector/Connector.java (revision 3203) +++ /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/connector/Connector.java (revision 3204) @@ -35,8 +35,9 @@ /** - * TODO Review documentation * Interface for all Connectors.
+ * A Connector has to implement all commands described in http://docs.fckeditor.net/FCKeditor_2.x/Developers_Guide/Server_Side_Integration#The_Commands . + * To get the 'big picture', refer the javadoc at {@link ConnectorServlet}.
* The Connector will be initialized by the {@link Dispatcher}. If an error is - * happened there are well-defined exceptions which could be thrown. So the + * happened there are well-defined exceptions which must be thrown. So the * {@link Dispatcher} can react according to it.
*
@@ -46,4 +47,6 @@ * to check the basic parameters 'type' and 'currentFolder' against * null. + * + * @see ConnectorServlet * * @version $Id$ Index: /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/connector/ConnectorServlet.java =================================================================== --- /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/connector/ConnectorServlet.java (revision 3203) +++ /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/connector/ConnectorServlet.java (revision 3204) @@ -32,4 +32,5 @@ import org.slf4j.LoggerFactory; +import net.fckeditor.requestcycle.Context; import net.fckeditor.requestcycle.ThreadLocalData; import net.fckeditor.response.GetResponse; @@ -37,35 +38,38 @@ /** - * TODO Review documentation This is the FCKeditor Connector servlet. It has the - * following jobs: + * This is the main Connector servlet of the FCKeditor.
+ * Let's take a close look at the workflow of this servlet and depending classes.
+ *
+ * This is the only servlet, which has to registered in the web.xml. It is not a concrete implementation of a connector which directly + * interprets the commands of the File Browser (see: + * http://docs.fckeditor.net/FCKeditor_2.x/Developers_Guide/Server_Side_Integration#The_Commands), but it does a lot of configuration and + * delegates the requests to the depended classes.
+ * Important depending classes and its functions: + * + *
+ * In detail, for each request the following steps have to be done: * - *
- * Important: This workflow guarantees the correct initialization and - * cleaning of the {@link ThreadLocalData}, - it's essential because of - * preventing memory-leaks!
- *
- * All requests are dispatched to the {@link Dispatcher}. It's a kind of - * 'middleman', which verifies the request parameters before forwarding them to - * the corresponding method of an implementation of the {@link Connector}. - * Dependent on this verification and the method call the {@link Dispatcher} - * initializes {@link GetResponse} or {@link UploadResponse}, which is used to - * build the HttpServletResponse in - * {@link #doGet(HttpServletRequest, HttpServletResponse)} or - * {@link #doPost(HttpServletRequest, HttpServletResponse)}. + * + * @see Connector + * @see Dispatcher * * @version $Id$ @@ -73,11 +77,9 @@ public class ConnectorServlet extends HttpServlet { private static final long serialVersionUID = -5742008970929377161L; - private final Logger logger = LoggerFactory - .getLogger(ConnectorServlet.class); + private static final Logger logger = LoggerFactory.getLogger(ConnectorServlet.class); private Dispatcher dispatcher; /** * Initializes the {@link Dispatcher}. - * */ @Override @@ -94,13 +96,8 @@ * (non-Javadoc) * - * @see - * javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest - * , javax.servlet.http.HttpServletResponse) + * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest , javax.servlet.http.HttpServletResponse) */ @Override - protected void doGet(final HttpServletRequest request, - final HttpServletResponse response) throws ServletException, - IOException { - + protected void doGet(final HttpServletRequest request, final HttpServletResponse response) throws ServletException, IOException { request.setCharacterEncoding("UTF-8"); response.setCharacterEncoding("UTF-8"); @@ -109,14 +106,14 @@ PrintWriter out = response.getWriter(); GetResponse getResponse = null; - + try { ThreadLocalData.beginRequest(request); getResponse = dispatcher.doGet(request); } catch (Exception e) { - throw new ServletException(e); + throw new ServletException(e); } finally { ThreadLocalData.endRequest(); } - + out.print(getResponse); out.flush(); @@ -127,13 +124,8 @@ * (non-Javadoc) * - * @see - * javax.servlet.http.HttpServlet#doPost(javax.servlet.http.HttpServletRequest - * , javax.servlet.http.HttpServletResponse) + * @see javax.servlet.http.HttpServlet#doPost(javax.servlet.http.HttpServletRequest , javax.servlet.http.HttpServletResponse) */ @Override - protected void doPost(final HttpServletRequest request, - final HttpServletResponse response) throws ServletException, - IOException { - + protected void doPost(final HttpServletRequest request, final HttpServletResponse response) throws ServletException, IOException { request.setCharacterEncoding("UTF-8"); response.setCharacterEncoding("UTF-8"); @@ -142,14 +134,14 @@ PrintWriter out = response.getWriter(); UploadResponse uploadResponse = null; - + try { ThreadLocalData.beginRequest(request); uploadResponse = dispatcher.doPost(request); } catch (Exception e) { - throw new ServletException(e); + throw new ServletException(e); } finally { ThreadLocalData.endRequest(); } - + out.print(uploadResponse); out.flush(); Index: /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/connector/Dispatcher.java =================================================================== --- /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/connector/Dispatcher.java (revision 3203) +++ /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/connector/Dispatcher.java (revision 3204) @@ -55,13 +55,14 @@ /** - * TODO Review documentation This class is called by {@link ConnectorServlet}. - * It verifies the request parameters and forwards them to the corresponding - * {@link Connector} methods. Dependent on this verification and the method calls - * the {@link Dispatcher} initializes {@link GetResponse} or - * {@link UploadResponse}. These response objects will be used later in + * The 'man in the middle' between the {@link ConnectorServlet} and the current implementation + * of the {@link Connector}. It verifies the request parameters and forwards them to the corresponding + * {@link Connector} methods. Dependent on the verification of the request parameters and the method calls, + * {@link GetResponse} or {@link UploadResponse} will be initialized. These response objects will be used later in * {@link ConnectorServlet} to build the HttpServletResponse. If an error has - * occurred inside {@link Connector} methods, well-defined exceptions from + * occurred inside the implementation of the {@link Connector} methods, well-defined exceptions from * {@link net.fckeditor.connector.exception} will be thrown. Dependent on these * exceptions the response objects are initialized. + * + * @see ConnectorServlet * * @version $Id$ Index: /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/requestcycle/ThreadLocalData.java =================================================================== --- /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/requestcycle/ThreadLocalData.java (revision 3203) +++ /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/requestcycle/ThreadLocalData.java (revision 3204) @@ -24,5 +24,6 @@ /** - * Container for {@link ThreadLocal}s.
+ * Container for the {@link HttpServletRequest} and {@link Context}, to have static access to them + * wherever you want. Both are stored as {@link ThreadLocal}s and therefore the are bound to the current thread.
* * @version $Id$ @@ -32,4 +33,9 @@ private static ThreadLocal context = new ThreadLocal(); + /** + * Initialization of the begin of each request cycle. + * + * @param servletRequest + */ public static void beginRequest(final HttpServletRequest request) { if (request == null)