OGSA-DAI 3.2.1 Documentation

OGSA-DAI 3.2.1 GT 4

08 December 2009

Revision History
Revision 1.28 December 2009
More DQP documentation added
Revision 1.111 November 2009
OGSA-DAI 3.2.1 release version
Revision 1.001 October 2009
OGSA-DAI 3.2 release version

OGSA-DAI 3.2.1 Documentation
1. About the user doc...
2. Release notes
3. Licence and copyright
4. Information, help and support
5. How to upgrade to 3.2.1 for OGSA-DAI 3.0, 3.1 and 3.2 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 Globus Toolkit
36. Deploy OGSA-DAI
37. Set up OGSA-DAI GT 4.0 security
38. Set up OGSA-DAI GT 4.2 security
39. Check the deployed services
40. What now?
41. How to deploy a relational resource
42. How to further configure a relational resource
43. How to deploy an XMLDB resource
44. How to add a database login for a client
45. How to remove a database login for a client
46. How to deploy a file system resource
47. How to deploy a resource group
48. How to deploy a remote resource
49. How to deploy a resource template
50. How to deploy a third-party data resource
51. How to undeploy a resource or resource template
52. How to deploy an activity
53. How to extend a resource's activities
54. How to configure logging
55. How to add JARs to the server
56. How to configure common components
57. How to add objects to the OGSA-DAI context
58. How to use the OGSA-DAI request monitor
59. How to use the OGSA-DAI activity progress monitor
60. About the OGSA-DAI servlet
61. Introducing the server editor
62. Server editor - using the common components configuration editor
63. Server editor - using the activity configuration editor
64. Server editor - using the resource configuration editor
65. Server editor - invoking from within ANT
66. How to optimise the server for performance
67. How to use the Globus MDS and Index Service for resource registration and discovery
68. How to insert MDS registration into a resource
69. How to toggle MDS registration for resource
70. How to remove MDS registration information from a resource
71. How to list and view MDS-registered resoures
72. How to specify a resource authorizer
73. How to specify a login provider
74. How to undeploy OGSA-DAI
75. 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 - Plug-in policy information points (PIPs) for OGSA-DAI GT authorization
J. Appendix - Plug-in policy decision points (PDPs) for OGSA-DAI GT authorization
K. Appendix - Globus MDS registration files
L. Appendix - Persistence and update policies
M. Appendix - Enhanced OGSA-DAI deployment options
N. Appendix - Troubleshooting, hints and tips for deployers
IV. OGSA-DAI for client users
76. Example server client
77. Example relational data resource client
78. Example relational data resource client using GT security
79. Example relational schema display client
80. Example relational schema display client using GT security
81. Example XMLDB data resource client
82. Example file system data resource client
83. Example relational data resource with asynchronous delivery client
84. Example data source retrieval client
85. How to write request documents
86. Example request document client
87. Example create DQP resource client
88. Example Workflow Visualiser Client
O. Appendix - Troubleshooting, hints and tips for client users
V. OGSA-DAI for client developers
89. How to write an OGSA-DAI client
90. How to use message level security with GSI secure conversation
91. How to use message level security with GSI secure message
92. How to use transport level security
93. Writing effective clients - what you should consider
94. Writing effective clients - using synchronous requests
95. Writing effective clients - using asynchronous requests
96. Writing effective clients - chunking arrays
97. Writing effective clients - using transforms wisely
98. Writing effective clients - using the request status for delivery
99. Writing effective clients - using FTP for delivery
100. Writing effective clients - using data sources for delivery
101. Writing effective clients - using data sinks for delivery
102. Using GFTP Extended activities
103. Using Globus Delegation Service
104. Writing effective clients - using the OGSA-DAI servlet for delivery
105. Important comments on security
106. Monitoring client-server communications with Apache Axis TCPMon
P. Appendix - Troubleshooting, hints and tips for client developers
VI. OGSA-DAI for server developers
107. An introduction to writing activities
108. How to write a simple "hello world" activity with one output
109. How to write a "hello name" activity with one input and output
110. How to write a list reduction activity with one input, one list input and one output
111. How to write a list processing activity with one input, one list input and one list output
112. How to write a tuple processing activity with one input, one list input and one list output
113. How to write an activity that uses a resource provided by an activity extension interface
114. How to write a resource factory activity
115. Extending the resource factory activity
116. Activity types and choosing an activity base class
117. Passing information between activities and the activity framework using activity extension interfaces
118. How to handle errors in activities
119. How to declare activity inputs for matched activities
120. Choosing the client toolkit activity proxy base class
121. Client toolkit activity proxies and activity inputs and outputs
122. Client toolkit activity proxies and exposing data for clients
123. An introduction to writing data resources
124. How to write a data resource - case-study
125. How to support persisted resource properties
126. How to implement on-demand resource properties
127. How to implement on-demand resource properties that read their values from files
128. How to debug OGSA-DAI server components
129. How to register message bundles
130. How to log internationalized messages
131. How to log exceptions
132. How to write OGSA-DAI compliant exceptions
133. OGSA-DAI server context
134. How to use the OGSA-DAI context to share components throughout the OGSA-DAI server
135. Security contexts
136. How to use security contexts in your components
137. How to write a login provider
138. Introduction to authorization components for OGSA-DAI GT
139. Authorization in OGSA-DAI GT and PIPs and PDPs
140. Authorization in OGSA-DAI GT and monitoring resource creation and destruction
141. Authorization in OGSA-DAI GT and runtime workflow authorization
142. OGSA-DAI GT example authorization configurations
143. How to monitor activity inputs
144. How to transform workflows before they are executed
145. How to write a monitoring framework
146. How to write a presentation layer
Q. Appendix - OGSA-DAI server APIs UML
R. Appendix - Activity development guidelines
VII. Distributed Query Processing (DQP)
147. Distributed Query Processing (DQP)
148. How DQP works
149. DQP for deployers
150. DQP for client users
151. DQP for service developers
152. DQP operators, query plans and optimisers
VIII. Appendices
S. Appendix - Default service names and URLs
T. Appendix - Default resource types, names and resource property names
U. Appendix - Data resources class list
V. Appendix - Core types
W. Appendix - Tuple types and SQL types
X. Appendix - Server APIs list
Y. Appendix - Base 64 encoding
Z. Appendix - Presentation layer-core type mappings
AA. Appendix - JavaDoc
AB. Appendix - Third-party products bundled with OGSA-DAI
AC. Appendix - Upgrading from OGSA-DAI 2.2
AD. Glossary
I. OGSA-DAI 3.2.1 Activities Reference
II. OGSA-DAI 3.2.1 Scenarios and Client Examples
Index