OGSA-DAI 4.0 Documentation

OGSA-DAI 4.0 Axis

09 April 2010

Revision History
Revision 1.009 April 2010
OGSA-DAI 4.0 release version

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