← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libstruts1.2-java/trusty-proposed

« back to all changes in this revision

Viewing changes to contrib/struts-chain/README.txt

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Vandyck
  • Date: 2004-11-19 15:35:25 UTC
  • Revision ID: james.westby@ubuntu.com-20041119153525-mdu08a76z4zo67xt
Tags: upstream-1.2.4
Import upstream version 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
contrib/struts-chain/README.txt
 
1
The Chain Of Responsibility Adapter README File
 
2
$Id: README.txt,v 1.2 2003/11/27 23:01:22 martinc Exp $
 
3
 
 
4
 
 
5
INTRODUCTION:
 
6
============
 
7
 
 
8
FIXME
 
9
 
 
10
 
 
11
CONTENTS OF THIS RELEASE:
 
12
========================
 
13
 
 
14
 
 
15
Top Level Directory:
 
16
-------------------
 
17
 
 
18
  LICENSE.txt       -- The Apache Software License, under which all software
 
19
                       included in this bundle is licensed.
 
20
 
 
21
  README.txt        -- This README file.
 
22
 
 
23
  build.xml         -- Ant build script (only required for building from
 
24
                       source).
 
25
 
 
26
  build.properties.sample
 
27
                    -- Sample "build.properties" file that may be customized
 
28
                       (only required for building from source).
 
29
 
 
30
 
 
31
Directory "docs":
 
32
----------------
 
33
 
 
34
  api/              -- Javadocs for the classes included in the Struts Chain
 
35
                       of Responsibility library (org.apache.struts.chain.*).
 
36
 
 
37
 
 
38
Directory "lib":
 
39
---------------
 
40
 
 
41
  struts-chain.jar  -- The compiled classes for the Chain Of Responsibility
 
42
                       adapter library.
 
43
 
 
44
 
 
45
Directory "src":
 
46
---------------
 
47
 
 
48
  conf/             -- Source files for the JAR file's manifest.
 
49
 
 
50
  example/          -- Source files for the demonstration web application.
 
51
 
 
52
  java/             -- Source files for the Chain of Responsibility library
 
53
                       classes (only required for building from source).
 
54
                       The base package is "org.apache.struts.chain".
 
55
 
 
56
 
 
57
Directory "web":
 
58
---------------
 
59
 
 
60
  example/          -- JSP and web application configuration files for the
 
61
                       demonstration web application.
 
62
 
 
63
 
 
64
Directory "webapps":
 
65
-------------------
 
66
 
 
67
  struts-chain.war  -- Executable version of the demonstration
 
68
                       web application.
 
69
 
 
70
 
 
71
RUNNING THE EXAMPLE APPLICATION:
 
72
===============================
 
73
 
 
74
The following steps are required to deploy and run the example application
 
75
(struts-chain.war) included in this distribution:
 
76
 
 
77
 
 
78
Install A Java Development Kit:
 
79
------------------------------
 
80
 
 
81
The Struts Chain Of Responsibility library requires a Java Development Kit (not
 
82
the Java Runtime Environment), version 1.3 or later.  It was tested against
 
83
Sun's JDK 1.4.2 release, available at:
 
84
 
 
85
    http://java.sun.com/j2se/
 
86
 
 
87
 
 
88
Install A Servlet/JSP Container:
 
89
-------------------------------
 
90
 
 
91
The Struts Chain Of Responsibility library requires a container that supports
 
92
Servlet 2.3 (or later) and JSP 1.2 (or later).  Any J2EE 1.3 (or later)
 
93
application server should also work.  You must acquire and install such
 
94
a container in order to execute the example application, following that
 
95
container's standard installation instructions.
 
96
 
 
97
 
 
98
Install A Struts 1.2 Nightly Release:
 
99
------------------------------------
 
100
 
 
101
The Struts Chain of Responsibility library requires a recent nightly build of
 
102
the head branch of the Struts CVS repository (i.e. the code being used for the
 
103
Struts 1.2 development track).
 
104
 
 
105
    http://jakarta.apache.org/site/binindex.cgi
 
106
 
 
107
You will want to become familiar with the operation of the standard example
 
108
web application (struts-example.war), if you are not already.
 
109
 
 
110
 
 
111
Deploy And Execute The Sample Application:
 
112
-----------------------------------------
 
113
 
 
114
Follow the standard procedures for your container to deploy a web application
 
115
that is packaged as a WAR file.  For example, you can deploy on Tomcat by
 
116
simply copying the struts-chain.war file into the "webapps"
 
117
subdirectory of your Tomcat installation, and restarting Tomcat.
 
118
 
 
119
To execute the sample application, access it with a web browser under URL to
 
120
which it was installed.  This will usually be something like:
 
121
 
 
122
    http://localhost:8080/struts-chain/
 
123
 
 
124
 
 
125
USING THE CHAIN OF RESPONSIBILITY LIBRARY IN YOUR OWN APPLICATIONS:
 
126
==================================================================
 
127
 
 
128
FIXME
 
129
 
 
130
 
 
131
BUILDING FROM SOURCE:
 
132
====================
 
133
 
 
134
If you wish, you can build the Struts Chain Of Responsibility library, and the
 
135
sample application, from the source code included in this distribution.
 
136
Follow these steps:
 
137
 
 
138
 
 
139
Install An Ant Distribution:
 
140
---------------------------
 
141
 
 
142
The provided build.xml script requires Ant, version 1.5.2 or later.  You can
 
143
get it from:
 
144
 
 
145
    http://ant.apache.org/
 
146
 
 
147
Install this environment as described in the Ant documentation, and ensure
 
148
that Ant's "bin" directory is on your PATH.
 
149
 
 
150
 
 
151
Configure Your Build Properties:
 
152
-------------------------------
 
153
 
 
154
Copy the "build.properties.sample" file in the top level directory to a file
 
155
named "build.properties", and customize the paths that are specified there.
 
156
 
 
157
 
 
158
Build The Sources:
 
159
-----------------
 
160
 
 
161
The simplest way to build is to execute:
 
162
 
 
163
    ant clean dist
 
164
 
 
165
to recreate the entire distribution in the "dist" subdirectory.  Use the
 
166
"ant -projecthelp" command to see what other targets are available.
 
167
 
 
168
 
 
169
 
 
170
KNOWN LIMITATIONS:
 
171
=================
 
172
 
 
173
FIXME