OGSA-DAI 4.2 Jersey Technology Preview Documentation

OGSA-DAI 4.2 Jersey Technology Preview

01 December 2011

Revision History
Revision 1.01 December 2011
OGSA-DAI 4.2 Jersey Technology Preview release version

OGSA-DAI 4.2 Documentation
1. About the user doc...
2. Licence and copyright
3. Help and support
4. Release notes
5. How to upgrade to 4.2 from previous versions
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 RDF resource
45. How to deploy a resource group
46. How to deploy a remote resource
47. How to deploy a view resource
48. How to deploy a resource template
49. How to deploy a third-party data resource
50. How to undeploy a resource or resource template
51. How to deploy an activity
52. How to extend a resource's activities
53. How to configure logging
54. How to add JARs to the server
55. How to configure the server URL
56. How to add objects to the OGSA-DAI context
57. Visualising workflow execution using the trace functionality
58. How to use the OGSA-DAI request monitor
59. How to use the OGSA-DAI activity progress monitor
60. About the OGSA-DAI data source servlet
61. About the OGSA-DAI REST servlet
62. Server configuration editors
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
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
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 RDF DB query client
73. Example SPARQL EPR query client
74. Example indexed files activities client
75. Example relational data resource with asynchronous delivery client
76. Example data source retrieval client
77. How to write request documents
78. Example request document client
79. Example create DQP resource client
80. Example Workflow Visualiser Client
V. OGSA-DAI for client developers
81. How to write an OGSA-DAI client
82. Writing effective clients - what you should consider
83. Writing effective clients - using synchronous requests
84. Writing effective clients - using asynchronous requests
85. Writing effective clients - chunking arrays
86. Writing effective clients - using transforms wisely
87. Writing effective clients - using the request status for delivery
88. Writing effective clients - using FTP for delivery
89. Writing effective clients - using data sources for delivery
90. Writing effective clients - using data sinks for delivery
91. Writing effective clients - using the data source servlet for delivery
92. Writing effective clients - using the REST servlet for delivery
93. Important comments on security
94. Monitoring client-server communications with Apache Axis TCPMon
VI. OGSA-DAI for server developers
95. An introduction to writing activities
96. How to write a simple "hello world" activity with one output
97. How to write a "hello name" activity with one input and output
98. How to write a list reduction activity with one input, one list input and one output
99. How to write a list processing activity with one input, one list input and one list output
100. How to write a tuple processing activity with one input, one list input and one list output
101. How to write an activity that uses a resource provided by an activity extension interface
102. How to write a resource factory activity
103. Extending the resource factory activity
104. Activity types and choosing an activity base class
105. Passing information between activities and the activity framework using activity extension interfaces
106. How to handle errors in activities
107. How to declare activity inputs for matched activities
108. Choosing the client toolkit activity proxy base class
109. Client toolkit activity proxies and activity inputs and outputs
110. Client toolkit activity proxies and exposing data for clients
111. An introduction to writing data resources
112. How to write a data resource - case-study
113. How to support persisted resource properties
114. How to implement on-demand resource properties
115. How to implement on-demand resource properties that read their values from files
116. How to debug OGSA-DAI server components
117. How to register message bundles
118. How to log internationalized messages
119. How to log exceptions
120. How to write OGSA-DAI compliant exceptions
121. OGSA-DAI server context
122. How to use the OGSA-DAI context to share components throughout the OGSA-DAI server
123. Security contexts
124. How to use security contexts in your components
125. How to write a login provider
126. How to monitor activity inputs
127. How to transform workflows before they are executed
128. How to write a monitoring framework
129. How to write a presentation layer
H. Appendix - OGSA-DAI server APIs UML
I. Appendix - Activity development guidelines
VII. Distributed Query Processing (DQP)
130. Distributed Query Processing (DQP)
131. How DQP works
132. DQP for deployers
133. DQP for client users
134. DQP for service developers
135. DQP operators, query plans and optimisers
VIII. Appendices
J. Appendix - Default service names and URLs
K. Appendix - Default resource types, names and resource property names
L. Appendix - Core types
M. Appendix - Tuple types and SQL types
N. Appendix - Server APIs list
O. Appendix - Base 64 encoding
P. Appendix - Presentation layer-core type mappings
Q. Appendix - JavaDoc
R. Appendix - Third-party products bundled with OGSA-DAI
S. Glossary
I. OGSA-DAI 4.2 Activities Reference
II. OGSA-DAI 4.2 Scenarios and Client Examples
Index