OGSA-DAI 3.2 Documentation

OGSA-DAI 3.2 Axis

01 October 2009

Revision History
Revision 1.001 October 2009
OGSA-DAI 3.2 release version

OGSA-DAI 3.2 Documentation
1. User doc conventions
2. Release notes
3. Licence and copyright
4. Information, help and support
5. How to upgrade to 3.2 for OGSA-DAI 3.0 and 3.1 users
I. What is OGSA-DAI?
6. The OGSA-DAI project
7. OGSA-DAI's vision
8. OGSA-DAI workflows and activities
9. An introduction to workflow execution
10. OGSA-DAI resources
11. OGSA-DAI services
12. Resources and activities revisited
13. Workflows and activity pipelines
14. How requests (workflows) are executed
15. About the request execution status
16. About the request status
17. OGSA-DAI client toolkit
18. Ways in which OGSA-DAI can be extended and customised
19. OGSA-DAI component diagram
20. OGSA-DAI server components
21. OGSA-DAI server context
22. Activity classes, IDs and names explained
23. OGSA-DAI case study - SEE-GEO
24. Inter-OGSA-DAI queries
25. Why OGSA-DAI?
A. Publications
B. Acknowledgements
II. Getting Started
26. Get OGSA-DAI
27. Get dependencies
28. Data resource products
29. Build OGSA-DAI binary from OGSA-DAI source distribution
30. Set an OGSADAI_HOME environment variable
31. Set the CLASSPATH
32. Getting started check list
III. OGSA-DAI for deployers
33. 10 minute quick start guide
34. Create test data
35. Deploy OGSA-DAI
36. Check the deployed services
37. What now?
38. How to deploy a relational resource
39. How to further configure a relational resource
40. How to deploy an XMLDB resource
41. How to add a database login for a client
42. How to remove a database login for a client
43. How to deploy a file system resource
44. How to deploy a resource group
45. How to deploy a remote resource
46. How to deploy a resource template
47. How to deploy a third-party data resource
48. How to undeploy a resource or resource template
49. How to deploy an activity
50. How to extend a resource's activities
51. How to configure logging
52. How to add JARs to the server
53. How to configure common components
54. How to add objects to the OGSA-DAI context
55. How to use the OGSA-DAI request monitor
56. How to use the OGSA-DAI activity progress monitor
57. About the OGSA-DAI servlet
58. Introducing the server editor
59. Server editor - using the common components configuration editor
60. Server editor - using the activity configuration editor
61. Server editor - using the resource configuration editor
62. Server editor - invoking from within ANT
63. How to optimise the server for performance
64. How to specify a login provider
65. How to undeploy OGSA-DAI
66. Important comments on OGSA-DAI scalability, robustness and security
C. Appendix - OGSA-DAI server configuration files
D. Appendix - Activities file
E. Appendix - Common components configuration file
F. Appendix - Logins File
G. Appendix - Resource files and resource template files
H. Appendix - OGSA-DAI context JNDI file
I. Appendix - Persistence and update policies
J. Appendix - Enhanced OGSA-DAI deployment options
K. Appendix - Troubleshooting, hints and tips for deployers
IV. OGSA-DAI for client users
67. Example server client
68. Example relational data resource client
69. Example relational schema display client
70. Example XMLDB data resource client
71. Example file system data resource client
72. Example relational data resource with asynchronous delivery client
73. Example data source retrieval client
74. How to write request documents
75. Example request document client
76. Example create DQP resource client
77. Example Workflow Visualiser Client
L. Appendix - Troubleshooting, hints and tips for client users
V. OGSA-DAI for client developers
78. How to write an OGSA-DAI client
79. Writing effective clients - what you should consider
80. Writing effective clients - using synchronous requests
81. Writing effective clients - using asynchronous requests
82. Writing effective clients - chunking arrays
83. Writing effective clients - using transforms wisely
84. Writing effective clients - using the request status for delivery
85. Writing effective clients - using FTP for delivery
86. Writing effective clients - using data sources for delivery
87. Writing effective clients - using data sinks for delivery
88. Writing effective clients - using the OGSA-DAI servlet for delivery
89. Important comments on security
90. Monitoring client-server communications with Apache Axis TCPMon
M. Appendix - Troubleshooting, hints and tips for client developers
VI. OGSA-DAI for server developers
91. An introduction to writing activities
92. How to write a simple "hello world" activity with one output
93. How to write a "hello name" activity with one input and output
94. How to write a list reduction activity with one input, one list input and one output
95. How to write a list processing activity with one input, one list input and one list output
96. How to write a tuple processing activity with one input, one list input and one list output
97. How to write an activity that uses a resource provided by an activity extension interface
98. How to write a resource factory activity
99. Extending the resource factory activity
100. Activity types and choosing an activity base class
101. Passing information between activities and the activity framework using activity extension interfaces
102. How to handle errors in activities
103. How to declare activity inputs for matched activities
104. Choosing the client toolkit activity proxy base class
105. Client toolkit activity proxies and activity inputs and outputs
106. Client toolkit activity proxies and exposing data for clients
107. An introduction to writing data resources
108. How to write a data resource - case-study
109. How to support persisted resource properties
110. How to implement on-demand resource properties
111. How to implement on-demand resource properties that read their values from files
112. How to debug OGSA-DAI server components
113. How to register message bundles
114. How to log internationalized messages
115. How to log exceptions
116. How to write OGSA-DAI compliant exceptions
117. OGSA-DAI server context
118. How to use the OGSA-DAI context to share components throughout the OGSA-DAI server
119. Security contexts
120. How to use security contexts in your components
121. How to write a login provider
122. How to monitor activity inputs
123. How to transform workflows before they are executed
124. How to write a monitoring framework
125. How to write a presentation layer
N. Appendix - OGSA-DAI server APIs UML
O. Appendix - Activity development guidelines
VII. Distributed Query Processing (DQP)
126. Distributed Query Processing (DQP)
127. How DQP works
128. DQP for deployers
129. DQP for client users
130. DQP for service developers
VIII. Appendices
P. Appendix - Default service names and URLs
Q. Appendix - Default resource types, names and resource property names
R. Appendix - Data resources class list
S. Appendix - Core types
T. Appendix - Tuple types and SQL types
U. Appendix - Server APIs list
V. Appendix - Base 64 encoding
W. Appendix - Presentation layer-core type mappings
X. Appendix - JavaDoc
Y. Appendix - Third-party products bundled with OGSA-DAI
Z. Appendix - Upgrading from OGSA-DAI 2.2
AA. Glossary
I. OGSA-DAI 3.2 Activities Reference
II. OGSA-DAI 3.2 Scenarios and Client Examples
Index