ObjectSnoop
 
Inspecting objects in Java  
 

Manual for ObjectSnoop

Ian Jefferies

The documentation at the moment is incomplete, and will be fleshed out as the project progresses. There is however enough here to get you started with ObjectSnoop.

LGPL licence and trademark acknowledgement


Table of Contents

Introduction
1. Public Release 0.5 Alpha
1.1. Testing, testing, 1...2...3
2. Introduction to ObjectSnoop
3. Testing and System Requirements
1. Features of ObjectSnoop
1.1. Snooping
1.2. Output formatters
1.3. Class and interface filters
1.4. Java Server Page tag library
2. Installing ObjectSnoop
2.1. Installing for general use
2.2. Installing the JSP tag libraries
2.2.1. For an individual context
2.2.2. For the entire servlet container
2.2.2.1. Tomcat 4.0.4
3. Using ObjectSnoop in Java programs
3.1. Importing classes
3.1.1. The standard Java way
3.1.2. The quick and dirty import
3.2. Directing the snoop
3.2.1. Creating a director
3.2.2. Snooping with a director
3.2.3. A small example
3.3. Structure imposed by the formatter
3.4. Factory output: shrinkwrapped snooping
3.4.1. Creating and consuming a director
3.5. Special objects, special filtering
3.5.1. Using your own filters
3.5.2. A built in factory of filters
3.5.3. Adding to the filter factory
3.5.4. Multiple filters and execution order
3.5.5. Filter collections
4. Using ObjectSnoop in a Servlet/JSP container
4.1. Snooping within servlets
4.1.1. Example: filtered and unfiltered output
4.1.2. Servlet issues
4.1.2.1. Threading
4.1.2.2. Re-use of the director
4.1.2.3. JSP page buffering
4.2. Snooping within JSP's
4.2.1. Using scriptlets
4.2.2. Using the tag library
4.2.2.1. Implemented tags
5. Filters by class
5.1. Standard filters
5.1.1. Filter descriptions
5.2. Servlet filters
5.2.1. Filter descriptions
5.3. HttpServlet filters
5.3.1. Filter descriptions
6. Extending ObjectSnoop
7. Classes, Patterns, and relationships
A. LGPL license and trademark acknowledgement
A.1. Distributed under Lesser GNU Public License
A.2. Use of a VA Software Corporation trademark
A.3. Other trademarks
B. The Lesser GNU Public License 2.1
Revision History
Revision 0.5.0ipj
First public release, alpha status