Getting
Started Guide
Community Grids Lab,
The FIRMS software provides
an implementation of the WS-Reliability (WSR) and WS-Reliable Messaging (WSRM) specification.
The
specification for WSRM -- developed
jointly by IBM, Microsoft and BEA can be found at ftp://www6.software.ibm.com/software/developer/library/ws-reliablemessaging200403.pdf.
The specification for WS-Reliability --
developed jointly by Fujitsu, Novell, Oracle, and Sun -- can be found at http://docs.oasis-open.org/wsrm/2004/06/WS-Reliability-CD1.086.pdf. The purpose of this
document is to provide the user an entry point for the navigating the software.
Specifically this document outlines the various documents available for FIRMS within
this release, with a brief description of the contents of these documents. With
this information in hand a user may decide the best course of action to achieve
his/her desired goal. Our description of the documentation is organized based
on the directory structure of the documentation.
1.
Getting
Started:
This is the directory in
which THIS document resides. In addition to this, there are two other documents
here.
1.1
FIRMS-ReadMe
This document provides
information regarding the developers, the history, standards adopted and the
list of jar files. This document also outlines the OPEN SOURCE LICENSE that
governs the software.
1.2
FIRMS- Software Prerequisites for OMII
This document outlines the pre-requisites for
utilizing this software.
2.
Architecture:
2.1
FIRMS Conceptual Overview
This document provides a
conceptual overview of the software. We encourage users who are interested in
the over-arching principles governing the implementation of the WS-R and WS-RM
specifications to read this document.
2.2
FIRMS Functional Specification
The document provides an
in-depth view into the software. A description of the use cases and benchmarks
of several important aspects of the software have also been provided here. The
benchmarks provide the user with a feel for the costs (in terms of latencies
and memory utilizations) associated with certain operations within the
software.
Functional design considerations
related to various aspects ─ such as assumptions, pre-requisites,
deployment scale, and error handling among others ─ have also been
described. Finally, the document also provides documentation related to
individual methods for several classes within the software.
2.3
FIRMS Deployment Problems in Axis
The OMII container
leverages the Apache Axis Web Service Container. This document enumerates the
problems that exist within Axis and how we coped with these problems. We expect
that this document would be useful for developers who plan to implement support
for Web Service specifications.
3.
Installation
This directory contains
files related to the installation and deployment of the software. Our software has
been tested with version 2.3.1 & 2.3.3 of the OMII Container and when we
say container this is the version that we refer to.
3.1
FIRMS User Guide
This document outlines
how users can leverage the software to build their own applications. The
document also describes how to develop WSR and WSRM source applications. By
using this guide developers can start building their own applications.
3.2
FIRMS-Explanation of build.xml
This document provides
details regarding the various ANT commands that users can use to access
functionality available within the software.
3.3
FIRMS-Explanation of build_client.xml
This document provides
details about the commands and operations that are accessible within the
build_client.xml.
3.4
FIRMS-Explanation of build_server.xml
This document provides
details about the commands and operations that are accessible within the
build_server.xml.
3.5
FIRMS-Deployment within OMII
This document outlines
instructions related to the deployment of the WS-ReliableMessaging and
WS-Reliability software within the OMII Container.
3.6
FIRMS- Running on Different Machines within OMII
This document outlines
how one can run the WS-ReliableMessaging and WS-Reliability Services on
different machines, all of which are deployed within the OMII Container.
3.7
FIRMS-Running within FilterPipeline
This document outlines
the steps involved in running the sample example within the prototype Filter
Pipeline environment that is available as part of this release.
4.
Summary
4.1
FIRMS-Summary
This document provides a
summary of the WS-ReliableMessaging and WS-Reliability software within FIRMS
Release
5.
Support
In this directory an API
of the software is available for the user’s perusal. This API was generated
using the javadoc tool.
The
Application Programmer's Interface of the WSRM software is available for the
user’s perusal. This API was generated using the javadoc tool.
The Application Programmer's Interface of the WSRM
software is available for the user’s perusal. This API was generated using the
javadoc tool.
The Application Programmer's Interface of the WSR
software is available for the user’s perusal. This API was generated using the
javadoc tool.
The Application Programmer's Interface of the WSR
software is available for the user’s perusal. This API was generated using the
javadoc tool.
This contains an
abbreviated snapshot of the software’s capabilities. This PowerPoint file is
suitable for disseminations within the targeted user community.
This contains FIRMS tutorial
about WS-Reliable Messaging and WS-Reliability. This PowerPoint document also
explains FIRMS deployment and running within OMII container.
6.
Testing
6.1
FIRMS-Running JUnit Tests
We have leveraged JUnit
to test several of our core classes. This document describes how these tests
can run.