Changeset 1914 for FCKeditor.Java/branches/2.4/src/site/apt/integration/connector.apt

Timestamp:

2008-04-13 19:36:32 (6 months ago)

Author:

th-schwarz

Message:

added requestcycle stuff

Files:

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

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

@@ -62 +62 @@
 
 +-------------------------------------------------------------------+
-  connector.sessionDataImpl=net.fckeditor.impl.BasicSessionData
+  connector.userActionImpl=net.fckeditor.requestcycle.impl.UserActionImpl
 +-------------------------------------------------------------------+
 
@@ -74 +74 @@
              Connector.
 
-  ...
+  The basic idea of extending the Connector is to provide interfaces for special user depended issues,
+  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 an 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 fully-qualified class name of the implemented classes can now be set as described in 
+  {{{fckeditor-properties.html}Configuration settings}}.
+  
+  At the moment, the integration pack provides two interfaces to extend the connector:
+  
+  [[1]] {{{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. 
+  
+  [[2]] {{{apidocs/net/fckeditor/requestcycle/UserAction.html}<<<net.fckeditor.requestcycle.UserAction>>>}}
+  
+  There are two methods to authorize users to do file based actions:
+  
+  * <<<#isEnabledForFileUpload(HttpServletRequest)>>> Enables/disables the user for uploading files.
+  
+  * <<<#isEnabledForFileBrowsing(HttpServletRequest)>>> Enables/disables the user for browsing files.
+  
+  []
+  
+  For those who wants to enable all users for browsing and uploading files, there is an implementation
+  of <<<UserAction>>> you can use: {{{apidocs/net/fckeditor/requestcycle/impl/UserActionImp.html}UserActionImpl}}