OGSA-DAI 3.1 Documentation

OGSA-DAI 3.1 Axis

5th December, 2008


OGSA-DAI 3.1 Documentation
1. User doc conventions
2. Release notes
3. Licence and copyright
4. Information, help and support
I. What is OGSA-DAI?
5. The OGSA-DAI project
6. OGSA-DAI's vision
7. OGSA-DAI workflows and activities
8. An introduction to workflow execution
9. OGSA-DAI resources
10. OGSA-DAI services
11. Resources and activities revisited
12. Workflows and activity pipelines
13. How requests (workflows) are executed
14. About the request execution status
15. About the request status
16. OGSA-DAI client toolkit
17. Ways in which OGSA-DAI can be extended and customised
18. OGSA-DAI component diagram
19. OGSA-DAI server components
20. OGSA-DAI server context
21. Activity classes, IDs and names explained
22. OGSA-DAI case study - SEE-GEO
23. Inter-OGSA-DAI queries
24. Why OGSA-DAI?
A. Publications
B. Acknowledgements
II. Getting Started
25. Get OGSA-DAI
26. Get dependencies
27. Data resource products
28. Build OGSA-DAI binary from OGSA-DAI source distribution
29. Set an OGSADAI_HOME environment variable
30. Set the CLASSPATH
31. Getting started check list
32. How to upgrade to 3.1 for OGSA-DAI 3.0 users
III. OGSA-DAI for deployers
33. 10 minute quick start guide
34. Usage statistics
35. Create test data
36. Deploy OGSA-DAI
37. Check the deployed services
38. What now?
39. How to deploy 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. About the OGSA-DAI servlet
57. How to optimise the server for performance
58. How to specify a login provider
59. How to undeploy OGSA-DAI
60. 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
61. Example server client
62. Example relational data resource client
63. Example XMLDB data resource client
64. Example file system data resource client
65. Example relational data resource with asynchronous delivery client
66. Example data source retrieval client
67. How to write request documents
68. Example request document client
L. Appendix - Troubleshooting, hints and tips for client users
V. OGSA-DAI for client developers
69. How to write an OGSA-DAI client
70. Writing effective clients - what you should consider
71. Writing effective clients - using synchronous requests
72. Writing effective clients - using asynchronous requests
73. Writing effective clients - chunking arrays
74. Writing effective clients - using transforms wisely
75. Writing effective clients - using the request status for delivery
76. Writing effective clients - using FTP for delivery
77. Writing effective clients - using data sources for delivery
78. Writing effective clients - using data sinks for delivery
79. Writing effective clients - using the OGSA-DAI servlet for delivery
80. Important comments on security
81. Monitoring client-server communications with Apache Axis TCPMon
M. Appendix - Troubleshooting, hints and tips for client developers
VI. OGSA-DAI for server developers
82. An introduction to writing activities
83. How to write a simple "hello world" activity with one output
84. How to write a "hello name" activity with one input and output
85. How to write a list reduction activity with one input, one list input and one output
86. How to write a list processing activity with one input, one list input and one list output
87. How to write a tuple processing activity with one input, one list input and one list output
88. How to write an activity that uses a resource provided by an activity extension interface
89. How to write a resource factory activity
90. Extending the resource factory activity
91. Activity types and choosing an activity base class
92. Passing information between activities and the activity framework using activity extension interfaces
93. How to handle errors in activities
94. How to declare activity inputs for matched activities
95. Choosing the client toolkit activity proxy base class
96. Client toolkit activity proxies and activity inputs and outputs
97. Client toolkit activity proxies and exposing data for clients
98. An introduction to writing data resources
99. How to write a data resource - case-study
100. How to support persisted resource properties
101. How to implement on-demand resource properties
102. How to implement on-demand resource properties that read their values from files
103. How to debug OGSA-DAI server components
104. How to register message bundles
105. How to log internationalized messages
106. How to log exceptions
107. How to write OGSA-DAI compliant exceptions
108. OGSA-DAI server context
109. How to use the OGSA-DAI context to share components throughout the OGSA-DAI server
110. Security contexts
111. How to use security contexts in your components
112. How to write a login provider
113. How to monitor activity inputs
114. How to transform workflows before they are executed
115. How to write a monitoring framework
116. How to write a presentation layer
N. Appendix - OGSA-DAI server APIs UML
O. Appendix - Activity development guidelines
VII. 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 - Server APIs list
U. Appendix - Base 64 encoding
V. Appendix - Presentation layer-core type mappings
W. Appendix - JavaDoc
X. Appendix - Third-party products bundled with OGSA-DAI
Y. Appendix - Upgrading from OGSA-DAI 2.2
Z. Glossary
I. OGSA-DAI 3.1 Activities Reference
II. OGSA-DAI 3.1 Scenarios and Client Examples
Index