Changeset 1986

Timestamp:

2008-05-10 21:58:17 (3 months ago)

Author:

mosipov

Message:

Improved doc

Files:

• FCKeditor.Java/branches/2.4/src/site/apt/connector.apt (modified) (4 diffs)

FCKeditor.Java/branches/2.4/src/site/apt/connector.apt

@@ -34 +34 @@
   [[1]]  Declare the ConnectorServlet in your <<<web.xml>>>
 
-+-------------------------------------------------------------------+
++--------------------------------------------------+
   <web-app version="2.4">
     ...
@@ -53 +53 @@
     ...
   </web-app>
-+-------------------------------------------------------------------+
++--------------------------------------------------+
 
   Assuming you installed the editor in the <<</fckeditor>>> folder in your webapp.\
@@ -61 +61 @@
   [[2]] Create a <<<fckeditor.properties>>> file in your classpath and add:
 
-+-------------------------------------------------------------------+
++------------------------------------------------------------------------+
   connector.userActionImpl=net.fckeditor.requestcycle.impl.UserActionImpl
-+-------------------------------------------------------------------+
++------------------------------------------------------------------------+
 
   []
@@ -74 +74 @@
              Connector.
 
-  The basic idea of extending the Connector is to provide some interfaces for special user depended interactions,
-  which can be implemented by the developer of a webapp. All methods get the <<<HttpServletRequest>>>-object,
-  so the developer could identify the user with a session attribute for example and return a user
-  specific value. We intentionally make no suggestions how to do this, so you have the free of choice to
-  implement whatever and however you like.
+  The basic idea of extending the Connector is to provide interfaces for user-dependent
+  interactions which can be implemented by the web application developer. All
+  methods are passed the current <<<HttpServletRequest>>> instance in order to
+  retrieve request and/or session attributes and to assemble a user-specific
+  return value. We intentionally do not impose any contraints or indorse any
+  particular implementation approach to give you the freedom to implement the
+  interfaces the way it fits best in your environment.
 
-  The fully-qualified class name of the implemented classes can now be set as described in
-  {{{properties.html}Configuration settings}}.
+  Suppy the fully-qualified class names of the implemented classes as described in
+  the {{{properties.html}Configuration settings}}.
 
-  At the moment, the integration pack provides two interfaces to extend the connector:
+  Right now, the integration pack provides two interfaces to extend the Connector:
 
   [[1]] {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<net.fckeditor.requestcycle.UserPathBuilder>>>}}
 
-  In this interface there is only one method <<<getUserFilesPath(final HttpServletRequest request)>>>,
-  return value is a string. There you can implement a user dependent construction of the 'BaseDir' path,
-  the path for all resource files.
+        This interface consists only of one method <<<#getUserFilesPath(final HttpServletRequest)>>>
+        which returns a string. You are able to construct a user-dependent 
+        <<<UserFilesPath>>>, e.g. <<</userfiles/johndoe>>> if johndoe is a valid 
+        username.
 
   [[2]] {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<net.fckeditor.requestcycle.UserAction>>>}}
 
-  There are two methods to authorize users to do file based actions:
+        There are two methods to authorize users to do file-based actions:
 
-  * <<<#isEnabledForFileUpload(HttpServletRequest)>>> Enables/disables the user for uploading files.
+        * <<<#isEnabledForFileBrowsing(HttpServletRequest)>>> which returns a 
+          <<<boolean>>> denoting the user's ability to browse files on the server.
+  
+        * <<<#isEnabledForFileUpload(HttpServletRequest)>>> which returns a 
+          <<<boolean>>> denoting the user's ability to upload files to the server.
 
-  * <<<#isEnabledForFileBrowsing(HttpServletRequest)>>> Enables/disables the user for browsing files.
+        []
+
+        For those who want to enable all users to browse and upload files, there 
+        is a ready-to-use implementation <<<{{{java-core/apidocs/net/fckeditor/requestcycle/impl/UserActionImpl.html}UserActionImpl}}>>>.
 
   []
-
-  For those who wants to enable all users for browsing and uploading files, there is an implementation
-  of <<<UserAction>>> you can use: {{{java-core/apidocs/net/fckeditor/requestcycle/impl/UserActionImpl.html}UserActionImpl}}