seclore-java-sdk/examples/Sample App/DMS Sample App/doc/Developer's Reference.txt

85 lines
2.9 KiB
Plaintext
Executable File

FileSecure Interfaces integration source code reference.
FS Helper Initialization
------------------------
- At application startup initializing FS Helper library
- Below classes are used for the same
- com.seclore.sample.dms.listener.ServletContextListenerImpl
- contextInitialized( ... )
- com.seclore.sample.dms.listener.SecloreWSClientConfig
- initializeWSClient( ... )
Protect File On Download
-------------------
- File download request comes form Web/portal/pages/fileList.jsp
- Below servlet is the handler for the same.
- com.seclore.sample.dms.servlet.file.DownloadFileServlet
Unprotect File on upload
------------------------
- This feature is not implemented in SampleApplication. But work flow is similar to protect method.
- There is FSHelperLibrary.unprotectX( ... ) method to unprotect the file. Refer Java-docs for more details.
Map/Unmap policy with Folder #NOTE: Not required for Fully Policy Federation
----------------------------
- Create Hot Folder using FS Helper API. Setting flag that the folder is IRM enabled.
- Enable folder as IRM request comes form Web/portal/pages/folder.jsp
- Below servlet is the handler for the same.
- com.seclore.sample.dms.servlet.folder.SaveFolderServlet
- mapSeclorePolicy( ... )
Seclore Online Integration
---------------------------------------------
- View file request comes form Web/portal/pages/fileList.jsp
- The Request can be to open the file in view mode, edit mode or Open file on Desktop Client.
- Below servlet is the handler for the same.
- com.seclore.sample.webconnect.servlet.ViewFileOnlineServlet
Access Right Implementation
---------------------------
- Access Right Adaptor (ARA) request handler which receive request from Policy Server when user open a file and return response with DMS rights.
- Below class is the implementation of REST WebService for ARA request.
- com.seclore.sample.ara.webservice.ARARequestHandler
- Method for ping request (/ping)
- handleARAPingRequest( ...)
- Method for get access right request (/getaccessright)
- handleARAGetAccessRight( ... )
- Method to get file information (/getfileinformation)
- handleARAGetFileDetails( ... )
- Developer should refer all classes available in com.seclore.sample.ara.webservice package.
Note:
=====
while preparing xml string for request or response. please escape below spacial character for the string which will be written within xml tag.
"&" -> "&"
"<" -> "&lt;"
">", -> "&gt;"
"\"" -> "&quot;"
"'" -> "&apos;";
Refer: com.seclore.sample.ara.webservice.XMLHelper class and
- escapeForXML () method
Example: sample xml is "<response><file-name>Sample Sales & purchase report.pdf</file-name><response>"
here "Sample Sales and purchase report" should be escaped.
Use: String fileName = XMLHelper.escapeForXML( "Sample Sales & purchase report" );
"<response><file-name>"+fileName+"</file-name><response>"