IBM Content Manager OnDemand Web …

1 Content Manager OnDemand Web enablement Kit Java APIsThe Basics and BeyondWei-Dong ZhuMark MikealHassan A. ShazlyElliott WadeSebastian WelterDevelop Web applications by using ODWEK Java APIsGain insightful best practices, hints, and tipsTune and troubleshoot OnDemand Web applicationsFront coverIBM Content Manager OnDemand Web enablement Kit Java APIs: The Basics and BeyondDecember 2008 International Technical Support OrganizationSG24-7646-00 Copyright International Business Machines Corporation 2008. All rights to Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADPS chedule Contract with IBM Edition (December 2008)This edition applies to Version 8 Release 4 of IBM Content Manager OnDemand (program number 5724-J33). Note: Before using this information and the product it supports, read the information in Notices on page ix. Copyright IBM Corp. 2008. All rights .. ixTrademarks .. xPreface .. xiThe team that wrote this book.

2 XiiBecome a published author .. xivComments welcome .. xivPart 1. Programming with the ODWEK Java APIs .. 1 Chapter 1. ODWEK Java API overview .. Origin of the ODWEK Java APIs .. Content Manager OnDemand system overview .. Content Manager OnDemand Library Server and Object Servers .. Content Manager OnDemand data .. Content Manager OnDemand data model .. Content Manager OnDemand data indexing and loading .. ODWEK Java APIs function overview .. Typical Web applications developed by using the ODWEK Java APIs .. ODWEK Java APIs architecture .. ODWEK Java APIs components .. ODWEK Java and native shared library .. Viewers .. ODWEK Java API distribution files .. WEBi client .. 17 Chapter 2. ODWEK Java API classes .. Core API classes and their functional relationship .. Core API classes.. Functional relationship .. Server connection classes .. Content Manager OnDemand data model classes .. Search classes .. Document data retrieval classes.

3 Error handling class .. Sample console application.. Setting up a Web development environment by using Rational Application Developer .. 43iv IBM Content Manager OnDemand Web enablement Kit Java APIs: The Basics and BeyondChapter 3. ODWEK Java API examples.. Examples overview .. Example files .. Program flow and control .. Making a connection to Content Manager OnDemand .. Obtaining a list of cabinets and folders .. Displaying OnDemand folder information .. Obtaining a list of OnDemand folder search fields .. Displaying an Content Manager OnDemand search results list .. Retrieving and displaying an OnDemand document .. Viewing line data documents with the applet .. Disconnecting from OnDemand .. 88 Chapter 4. Internet use case .. Use case overview .. Connection pooling consideration for the use case.. Sample application for the use case .. 98 Part 2. Best practices, hints, and tips.. 105 Chapter 5. Introduction to best practices, hints, and tips.

4 107 Chapter 6. Connection pooling and connection handling .. Connection pooling overview .. Benefits of connection pooling .. Connection pooling objects and pooling technique .. The ODServer class .. ODWEK Java API objects and threads .. The ODWEK Java API pool levels .. A simple connection pool code example .. The pooling mechanism .. Connection pool code functions .. Connection pool code sample .. Thread safety .. Instance variables .. Synchronization.. Implementing synchronization in the ODWEK Java APIs .. Synchronizing servlet code .. Resource consumption control .. Connection initialization .. Logging off and terminating a client connection .. Allocation and release of resources and sessions .. Timeout .. Inactivity timeout .. 138 Contents Other timeouts.. Implementing an application timeout by using the () method .. Recommended timeout implementation for a Web application .. 141 Chapter 7.

5 Globalization.. Globalization overview .. Content Manager OnDemand character conversion architecture .. Index data and annotations conversions.. UTF conversion .. Document data conversions .. Code page conversion in ODWEK .. API conversions .. Browser conversions .. Document data conversions .. The ICU conversion library .. Using Unicode as the database code page.. ODWEK language configuration .. Integrating custom code pages .. Locations that require configuration .. ICU and ICONV.. Customizing code page mappings for ICU .. Globalizing applications by using ICU .. 158 Chapter 8. Folder searching.. Criteria and SQL searches .. Criteria search .. SQL search .. Sort fundamentals .. Search results .. Query and display order .. Search result size .. Searching by date .. Selecting a document from the search result list .. Callbacks .. Why use callbacks .. Searching with callbacks .. Callback search example.

6 173 Chapter 9. Document retrieval.. The importance of a retrieval strategy .. AFP documents.. Large objects versus small objects .. Requiring only a small part of a large object .. 181vi IBM Content Manager OnDemand Web enablement Kit Java APIs: The Basics and Delivering documents .. Retrieval API overview .. Retrieval APIs in the ODHit class .. AFP resource retrieval and custom caching .. Segmented retrieval and large object support.. Retrieving segmented documents.. Obtaining segment information .. Avoiding memory issues for large files .. Getting document type information .. Retrieving converted data .. Supported data conversions and viewers .. 195 Chapter 10. Applets, plug-ins, and transforms.. ODWEK plug-ins .. AFP plug-in .. Image viewer plug-in .. ODWEK Java applets .. Configuring and using the ODWEK applets .. Line data applet.. AFP2 HTML applet.. AFP2 WEB Transform .. Configuring the AFP2 WEB Transform.

7 Integrating the AFP2 WEB Transform in ODWEK .. Xenos transforms .. Configuring ODWEK to use Xenos transforms .. 211 Chapter 11. Document storing and updating.. Updating document indexes .. Use cases for the update API .. Update methods in the ODWEK Java APIs .. Hints and tips .. Storing documents .. The storeDocument() method .. How the storeDocument() method works .. Deleting documents.. 222 Chapter 12. Memory and performance .. Scope of performance tuning .. Memory .. Optimizing native memory.. Java heap .. The Java stack .. Garbage collection .. Garbage collection phases .. 231 Contents Garbage collection performance .. Startup parameters .. Supported commands and available options .. Performance and analysis commands .. Memory allocation commands .. Customizing the heap size .. Customizing the object generations .. ODWEK Java API memory usage .. Other performance areas .. Network.

8 Disk .. Processor .. Physical memory .. 250 Chapter 13. Troubleshooting .. ODWEK error reporting and trace logging .. ODException class .. Trace logging .. Analyzing the trace file .. Trace log sample.. Return codes and message IDs .. Common problems and their solutions .. Application is unresponsive or JVM out-of-memory error occurs . Application terminates with a DLL could not be found message . Performance degrades with a large number of server connections; the OnDemand server refuses network connections (Windows only) . Document retrieval is long-running .. Folder search does not produce a correct hitlist after upgrading ODWEK .. Entire document is not retrieved .. Java dump (javacore) .. IBM Thread and Monitor Dump Analyzer .. HeapAnalyzer .. HeapRoots .. Other Java diagnostic tools .. The jmap command .. The jstat command .. Heap Profiler (HPROF) .. Java Heap Analysis Tool (jhat) .. Diagnostic Tool for Java Garbage Collector.

9 Testing tools .. JUNIT .. ConTest.. 272viii IBM Content Manager OnDemand Web enablement Kit Java APIs: The Basics and Visual Performance Analyzer .. Getting support .. OnDemand User Group .. Opening a Problem Management Record.. 273 Related publications .. 275 IBM Redbooks .. 275 Other publications .. 275 Online resources .. 276 How to get Redbooks .. 277 Help from IBM .. 277 Index .. 279 Copyright IBM Corp. 2008. All rights information was developed for products and services offered in the IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead.

10 However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing, IBM Corporation, North Castle Drive, Armonk, NY 10504-1785 following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors.