Documentation Roadmap and Overview
Purpose and Scope of the SAD
This wiki describes the architecture of the Java Pet Store v1.4 application, which is part of the BluePrints program by Sun Microsystems. The Pet Store is a J2EE application that contains 284 Java source files (with over 16000 logical lines of code) and 180 JSP files. A complete description of the Pet Store application is found in the referenced materials
Information is organized following a template we defined for a wiki-based Software Architecture Document. That template itself is based on a Word-based template developed at the Software Engineering Institute.
The architecture described here was reconstructed from the implementation artifacts of the Java Pet Store, as well as documents that describe the design.
The software architecture for a system is the structure or structures of that system, which comprise software elements, the externally-visible properties of those elements, and the relationships among them (Bass 2012). Each structure is documented as an architectural view.
How the SAD Is Organized
This SAD is organized into the following sections:
- This Documentation Roadmap and Overview provides information about this document and its intended audience. It provides the roadmap and document overview.
- Architecture Background provides information about the software architecture. It describes the background and rationale for the software architecture. It explains the constraints and influences that led to the current architecture, and it describes the major architectural approaches that have been utilized in the architecture.
- Views constitute the most important part of the document. Each view describe a different structure of the system.
- Mapping Between Views specify how elements in one view maps to elements in another view.
- Referenced Materials provides look-up information for documents that are cited elsewhere in this SAD.
- Glossary and Acronyms has definitions of technical terms used in the documentation that may not be familiar to all readers.