copland 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- data/doc/README +88 -0
- data/doc/manual-html/chapter-1.html +454 -0
- data/doc/manual-html/chapter-10.html +399 -0
- data/doc/manual-html/chapter-11.html +600 -0
- data/doc/manual-html/chapter-12.html +406 -0
- data/doc/manual-html/chapter-2.html +382 -0
- data/doc/manual-html/chapter-3.html +424 -0
- data/doc/manual-html/chapter-4.html +432 -0
- data/doc/manual-html/chapter-5.html +381 -0
- data/doc/manual-html/chapter-6.html +364 -0
- data/doc/manual-html/chapter-7.html +434 -0
- data/doc/manual-html/chapter-8.html +373 -0
- data/doc/manual-html/chapter-9.html +324 -0
- data/doc/manual-html/copland.png +0 -0
- data/doc/manual-html/index.html +331 -0
- data/doc/manual-html/manual.css +179 -0
- data/doc/manual-html/tutorial-1.html +407 -0
- data/doc/manual-html/tutorial-2.html +451 -0
- data/doc/manual-html/tutorial-3.html +484 -0
- data/doc/manual-html/tutorial-4.html +446 -0
- data/doc/manual-html/tutorial-5.html +520 -0
- data/doc/manual/chapter.erb +18 -0
- data/doc/manual/example.erb +18 -0
- data/doc/manual/img/copland.png +0 -0
- data/doc/manual/index.erb +30 -0
- data/doc/manual/manual.css +179 -0
- data/doc/manual/manual.rb +239 -0
- data/doc/manual/manual.yml +2643 -0
- data/doc/manual/page.erb +102 -0
- data/doc/manual/tutorial.erb +30 -0
- data/doc/packages/copland.html +764 -0
- data/doc/packages/copland.lib.html +439 -0
- data/doc/packages/copland.remote.html +2096 -0
- data/doc/packages/copland.webrick.html +925 -0
- data/doc/packages/index.html +49 -0
- data/doc/packages/packrat.css +125 -0
- data/examples/calc/calc.rb +47 -0
- data/examples/calc/package.yml +35 -0
- data/examples/calc/services.rb +74 -0
- data/examples/solitaire-cipher/README +11 -0
- data/examples/solitaire-cipher/Rakefile +57 -0
- data/examples/solitaire-cipher/bin/main.rb +14 -0
- data/examples/solitaire-cipher/lib/cipher.rb +230 -0
- data/examples/solitaire-cipher/lib/cli.rb +24 -0
- data/examples/solitaire-cipher/lib/package.yml +106 -0
- data/examples/solitaire-cipher/test/tc_deck.rb +30 -0
- data/examples/solitaire-cipher/test/tc_key-stream.rb +19 -0
- data/examples/solitaire-cipher/test/tc_keying-algorithms.rb +31 -0
- data/examples/solitaire-cipher/test/tc_solitaire-cipher.rb +66 -0
- data/examples/solitaire-cipher/test/tc_unkeyed-algorithm.rb +17 -0
- data/examples/solitaire-cipher/test/tests.rb +2 -0
- data/lib/copland.rb +56 -0
- data/lib/copland/class-factory.rb +95 -0
- data/lib/copland/configuration-point.rb +38 -0
- data/lib/copland/configuration-point/common.rb +203 -0
- data/lib/copland/configuration-point/errors.rb +44 -0
- data/lib/copland/configuration-point/list.rb +59 -0
- data/lib/copland/configuration-point/map.rb +59 -0
- data/lib/copland/configuration/errors.rb +43 -0
- data/lib/copland/configuration/loader.rb +113 -0
- data/lib/copland/configuration/yaml/configuration-point.rb +87 -0
- data/lib/copland/configuration/yaml/implementor.rb +134 -0
- data/lib/copland/configuration/yaml/interceptor.rb +63 -0
- data/lib/copland/configuration/yaml/listener.rb +56 -0
- data/lib/copland/configuration/yaml/loader.rb +122 -0
- data/lib/copland/configuration/yaml/package.rb +125 -0
- data/lib/copland/configuration/yaml/parser.rb +71 -0
- data/lib/copland/configuration/yaml/schema.rb +165 -0
- data/lib/copland/configuration/yaml/service-point.rb +116 -0
- data/lib/copland/configuration/yaml/utils.rb +82 -0
- data/lib/copland/default-schema-processor.rb +144 -0
- data/lib/copland/errors.rb +82 -0
- data/lib/copland/event-producer.rb +95 -0
- data/lib/copland/impl/builder-factory.rb +112 -0
- data/lib/copland/impl/copland-config.yml +1 -0
- data/lib/copland/impl/include-exclude.rb +140 -0
- data/lib/copland/impl/logging-interceptor.rb +106 -0
- data/lib/copland/impl/package.yml +217 -0
- data/lib/copland/impl/startup.rb +116 -0
- data/lib/copland/impl/symbol-source-manager.rb +131 -0
- data/lib/copland/impl/symbol-source.rb +63 -0
- data/lib/copland/instantiator.rb +38 -0
- data/lib/copland/instantiator/abstract.rb +91 -0
- data/lib/copland/instantiator/complex.rb +96 -0
- data/lib/copland/instantiator/identity.rb +58 -0
- data/lib/copland/instantiator/simple.rb +68 -0
- data/lib/copland/interceptor-chain.rb +166 -0
- data/lib/copland/interceptor.rb +139 -0
- data/lib/copland/log-factory.rb +206 -0
- data/lib/copland/models.rb +39 -0
- data/lib/copland/models/abstract.rb +78 -0
- data/lib/copland/models/prototype-deferred.rb +58 -0
- data/lib/copland/models/prototype.rb +58 -0
- data/lib/copland/models/proxy.rb +100 -0
- data/lib/copland/models/singleton-deferred.rb +59 -0
- data/lib/copland/models/singleton.rb +77 -0
- data/lib/copland/models/threaded.rb +65 -0
- data/lib/copland/ordering.rb +123 -0
- data/lib/copland/package.rb +246 -0
- data/lib/copland/registry.rb +368 -0
- data/lib/copland/schema.rb +206 -0
- data/lib/copland/service-point.rb +282 -0
- data/lib/copland/utils.rb +221 -0
- data/lib/copland/version.rb +47 -0
- data/test/conf-test/list-bad-key.yml +30 -0
- data/test/conf-test/list-bad-missing.yml +28 -0
- data/test/conf-test/list-bad-type.yml +28 -0
- data/test/conf-test/list-good.yml +29 -0
- data/test/conf-test/map-bad-key.yml +25 -0
- data/test/conf-test/map-bad-missing.yml +24 -0
- data/test/conf-test/map-bad-type.yml +23 -0
- data/test/conf-test/map-good.yml +25 -0
- data/test/configuration-point/package.yml +52 -0
- data/test/configuration/yaml/config/copland-config.yml +2 -0
- data/test/configuration/yaml/config/module.yml +2 -0
- data/test/configuration/yaml/config/subdir/copland-config.yml +2 -0
- data/test/configuration/yaml/config/subdir/package.yml +4 -0
- data/test/configuration/yaml/defaults/package.yml +5 -0
- data/test/configuration/yaml/defaults/subdir/package.yml +4 -0
- data/test/configuration/yaml/tc_config-loader.rb +86 -0
- data/test/configuration/yaml/tc_configuration-point-processor.rb +134 -0
- data/test/configuration/yaml/tc_implementor-processor.rb +104 -0
- data/test/configuration/yaml/tc_interceptor-processor.rb +85 -0
- data/test/configuration/yaml/tc_listener-processor.rb +69 -0
- data/test/configuration/yaml/tc_loader.rb +74 -0
- data/test/configuration/yaml/tc_package-processor.rb +120 -0
- data/test/configuration/yaml/tc_parser.rb +94 -0
- data/test/configuration/yaml/tc_schema-parser.rb +160 -0
- data/test/configuration/yaml/tc_service-point-processor.rb +104 -0
- data/test/configuration/yaml/tc_type-validator.rb +90 -0
- data/test/custom-logger.yml +3 -0
- data/test/impl/logging/package.yml +44 -0
- data/test/impl/logging/services.rb +84 -0
- data/test/impl/startup/package.yml +46 -0
- data/test/impl/startup/services.rb +47 -0
- data/test/impl/symbols/package.yml +24 -0
- data/test/impl/symbols/services.rb +38 -0
- data/test/impl/tc_builder-factory.rb +173 -0
- data/test/impl/tc_logging-interceptor.rb +148 -0
- data/test/impl/tc_startup.rb +59 -0
- data/test/impl/tc_symbol-sources.rb +61 -0
- data/test/logger.yml +6 -0
- data/test/mock.rb +201 -0
- data/test/schema/bad-package.yml +65 -0
- data/test/schema/package.yml +102 -0
- data/test/schema/services.rb +5 -0
- data/test/services/package.yml +79 -0
- data/test/services/simple.rb +87 -0
- data/test/tc_class-factory.rb +93 -0
- data/test/tc_complex-instantiator.rb +107 -0
- data/test/tc_configuration-point-contrib.rb +74 -0
- data/test/tc_configuration-point-schema.rb +122 -0
- data/test/tc_configuration-point.rb +91 -0
- data/test/tc_default-schema-processor.rb +297 -0
- data/test/tc_identity-instantiator.rb +61 -0
- data/test/tc_interceptors.rb +84 -0
- data/test/tc_logger.rb +131 -0
- data/test/tc_models.rb +176 -0
- data/test/tc_package.rb +165 -0
- data/test/tc_proxy.rb +65 -0
- data/test/tc_registry.rb +141 -0
- data/test/tc_schema.rb +78 -0
- data/test/tc_service-point.rb +178 -0
- data/test/tc_service.rb +70 -0
- data/test/tc_simple-instantiator.rb +61 -0
- data/test/tests.rb +93 -0
- data/tutorial/01/main.rb +7 -0
- data/tutorial/01/package.yml +8 -0
- data/tutorial/01/tutorial.rb +7 -0
- data/tutorial/02/main.rb +10 -0
- data/tutorial/02/package.yml +27 -0
- data/tutorial/02/tutorial.rb +46 -0
- data/tutorial/03/main.rb +24 -0
- data/tutorial/03/package.yml +29 -0
- data/tutorial/03/tutorial.rb +48 -0
- data/tutorial/04/main.rb +24 -0
- data/tutorial/04/package.yml +35 -0
- data/tutorial/04/tutorial.rb +48 -0
- data/tutorial/05/functions/package.yml +16 -0
- data/tutorial/05/functions/services.rb +15 -0
- data/tutorial/05/main.rb +10 -0
- data/tutorial/05/package.yml +35 -0
- data/tutorial/05/tutorial.rb +53 -0
- metadata +260 -0
|
@@ -0,0 +1,925 @@
|
|
|
1
|
+
<html>
|
|
2
|
+
<head>
|
|
3
|
+
<title>copland.webrick</title>
|
|
4
|
+
<link rel="stylesheet" type="text/css" href="packrat.css" />
|
|
5
|
+
</head>
|
|
6
|
+
<body>
|
|
7
|
+
<h1>copland.webrick</h1>
|
|
8
|
+
|
|
9
|
+
<!-- INDEX OF PACKAGE CONTENTS -->
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<div class="description">
|
|
13
|
+
Various Copland services related to dealing with WEBrick servers and servlets.
|
|
14
|
+
</div>
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
<div class="nav">
|
|
18
|
+
Return to
|
|
19
|
+
|
|
20
|
+
<a href="index.html">index</a>
|
|
21
|
+
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
<h3>Service Points</h3>
|
|
26
|
+
<ul>
|
|
27
|
+
|
|
28
|
+
<li><a href="copland.webrick.html#DefaultHTTPServer_sp">DefaultHTTPServer</a></li>
|
|
29
|
+
|
|
30
|
+
<li><a href="copland.webrick.html#DefaultHandler_sp">DefaultHandler</a></li>
|
|
31
|
+
|
|
32
|
+
<li><a href="copland.webrick.html#HTTPServerFactory_sp">HTTPServerFactory</a></li>
|
|
33
|
+
|
|
34
|
+
<li><a href="copland.webrick.html#ResultHandlers_sp">ResultHandlers</a></li>
|
|
35
|
+
|
|
36
|
+
<li><a href="copland.webrick.html#WWWRPCServletFactory_sp">WWWRPCServletFactory</a></li>
|
|
37
|
+
|
|
38
|
+
</ul>
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<h3>Configuration Points</h3>
|
|
43
|
+
<ul>
|
|
44
|
+
|
|
45
|
+
<li><a href="copland.webrick.html#DefaultHTTPServerConfiguration_cp">DefaultHTTPServerConfiguration</a></li>
|
|
46
|
+
|
|
47
|
+
<li><a href="copland.webrick.html#DefaultServletList_cp">DefaultServletList</a></li>
|
|
48
|
+
|
|
49
|
+
<li><a href="copland.webrick.html#ResultHandlers_cp">ResultHandlers</a></li>
|
|
50
|
+
|
|
51
|
+
</ul>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<h3>Schemas</h3>
|
|
56
|
+
<ul>
|
|
57
|
+
|
|
58
|
+
<li><a href="copland.webrick.html#HTTPServerConfiguration_scm">HTTPServerConfiguration</a></li>
|
|
59
|
+
|
|
60
|
+
<li><a href="copland.webrick.html#ServletList_scm">ServletList</a></li>
|
|
61
|
+
|
|
62
|
+
</ul>
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
<!-- SERVICE POINTS -->
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
<h2>Service Points</h2>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
<h3><a name="DefaultHTTPServer_sp">DefaultHTTPServer</a> <small><em>(singleton)</em></small></h3>
|
|
72
|
+
|
|
73
|
+
<div class="item-body">
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<p class="description">
|
|
77
|
+
A default HTTP server. This may configured via the DefaultHTTPServerConfiguration and DefaultServletList configuration points. This allows applications that only need a single WEBrick server to more easily set up that server. Applications that need multiple servers will need to define multiple service points themselves.
|
|
78
|
+
</p>
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
<h4>Implementor</h4>
|
|
82
|
+
<div class="definition-item">
|
|
83
|
+
|
|
84
|
+
<ul>
|
|
85
|
+
<li>factory: <a href="copland.webrick.html#HTTPServerFactory_sp">copland.webrick.HTTPServerFactory</a></li>
|
|
86
|
+
|
|
87
|
+
<li>setup: !!configuration <a href="copland.webrick.html#DefaultHTTPServerConfiguration_cp">copland.webrick.DefaultHTTPServerConfiguration</a></li><li>servlets: !!configuration <a href="copland.webrick.html#DefaultServletList_cp">copland.webrick.DefaultServletList</a></li>
|
|
88
|
+
|
|
89
|
+
</ul>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
</div>
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<h3><a name="DefaultHandler_sp">DefaultHandler</a> <small><em>(singleton-deferred)</em></small></h3>
|
|
103
|
+
|
|
104
|
+
<div class="item-body">
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
<p class="description">
|
|
108
|
+
An implementation of a default data handler, handling some of the more common data types returned by services.
|
|
109
|
+
</p>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<h4>Implementor</h4>
|
|
113
|
+
<div class="definition-item">
|
|
114
|
+
|
|
115
|
+
copland/webrick/default-handler/Copland::WEBrick::DefaultHandler
|
|
116
|
+
|
|
117
|
+
</div>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<h3><a name="HTTPServerFactory_sp">HTTPServerFactory</a> <small><em>(singleton)</em></small></h3>
|
|
129
|
+
|
|
130
|
+
<div class="item-body">
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<p class="description">
|
|
134
|
+
A service factory for creating new WEBrick HTTP servers.
|
|
135
|
+
</p>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
<h4>Implementor</h4>
|
|
139
|
+
<div class="definition-item">
|
|
140
|
+
|
|
141
|
+
copland/webrick/http-server-factory/Copland::WEBrick::HTTPServerFactory
|
|
142
|
+
|
|
143
|
+
</div>
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<h4>Schema</h4>
|
|
147
|
+
<div class="definition-item">
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<div class="schema-item">
|
|
156
|
+
|
|
157
|
+
<div class="subschema-name">
|
|
158
|
+
servlets
|
|
159
|
+
[configuration]
|
|
160
|
+
<em>(required)</em>
|
|
161
|
+
</div>
|
|
162
|
+
<div class="subschema">
|
|
163
|
+
|
|
164
|
+
<div class="description">
|
|
165
|
+
The configuration point containing the list of servlets that should be added to this server. The configuration should conform to the ServletList schema.
|
|
166
|
+
</div>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
</div>
|
|
176
|
+
<div class="subschema-name">
|
|
177
|
+
setup
|
|
178
|
+
[configuration]
|
|
179
|
+
<em>(required)</em>
|
|
180
|
+
</div>
|
|
181
|
+
<div class="subschema">
|
|
182
|
+
|
|
183
|
+
<div class="description">
|
|
184
|
+
The configuration point containing the setup information for the new server. The configuration should conform to the HTTPServerConfiguration schema.
|
|
185
|
+
</div>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
</div>
|
|
195
|
+
</div>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
</div>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<h3><a name="ResultHandlers_sp">ResultHandlers</a> <small><em>(singleton-deferred)</em></small></h3>
|
|
209
|
+
|
|
210
|
+
<div class="item-body">
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
<p class="description">
|
|
214
|
+
A collection of ResultHandlers (taken from the ResultHandlers configuration point). This service allows those handlers to be invoked via a single interface.
|
|
215
|
+
</p>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<h4>Implementor</h4>
|
|
219
|
+
<div class="definition-item">
|
|
220
|
+
|
|
221
|
+
<ul>
|
|
222
|
+
<li>factory: <a href="copland.html#BuilderFactory_sp">copland.BuilderFactory</a></li>
|
|
223
|
+
|
|
224
|
+
<li>class: copland/webrick/result-handlers/Copland::WEBrick::ResultHandlers</li><li>parameters: <ul><li>!!configuration <a href="copland.webrick.html#ResultHandlers_cp">copland.webrick.ResultHandlers</a></li></ul></li>
|
|
225
|
+
|
|
226
|
+
</ul>
|
|
227
|
+
|
|
228
|
+
</div>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
</div>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<h3><a name="WWWRPCServletFactory_sp">WWWRPCServletFactory</a> <small><em>(singleton)</em></small></h3>
|
|
240
|
+
|
|
241
|
+
<div class="item-body">
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<p class="description">
|
|
245
|
+
A service factory for creating new servlets that wrap existing services, and which export certain methods of those services for invocation via HTTP.
|
|
246
|
+
</p>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<h4>Implementor</h4>
|
|
250
|
+
<div class="definition-item">
|
|
251
|
+
|
|
252
|
+
<ul>
|
|
253
|
+
<li>factory: <a href="copland.html#BuilderFactory_sp">copland.BuilderFactory</a></li>
|
|
254
|
+
|
|
255
|
+
<li>class: copland/webrick/www-rpc-servlet-factory/Copland::WEBrick::WWWRPCServletFactory</li><li>properties: <ul><li>handlers: !!service <a href="copland.webrick.html#ResultHandlers_sp">copland.webrick.ResultHandlers</a></li></ul></li>
|
|
256
|
+
|
|
257
|
+
</ul>
|
|
258
|
+
|
|
259
|
+
</div>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
<h4>Schema</h4>
|
|
263
|
+
<div class="definition-item">
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
<div class="schema-item">
|
|
272
|
+
|
|
273
|
+
<div class="subschema-name">
|
|
274
|
+
interface
|
|
275
|
+
[array]
|
|
276
|
+
<em>(required)</em>
|
|
277
|
+
</div>
|
|
278
|
+
<div class="subschema">
|
|
279
|
+
|
|
280
|
+
<div class="description">
|
|
281
|
+
A list of methods exported by this service.
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<div class="schema-item">
|
|
291
|
+
|
|
292
|
+
<div class="subschema-name">
|
|
293
|
+
method
|
|
294
|
+
[string]
|
|
295
|
+
<em>(required)</em>
|
|
296
|
+
</div>
|
|
297
|
+
<div class="subschema">
|
|
298
|
+
|
|
299
|
+
<div class="description">
|
|
300
|
+
The name of the method on the service.
|
|
301
|
+
</div>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</div>
|
|
311
|
+
<div class="subschema-name">
|
|
312
|
+
alias
|
|
313
|
+
[string]
|
|
314
|
+
|
|
315
|
+
</div>
|
|
316
|
+
<div class="subschema">
|
|
317
|
+
|
|
318
|
+
<div class="description">
|
|
319
|
+
The name by which the method should be exported.
|
|
320
|
+
</div>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
</div>
|
|
330
|
+
<div class="subschema-name">
|
|
331
|
+
help
|
|
332
|
+
[string]
|
|
333
|
+
|
|
334
|
+
</div>
|
|
335
|
+
<div class="subschema">
|
|
336
|
+
|
|
337
|
+
<div class="description">
|
|
338
|
+
Arbitrary text describing this method.
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
</div>
|
|
349
|
+
<div class="subschema-name">
|
|
350
|
+
parameters
|
|
351
|
+
[array]
|
|
352
|
+
|
|
353
|
+
</div>
|
|
354
|
+
<div class="subschema">
|
|
355
|
+
|
|
356
|
+
<div class="description">
|
|
357
|
+
The array of parameter names recognized by this interface, in the order in which they should be sent to the method.
|
|
358
|
+
</div>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
</div>
|
|
368
|
+
</div>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
</div>
|
|
372
|
+
<div class="subschema-name">
|
|
373
|
+
service
|
|
374
|
+
[service]
|
|
375
|
+
<em>(required)</em>
|
|
376
|
+
</div>
|
|
377
|
+
<div class="subschema">
|
|
378
|
+
|
|
379
|
+
<div class="description">
|
|
380
|
+
The service to make available via the servlet.
|
|
381
|
+
</div>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
</div>
|
|
391
|
+
</div>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
</div>
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
</div>
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
<!-- CONFIGURATION POINTS -->
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<h2>Configuration Points</h2>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
<h3><a name="DefaultHTTPServerConfiguration_cp">DefaultHTTPServerConfiguration</a> <small><em>(map)</em></small></h3>
|
|
413
|
+
|
|
414
|
+
<div class="item-body">
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
<p class="description">
|
|
418
|
+
This is the default point for configurating a WEBrick server. Applications may define their own configuration points and reuse the schema this point defines.
|
|
419
|
+
</p>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<h4>Schema</h4>
|
|
424
|
+
<div class="definition-item">
|
|
425
|
+
<a href="copland.webrick.html#HTTPServerConfiguration_scm">copland.webrick.HTTPServerConfiguration</a>
|
|
426
|
+
</div>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
</div>
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
<h3><a name="DefaultServletList_cp">DefaultServletList</a> <small><em>(list)</em></small></h3>
|
|
433
|
+
|
|
434
|
+
<div class="item-body">
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
<p class="description">
|
|
438
|
+
The list of servlets that should be added to a WEBrick server. This is the default configuration point. Applications may define their own and reuse the shema this point defines.
|
|
439
|
+
</p>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<h4>Schema</h4>
|
|
444
|
+
<div class="definition-item">
|
|
445
|
+
<a href="copland.webrick.html#ServletList_scm">copland.webrick.ServletList</a>
|
|
446
|
+
</div>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
</div>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<h3><a name="ResultHandlers_cp">ResultHandlers</a> <small><em>(list)</em></small></h3>
|
|
453
|
+
|
|
454
|
+
<div class="item-body">
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<p class="description">
|
|
458
|
+
This configuration point contains all of the result handler services that will be used by the ResultHandlers service to handle data returned by RPC services. Applications may define their own handler services and contribute them to this configuration point.
|
|
459
|
+
</p>
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
<h4>Schema</h4>
|
|
464
|
+
<div class="definition-item">
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
<div class="schema-item">
|
|
473
|
+
|
|
474
|
+
<div class="subschema-name">
|
|
475
|
+
service
|
|
476
|
+
[service]
|
|
477
|
+
<em>(required)</em>
|
|
478
|
+
</div>
|
|
479
|
+
<div class="subschema">
|
|
480
|
+
|
|
481
|
+
<div class="description">
|
|
482
|
+
The service to contribute. It must implement at least one method, "handle", which should accept three parameters: the data to handle, the HTTP request object, and the HTTP response object.
|
|
483
|
+
</div>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
</div>
|
|
493
|
+
<div class="subschema-name">
|
|
494
|
+
after
|
|
495
|
+
[array]
|
|
496
|
+
|
|
497
|
+
</div>
|
|
498
|
+
<div class="subschema">
|
|
499
|
+
|
|
500
|
+
<div class="description">
|
|
501
|
+
A list of handler names that this service should always be tried after.
|
|
502
|
+
</div>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
</div>
|
|
512
|
+
<div class="subschema-name">
|
|
513
|
+
before
|
|
514
|
+
[array]
|
|
515
|
+
|
|
516
|
+
</div>
|
|
517
|
+
<div class="subschema">
|
|
518
|
+
|
|
519
|
+
<div class="description">
|
|
520
|
+
A list of handler names that this service should always be tried before.
|
|
521
|
+
</div>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
</div>
|
|
531
|
+
<div class="subschema-name">
|
|
532
|
+
name
|
|
533
|
+
[string]
|
|
534
|
+
|
|
535
|
+
</div>
|
|
536
|
+
<div class="subschema">
|
|
537
|
+
|
|
538
|
+
<div class="description">
|
|
539
|
+
An optional name to assign this handler. This allows the handler to be referenced in other handlers' before and after lists.
|
|
540
|
+
</div>
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</div>
|
|
550
|
+
</div>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
</div>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
</div>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
<!-- SCHEMAS -->
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
<h2>Schemas</h2>
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
<h3><a name="HTTPServerConfiguration_scm">HTTPServerConfiguration</a></h3>
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
<div class="item-body">
|
|
572
|
+
<div class="definition-item">
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
<div class="schema-item">
|
|
581
|
+
|
|
582
|
+
<div class="subschema-name">
|
|
583
|
+
server.port
|
|
584
|
+
[integer]
|
|
585
|
+
<em>(required)</em>
|
|
586
|
+
</div>
|
|
587
|
+
<div class="subschema">
|
|
588
|
+
|
|
589
|
+
<div class="description">
|
|
590
|
+
the port that the server should listen to.
|
|
591
|
+
</div>
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</div>
|
|
601
|
+
<div class="subschema-name">
|
|
602
|
+
directory.index
|
|
603
|
+
[array]
|
|
604
|
+
|
|
605
|
+
</div>
|
|
606
|
+
<div class="subschema">
|
|
607
|
+
|
|
608
|
+
<div class="description">
|
|
609
|
+
the list of index files in the order that they should be attempted.
|
|
610
|
+
</div>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
</div>
|
|
620
|
+
<div class="subschema-name">
|
|
621
|
+
directory.indexing.fancy
|
|
622
|
+
[boolean]
|
|
623
|
+
|
|
624
|
+
</div>
|
|
625
|
+
<div class="subschema">
|
|
626
|
+
|
|
627
|
+
<div class="description">
|
|
628
|
+
whether or not to use fancy indexing.
|
|
629
|
+
</div>
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
</div>
|
|
639
|
+
<div class="subschema-name">
|
|
640
|
+
document.root
|
|
641
|
+
[string]
|
|
642
|
+
|
|
643
|
+
</div>
|
|
644
|
+
<div class="subschema">
|
|
645
|
+
|
|
646
|
+
<div class="description">
|
|
647
|
+
the document root of the server.
|
|
648
|
+
</div>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
</div>
|
|
658
|
+
<div class="subschema-name">
|
|
659
|
+
max.clients
|
|
660
|
+
[integer]
|
|
661
|
+
|
|
662
|
+
</div>
|
|
663
|
+
<div class="subschema">
|
|
664
|
+
|
|
665
|
+
<div class="description">
|
|
666
|
+
the maximum number of concurrent connections.
|
|
667
|
+
</div>
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
</div>
|
|
677
|
+
<div class="subschema-name">
|
|
678
|
+
request.timeout
|
|
679
|
+
[integer]
|
|
680
|
+
|
|
681
|
+
</div>
|
|
682
|
+
<div class="subschema">
|
|
683
|
+
|
|
684
|
+
<div class="description">
|
|
685
|
+
seconds until a request times out.
|
|
686
|
+
</div>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
</div>
|
|
696
|
+
<div class="subschema-name">
|
|
697
|
+
server.auto.start
|
|
698
|
+
[boolean]
|
|
699
|
+
|
|
700
|
+
</div>
|
|
701
|
+
<div class="subschema">
|
|
702
|
+
|
|
703
|
+
<div class="description">
|
|
704
|
+
whether or not the server will start as soon as the service is instantiated.
|
|
705
|
+
</div>
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
</div>
|
|
715
|
+
<div class="subschema-name">
|
|
716
|
+
server.bind.address
|
|
717
|
+
[string]
|
|
718
|
+
|
|
719
|
+
</div>
|
|
720
|
+
<div class="subschema">
|
|
721
|
+
|
|
722
|
+
<div class="description">
|
|
723
|
+
the address that the server should bind to.
|
|
724
|
+
</div>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
</div>
|
|
734
|
+
<div class="subschema-name">
|
|
735
|
+
server.name
|
|
736
|
+
[string]
|
|
737
|
+
|
|
738
|
+
</div>
|
|
739
|
+
<div class="subschema">
|
|
740
|
+
|
|
741
|
+
<div class="description">
|
|
742
|
+
the name of the server.
|
|
743
|
+
</div>
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
</div>
|
|
753
|
+
<div class="subschema-name">
|
|
754
|
+
ssl.cert.comment
|
|
755
|
+
[string]
|
|
756
|
+
|
|
757
|
+
</div>
|
|
758
|
+
<div class="subschema">
|
|
759
|
+
|
|
760
|
+
<div class="description">
|
|
761
|
+
The comment to associate with the auto-generated certificate.
|
|
762
|
+
</div>
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
</div>
|
|
772
|
+
<div class="subschema-name">
|
|
773
|
+
ssl.cert.name
|
|
774
|
+
[array]
|
|
775
|
+
|
|
776
|
+
</div>
|
|
777
|
+
<div class="subschema">
|
|
778
|
+
|
|
779
|
+
<div class="description">
|
|
780
|
+
the name of the certificate (2D array)
|
|
781
|
+
</div>
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
</div>
|
|
791
|
+
<div class="subschema-name">
|
|
792
|
+
ssl.enable
|
|
793
|
+
[boolean]
|
|
794
|
+
|
|
795
|
+
</div>
|
|
796
|
+
<div class="subschema">
|
|
797
|
+
|
|
798
|
+
<div class="description">
|
|
799
|
+
whether or not to enable SSL on this server.
|
|
800
|
+
</div>
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
</div>
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
</div>
|
|
814
|
+
</div>
|
|
815
|
+
|
|
816
|
+
<h3><a name="ServletList_scm">ServletList</a></h3>
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
<p class="description">
|
|
820
|
+
This schema defines the format of a list of servlet mappings for a WEBrick server.
|
|
821
|
+
</p>
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
<div class="item-body">
|
|
825
|
+
<div class="definition-item">
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
<div class="schema-item">
|
|
834
|
+
|
|
835
|
+
<div class="subschema-name">
|
|
836
|
+
mount
|
|
837
|
+
[string]
|
|
838
|
+
<em>(required)</em>
|
|
839
|
+
</div>
|
|
840
|
+
<div class="subschema">
|
|
841
|
+
|
|
842
|
+
<div class="description">
|
|
843
|
+
the mount point of the servlet.
|
|
844
|
+
</div>
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
</div>
|
|
854
|
+
<div class="subschema-name">
|
|
855
|
+
class
|
|
856
|
+
[string]
|
|
857
|
+
|
|
858
|
+
</div>
|
|
859
|
+
<div class="subschema">
|
|
860
|
+
|
|
861
|
+
<div class="description">
|
|
862
|
+
the class to use as a servlet.
|
|
863
|
+
</div>
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
</div>
|
|
873
|
+
<div class="subschema-name">
|
|
874
|
+
options
|
|
875
|
+
[array]
|
|
876
|
+
|
|
877
|
+
</div>
|
|
878
|
+
<div class="subschema">
|
|
879
|
+
|
|
880
|
+
<div class="description">
|
|
881
|
+
Optional configuration data for the mount point.
|
|
882
|
+
</div>
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
</div>
|
|
892
|
+
<div class="subschema-name">
|
|
893
|
+
service
|
|
894
|
+
[service]
|
|
895
|
+
|
|
896
|
+
</div>
|
|
897
|
+
<div class="subschema">
|
|
898
|
+
|
|
899
|
+
<div class="description">
|
|
900
|
+
The servlet factory service to use to obtain a servlet instance.
|
|
901
|
+
</div>
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
</div>
|
|
911
|
+
</div>
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
</div>
|
|
915
|
+
</div>
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
<div class="generated-by">
|
|
919
|
+
Generated by
|
|
920
|
+
<a href="http://copland.rubyforge.org">Copland</a>'s
|
|
921
|
+
Packrat documentation extractor
|
|
922
|
+
on Sun Sep 26 21:37:13 MDT 2004
|
|
923
|
+
</div>
|
|
924
|
+
</body>
|
|
925
|
+
</html>
|