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,434 @@
|
|
|
1
|
+
<html>
|
|
2
|
+
<head>
|
|
3
|
+
<title>Copland Manual :: Chapter 7: Service Models</title>
|
|
4
|
+
<link type="text/css" rel="stylesheet" href="manual.css" />
|
|
5
|
+
</head>
|
|
6
|
+
|
|
7
|
+
<body>
|
|
8
|
+
<div id="banner">
|
|
9
|
+
<table border='0' cellpadding='0' cellspacing='0' width='100%'>
|
|
10
|
+
<tr><td valign='top' align='left'>
|
|
11
|
+
<div class="title">
|
|
12
|
+
<span class="product">Copland—</span><br />
|
|
13
|
+
<span class="tagline">compose yourself...</span>
|
|
14
|
+
</div>
|
|
15
|
+
</td><td valign='middle' align='right'>
|
|
16
|
+
<div class="info">
|
|
17
|
+
Copland Version: <strong>0.8.0</strong><br />
|
|
18
|
+
Manual Last Updated: <strong>2004-09-27 03:37 GMT</strong>
|
|
19
|
+
</div>
|
|
20
|
+
</td></tr>
|
|
21
|
+
</table>
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
<table border='0' width='100%' cellpadding='0' cellspacing='0'>
|
|
25
|
+
<tr><td valign='top'>
|
|
26
|
+
|
|
27
|
+
<div id="navigation">
|
|
28
|
+
<h1>Copland Manual</h1>
|
|
29
|
+
|
|
30
|
+
<h2>Chapters</h2>
|
|
31
|
+
<ol type="I">
|
|
32
|
+
|
|
33
|
+
<li>
|
|
34
|
+
<a href="chapter-1.html">
|
|
35
|
+
Introduction
|
|
36
|
+
</a>
|
|
37
|
+
|
|
38
|
+
<ol type="1">
|
|
39
|
+
|
|
40
|
+
<li><a href="chapter-1.html#s1">What is Copland?</a></li>
|
|
41
|
+
|
|
42
|
+
<li><a href="chapter-1.html#s2">Features</a></li>
|
|
43
|
+
|
|
44
|
+
<li><a href="chapter-1.html#s3">Getting Copland</a></li>
|
|
45
|
+
|
|
46
|
+
<li><a href="chapter-1.html#s4">License Information</a></li>
|
|
47
|
+
|
|
48
|
+
<li><a href="chapter-1.html#s5">Support</a></li>
|
|
49
|
+
|
|
50
|
+
</ol>
|
|
51
|
+
</li>
|
|
52
|
+
|
|
53
|
+
<li>
|
|
54
|
+
<a href="chapter-2.html">
|
|
55
|
+
Justification
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
<ol type="1">
|
|
59
|
+
|
|
60
|
+
<li><a href="chapter-2.html#s1">IoC in One Paragraph</a></li>
|
|
61
|
+
|
|
62
|
+
<li><a href="chapter-2.html#s2">Why IoC?</a></li>
|
|
63
|
+
|
|
64
|
+
<li><a href="chapter-2.html#s3">A Case Study</a></li>
|
|
65
|
+
|
|
66
|
+
</ol>
|
|
67
|
+
</li>
|
|
68
|
+
|
|
69
|
+
<li>
|
|
70
|
+
<a href="chapter-3.html">
|
|
71
|
+
Getting Started
|
|
72
|
+
</a>
|
|
73
|
+
|
|
74
|
+
<ol type="1">
|
|
75
|
+
|
|
76
|
+
<li><a href="chapter-3.html#s1">Terminology</a></li>
|
|
77
|
+
|
|
78
|
+
<li><a href="chapter-3.html#s2">Quickstart</a></li>
|
|
79
|
+
|
|
80
|
+
</ol>
|
|
81
|
+
</li>
|
|
82
|
+
|
|
83
|
+
<li>
|
|
84
|
+
<a href="chapter-4.html">
|
|
85
|
+
Copland's Design
|
|
86
|
+
</a>
|
|
87
|
+
|
|
88
|
+
<ol type="1">
|
|
89
|
+
|
|
90
|
+
<li><a href="chapter-4.html#s1">HiveMind</a></li>
|
|
91
|
+
|
|
92
|
+
<li><a href="chapter-4.html#s2">Registry Initialization</a></li>
|
|
93
|
+
|
|
94
|
+
<li><a href="chapter-4.html#s3">Service Instantiation</a></li>
|
|
95
|
+
|
|
96
|
+
<li><a href="chapter-4.html#s4">Interceptor Chains</a></li>
|
|
97
|
+
|
|
98
|
+
</ol>
|
|
99
|
+
</li>
|
|
100
|
+
|
|
101
|
+
<li>
|
|
102
|
+
<a href="chapter-5.html">
|
|
103
|
+
Packages
|
|
104
|
+
</a>
|
|
105
|
+
|
|
106
|
+
<ol type="1">
|
|
107
|
+
|
|
108
|
+
<li><a href="chapter-5.html#s1">Descriptor Syntax</a></li>
|
|
109
|
+
|
|
110
|
+
<li><a href="chapter-5.html#s2">Tips</a></li>
|
|
111
|
+
|
|
112
|
+
</ol>
|
|
113
|
+
</li>
|
|
114
|
+
|
|
115
|
+
<li>
|
|
116
|
+
<a href="chapter-6.html">
|
|
117
|
+
Service Points
|
|
118
|
+
</a>
|
|
119
|
+
|
|
120
|
+
<ol type="1">
|
|
121
|
+
|
|
122
|
+
<li><a href="chapter-6.html#s1">Descriptor Syntax</a></li>
|
|
123
|
+
|
|
124
|
+
</ol>
|
|
125
|
+
</li>
|
|
126
|
+
|
|
127
|
+
<li><strong>
|
|
128
|
+
<a href="chapter-7.html">
|
|
129
|
+
Service Models
|
|
130
|
+
</a>
|
|
131
|
+
</strong> <big>←</big>
|
|
132
|
+
<ol type="1">
|
|
133
|
+
|
|
134
|
+
<li><a href="chapter-7.html#s1">Standard Models</a></li>
|
|
135
|
+
|
|
136
|
+
<li><a href="chapter-7.html#s2">Deferred Instantiation</a></li>
|
|
137
|
+
|
|
138
|
+
<li><a href="chapter-7.html#s3">Custom Service Models</a></li>
|
|
139
|
+
|
|
140
|
+
</ol>
|
|
141
|
+
</li>
|
|
142
|
+
|
|
143
|
+
<li>
|
|
144
|
+
<a href="chapter-8.html">
|
|
145
|
+
Configuration Points
|
|
146
|
+
</a>
|
|
147
|
+
|
|
148
|
+
<ol type="1">
|
|
149
|
+
|
|
150
|
+
<li><a href="chapter-8.html#s1">Descriptor Syntax</a></li>
|
|
151
|
+
|
|
152
|
+
<li><a href="chapter-8.html#s2">DefaultSymbolSource</a></li>
|
|
153
|
+
|
|
154
|
+
</ol>
|
|
155
|
+
</li>
|
|
156
|
+
|
|
157
|
+
<li>
|
|
158
|
+
<a href="chapter-9.html">
|
|
159
|
+
Contributions
|
|
160
|
+
</a>
|
|
161
|
+
|
|
162
|
+
<ol type="1">
|
|
163
|
+
|
|
164
|
+
</ol>
|
|
165
|
+
</li>
|
|
166
|
+
|
|
167
|
+
<li>
|
|
168
|
+
<a href="chapter-10.html">
|
|
169
|
+
Service Factories
|
|
170
|
+
</a>
|
|
171
|
+
|
|
172
|
+
<ol type="1">
|
|
173
|
+
|
|
174
|
+
<li><a href="chapter-10.html#s1">Schemas</a></li>
|
|
175
|
+
|
|
176
|
+
<li><a href="chapter-10.html#s2">How do they work?</a></li>
|
|
177
|
+
|
|
178
|
+
<li><a href="chapter-10.html#s3">BuilderFactory</a></li>
|
|
179
|
+
|
|
180
|
+
</ol>
|
|
181
|
+
</li>
|
|
182
|
+
|
|
183
|
+
<li>
|
|
184
|
+
<a href="chapter-11.html">
|
|
185
|
+
Schemas
|
|
186
|
+
</a>
|
|
187
|
+
|
|
188
|
+
<ol type="1">
|
|
189
|
+
|
|
190
|
+
<li><a href="chapter-11.html#s1">Basic Format</a></li>
|
|
191
|
+
|
|
192
|
+
<li><a href="chapter-11.html#s2">Subschemas</a></li>
|
|
193
|
+
|
|
194
|
+
<li><a href="chapter-11.html#s3">Arrays</a></li>
|
|
195
|
+
|
|
196
|
+
<li><a href="chapter-11.html#s4">Named vs. Anonymous Schemas</a></li>
|
|
197
|
+
|
|
198
|
+
<li><a href="chapter-11.html#s5">Extending Schemas</a></li>
|
|
199
|
+
|
|
200
|
+
<li><a href="chapter-11.html#s6">Limitations</a></li>
|
|
201
|
+
|
|
202
|
+
</ol>
|
|
203
|
+
</li>
|
|
204
|
+
|
|
205
|
+
<li>
|
|
206
|
+
<a href="chapter-12.html">
|
|
207
|
+
Listeners and Event Producers
|
|
208
|
+
</a>
|
|
209
|
+
|
|
210
|
+
<ol type="1">
|
|
211
|
+
|
|
212
|
+
<li><a href="chapter-12.html#s1">Event Producers</a></li>
|
|
213
|
+
|
|
214
|
+
<li><a href="chapter-12.html#s2">Listeners</a></li>
|
|
215
|
+
|
|
216
|
+
<li><a href="chapter-12.html#s3">The Registry as an Event Producer</a></li>
|
|
217
|
+
|
|
218
|
+
</ol>
|
|
219
|
+
</li>
|
|
220
|
+
|
|
221
|
+
</ol>
|
|
222
|
+
|
|
223
|
+
<h2>API Reference</h2>
|
|
224
|
+
|
|
225
|
+
<ul>
|
|
226
|
+
<li><a href="http://copland.rubyforge.org/api/index.html">Copland API</a></li>
|
|
227
|
+
<li><a href="http://copland.rubyforge.org/packrat/index.html">Package Reference</a></li>
|
|
228
|
+
</ul>
|
|
229
|
+
|
|
230
|
+
<h2>Tutorials</h2>
|
|
231
|
+
<ol>
|
|
232
|
+
|
|
233
|
+
<li>
|
|
234
|
+
<a href="tutorial-1.html">
|
|
235
|
+
Creating Services
|
|
236
|
+
</a>
|
|
237
|
+
<br />
|
|
238
|
+
<p>The basics of creating new services in Copland.</p>
|
|
239
|
+
</li>
|
|
240
|
+
|
|
241
|
+
<li>
|
|
242
|
+
<a href="tutorial-2.html">
|
|
243
|
+
Service Factories
|
|
244
|
+
</a>
|
|
245
|
+
<br />
|
|
246
|
+
<p>Introduces the concept of a “service factory”, and shows how to use them to create complex services.</p>
|
|
247
|
+
</li>
|
|
248
|
+
|
|
249
|
+
<li>
|
|
250
|
+
<a href="tutorial-3.html">
|
|
251
|
+
Service Models
|
|
252
|
+
</a>
|
|
253
|
+
<br />
|
|
254
|
+
<p>Introduces the concept of the “service model”, and shows the difference between “singleton” and “prototype”.</p>
|
|
255
|
+
</li>
|
|
256
|
+
|
|
257
|
+
<li>
|
|
258
|
+
<a href="tutorial-4.html">
|
|
259
|
+
Logging Interceptor
|
|
260
|
+
</a>
|
|
261
|
+
<br />
|
|
262
|
+
<p>Shows how to use the logging interceptor to add logging for method invocations on any service.</p>
|
|
263
|
+
</li>
|
|
264
|
+
|
|
265
|
+
<li>
|
|
266
|
+
<a href="tutorial-5.html">
|
|
267
|
+
Configuration Points
|
|
268
|
+
</a>
|
|
269
|
+
<br />
|
|
270
|
+
<p>Demonstrates the use of configuration points for decentralizing service configuration.</p>
|
|
271
|
+
</li>
|
|
272
|
+
|
|
273
|
+
</ol>
|
|
274
|
+
|
|
275
|
+
<p align="center"><strong>More To Come...</strong></p>
|
|
276
|
+
|
|
277
|
+
<!--
|
|
278
|
+
<h2>Examples</h2>
|
|
279
|
+
<ol>
|
|
280
|
+
|
|
281
|
+
</ol>
|
|
282
|
+
-->
|
|
283
|
+
|
|
284
|
+
<div class="license">
|
|
285
|
+
<a href="http://creativecommons.org/licenses/by-sa/2.0/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights" /></a><br />
|
|
286
|
+
This manual is licensed under a <a href="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons License</a>.
|
|
287
|
+
</div>
|
|
288
|
+
</div>
|
|
289
|
+
|
|
290
|
+
</td><td valign='top' width="100%">
|
|
291
|
+
|
|
292
|
+
<div id="content">
|
|
293
|
+
|
|
294
|
+
<h1>7. Service Models</h1>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<div class="section">
|
|
299
|
+
<p>Service models are used to specify when a service point should be instantiated. There are five pre-defined service models, and you can easily define more yourself should you need them.</p>
|
|
300
|
+
|
|
301
|
+
<p>The service model for a service point is specified using the <code>model</code> attribute in the service point definition. This attribute is optional, defaulting to <code>singleton-deferred</code>, but if given it must refer to either one of the five standard service models, or to a custom service model you have defined.<br />
|
|
302
|
+
</p>
|
|
303
|
+
</div>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
<h2>
|
|
308
|
+
<a name="s1"></a>
|
|
309
|
+
7.1. Standard Models
|
|
310
|
+
</h2>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
<div class="section">
|
|
315
|
+
<p>The five standard service models are:</p>
|
|
316
|
+
|
|
317
|
+
<table class="list">
|
|
318
|
+
<tr>
|
|
319
|
+
<td style="vertical-align:top;"><code>prototype</code> </td>
|
|
320
|
+
<td> A service point using this model will be reinstantiated every time it is requested. This may be useful, for instance, when the requested service is stateful, and you do not want instances of the service to be reused.</td>
|
|
321
|
+
</tr>
|
|
322
|
+
<tr>
|
|
323
|
+
<td style="vertical-align:top;"><code>prototype-deferred</code> </td>
|
|
324
|
+
<td> This is the same as the <code>prototype</code> service model, except that the service will not be instantiated until the first time any of its methods are invoked. Thus, if you <em>might</em> need the service, but there are some paths through your program that won’t use it, you can use this model so that the overhead of initializing the service only occurs when you actually invoke a method on it.</td>
|
|
325
|
+
</tr>
|
|
326
|
+
<tr>
|
|
327
|
+
<td style="vertical-align:top;"><code>singleton</code> </td>
|
|
328
|
+
<td> Only one instance of the service is ever created. Any subsequent request for the service will return the instance that was created the first time. This is the most common scenario for most services, since in general a service is either stateless, or its state is effectively global throughout an application.</td>
|
|
329
|
+
</tr>
|
|
330
|
+
<tr>
|
|
331
|
+
<td style="vertical-align:top;"><code>singleton-deferred</code> </td>
|
|
332
|
+
<td> This is identical to the <code>singleton</code> model, above, but also has the deferring functionality of the <code>prototype-deferred</code> model.</td>
|
|
333
|
+
</tr>
|
|
334
|
+
<tr>
|
|
335
|
+
<td style="vertical-align:top;"><code>threaded</code> </td>
|
|
336
|
+
<td> This model results in every thread obtaining its own instance of a service. It is otherwise identical to <code>singleton-deferred</code>.</td>
|
|
337
|
+
</tr>
|
|
338
|
+
</table>
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
<h2>
|
|
344
|
+
<a name="s2"></a>
|
|
345
|
+
7.2. Deferred Instantiation
|
|
346
|
+
</h2>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
<div class="section">
|
|
351
|
+
<p>Using one of the “deferred” service models (<code>prototype-deferred</code>, <code>singleton-deferred</code>, or <code>threaded</code>) can be very useful, but there are side-effects that you ought to be aware of. Otherwise, you may spend a lot of time debugging some difficult-to-track-down problems.</p>
|
|
352
|
+
|
|
353
|
+
<p>In particular, it is important to keep in mind that the service is not actually instantiated until a method is invoked on it. This means that if the service’s initialization routine raises an error, the exception will not occur where the reference to the service was obtained, but will occur where the method call was made. The service will also not have been properly instantiated, so if you try to inoke any of its methods again, you’ll get <code>nil</code> back every time.</p>
|
|
354
|
+
|
|
355
|
+
<p>For example, consider the following scenario.</p>
|
|
356
|
+
|
|
357
|
+
<p>Suppose you are writing a web-application framework, using Copland to modularize the various components. One of the services you create is a “page manager”, which will broker all requests for page objects. When an application needs a page, it queries the page manager, which will look up the page and return it.</p>
|
|
358
|
+
|
|
359
|
+
<p>You make the page manager service <code>singleton-deferred</code>.</p>
|
|
360
|
+
|
|
361
|
+
<p>Now, inside the controller for your architecture, you grab a reference to the page manager. (Note, however, that the object you are given is <em>not</em> the page manager—instead, it is a proxy object that will instantiate the page manager the first time a method is invoked on it.) Some time later you invoke <code>#get_page</code> on the page manager, which you expect to go grab a page object and return it.</p>
|
|
362
|
+
|
|
363
|
+
<p><em>However</em>. What actually happens is this: the proxy object intercepts the method call and tries to instantiate the page manager service, since it hasn’t been instantiated yet. During the page manager initialization, however, something goes wrong. Perhaps one of the page classes doesn’t exist, or there is a syntax error in one of the files that the page manager needs to require. Whatever it is, the page manager cannot be initialized and an exception is thrown.</p>
|
|
364
|
+
|
|
365
|
+
<p>The controller code catches the exception.</p>
|
|
366
|
+
|
|
367
|
+
<p><em>Problem</em>. Inside the rescue clause for the exception, <em>the controller queries the page manager for the error page</em>, so that it can display a coherent error to the client. However, since there was an error instantiating the page manager, future queries to the proxy object always return <code>nil</code>. This may result in an “undefined method `x’ for nil:NilClass” error down the road.</p>
|
|
368
|
+
|
|
369
|
+
<p>To avoid problems like this, you can do one of two things. One, you can use the <code>singleton</code> model, instead of <code>singleton-deferred</code>. This way, Copland will never deliver you a reference to a proxy. The other solution is to create a method in your class that always returns non-<code>nil</code>. Then, if it ever <em>does</em> return <code>nil</code>, you can be pretty sure that the service was not instantiated correctly. This, unfortunately, requires your code to know that the service was deferred.<br />
|
|
370
|
+
</p>
|
|
371
|
+
</div>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<h2>
|
|
376
|
+
<a name="s3"></a>
|
|
377
|
+
7.3. Custom Service Models
|
|
378
|
+
</h2>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<div class="section">
|
|
383
|
+
<p>Creating your own service models is very straight-forward. In general, all you need to do is create a class. The class should extend the <code>Copland::Instantiator::Abstract</code> class, and must override the <code>instantiate</code> method. The <code>instantiate</code> method should accept a no parameters. The method should then return an object that represents the instantiated service.</p>
|
|
384
|
+
|
|
385
|
+
<p>After creating the class, you need to register it with the <code>Copland::ClassFactory</code> class by calling it’s <code>register</code> method, passing the name to want for this new model, and a reference to the class that implements it.</p>
|
|
386
|
+
|
|
387
|
+
<p>To return a deferred version of the service, return a new instance of <code>Copland::Instantiator::Proxy</code>. The proxy’s constructor accepts a single parameter: the service point to instantiate.</p>
|
|
388
|
+
|
|
389
|
+
<p>To create a singleton service, the <code>instantiate</code> method should cache the new service, returning it (if it exists) instead of instantiating a new service.</p>
|
|
390
|
+
|
|
391
|
+
<p>Lastly, be aware that you may need to do some synchronization via mutexes to make your new service model thread-safe. Multiple threads could call it concurrently, which may cause problems if your model stores any state (as is the case with models that enforce a singleton model of service instantiation).</p>
|
|
392
|
+
|
|
393
|
+
<p>Here’s a brief example of a custom service model, pulled off the top of my head:</p>
|
|
394
|
+
|
|
395
|
+
<pre>
|
|
396
|
+
class FiveMinuteServiceModel < Copland::Instantiator::Abstract
|
|
397
|
+
CachedService = Struct.new( :service, :time )
|
|
398
|
+
|
|
399
|
+
def initialize( point, definition )
|
|
400
|
+
super
|
|
401
|
+
@mutex = Mutex.new
|
|
402
|
+
@service_cache = Hash.new
|
|
403
|
+
end
|
|
404
|
+
|
|
405
|
+
def instantiate
|
|
406
|
+
@mutex.synchronize do
|
|
407
|
+
svc = @service_cache[ point ]
|
|
408
|
+
|
|
409
|
+
if svc.nil? || Time.now - svc.time > 300
|
|
410
|
+
svc = CachedService.new( point.instantiate, Time.now )
|
|
411
|
+
@service_cache[ point ] = svc
|
|
412
|
+
end
|
|
413
|
+
|
|
414
|
+
return svc.service
|
|
415
|
+
end
|
|
416
|
+
end
|
|
417
|
+
|
|
418
|
+
register_as "custom.five-minutes"
|
|
419
|
+
end
|
|
420
|
+
</pre>
|
|
421
|
+
|
|
422
|
+
<p>This (contrived) example will result in a singleton-style model (non-deferred), which will instantiate the requested service point if it has been more than five minutes (300 seconds) since the point was last instantiated. It can be referenced in a service point definition under the <code>model</code> attribute, as “custom.five-minutes”.<br />
|
|
423
|
+
</p>
|
|
424
|
+
</div>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
</div>
|
|
430
|
+
|
|
431
|
+
</td></tr>
|
|
432
|
+
</table>
|
|
433
|
+
</body>
|
|
434
|
+
</html>
|
|
@@ -0,0 +1,373 @@
|
|
|
1
|
+
<html>
|
|
2
|
+
<head>
|
|
3
|
+
<title>Copland Manual :: Chapter 8: Configuration Points</title>
|
|
4
|
+
<link type="text/css" rel="stylesheet" href="manual.css" />
|
|
5
|
+
</head>
|
|
6
|
+
|
|
7
|
+
<body>
|
|
8
|
+
<div id="banner">
|
|
9
|
+
<table border='0' cellpadding='0' cellspacing='0' width='100%'>
|
|
10
|
+
<tr><td valign='top' align='left'>
|
|
11
|
+
<div class="title">
|
|
12
|
+
<span class="product">Copland—</span><br />
|
|
13
|
+
<span class="tagline">compose yourself...</span>
|
|
14
|
+
</div>
|
|
15
|
+
</td><td valign='middle' align='right'>
|
|
16
|
+
<div class="info">
|
|
17
|
+
Copland Version: <strong>0.8.0</strong><br />
|
|
18
|
+
Manual Last Updated: <strong>2004-09-27 03:37 GMT</strong>
|
|
19
|
+
</div>
|
|
20
|
+
</td></tr>
|
|
21
|
+
</table>
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
<table border='0' width='100%' cellpadding='0' cellspacing='0'>
|
|
25
|
+
<tr><td valign='top'>
|
|
26
|
+
|
|
27
|
+
<div id="navigation">
|
|
28
|
+
<h1>Copland Manual</h1>
|
|
29
|
+
|
|
30
|
+
<h2>Chapters</h2>
|
|
31
|
+
<ol type="I">
|
|
32
|
+
|
|
33
|
+
<li>
|
|
34
|
+
<a href="chapter-1.html">
|
|
35
|
+
Introduction
|
|
36
|
+
</a>
|
|
37
|
+
|
|
38
|
+
<ol type="1">
|
|
39
|
+
|
|
40
|
+
<li><a href="chapter-1.html#s1">What is Copland?</a></li>
|
|
41
|
+
|
|
42
|
+
<li><a href="chapter-1.html#s2">Features</a></li>
|
|
43
|
+
|
|
44
|
+
<li><a href="chapter-1.html#s3">Getting Copland</a></li>
|
|
45
|
+
|
|
46
|
+
<li><a href="chapter-1.html#s4">License Information</a></li>
|
|
47
|
+
|
|
48
|
+
<li><a href="chapter-1.html#s5">Support</a></li>
|
|
49
|
+
|
|
50
|
+
</ol>
|
|
51
|
+
</li>
|
|
52
|
+
|
|
53
|
+
<li>
|
|
54
|
+
<a href="chapter-2.html">
|
|
55
|
+
Justification
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
<ol type="1">
|
|
59
|
+
|
|
60
|
+
<li><a href="chapter-2.html#s1">IoC in One Paragraph</a></li>
|
|
61
|
+
|
|
62
|
+
<li><a href="chapter-2.html#s2">Why IoC?</a></li>
|
|
63
|
+
|
|
64
|
+
<li><a href="chapter-2.html#s3">A Case Study</a></li>
|
|
65
|
+
|
|
66
|
+
</ol>
|
|
67
|
+
</li>
|
|
68
|
+
|
|
69
|
+
<li>
|
|
70
|
+
<a href="chapter-3.html">
|
|
71
|
+
Getting Started
|
|
72
|
+
</a>
|
|
73
|
+
|
|
74
|
+
<ol type="1">
|
|
75
|
+
|
|
76
|
+
<li><a href="chapter-3.html#s1">Terminology</a></li>
|
|
77
|
+
|
|
78
|
+
<li><a href="chapter-3.html#s2">Quickstart</a></li>
|
|
79
|
+
|
|
80
|
+
</ol>
|
|
81
|
+
</li>
|
|
82
|
+
|
|
83
|
+
<li>
|
|
84
|
+
<a href="chapter-4.html">
|
|
85
|
+
Copland's Design
|
|
86
|
+
</a>
|
|
87
|
+
|
|
88
|
+
<ol type="1">
|
|
89
|
+
|
|
90
|
+
<li><a href="chapter-4.html#s1">HiveMind</a></li>
|
|
91
|
+
|
|
92
|
+
<li><a href="chapter-4.html#s2">Registry Initialization</a></li>
|
|
93
|
+
|
|
94
|
+
<li><a href="chapter-4.html#s3">Service Instantiation</a></li>
|
|
95
|
+
|
|
96
|
+
<li><a href="chapter-4.html#s4">Interceptor Chains</a></li>
|
|
97
|
+
|
|
98
|
+
</ol>
|
|
99
|
+
</li>
|
|
100
|
+
|
|
101
|
+
<li>
|
|
102
|
+
<a href="chapter-5.html">
|
|
103
|
+
Packages
|
|
104
|
+
</a>
|
|
105
|
+
|
|
106
|
+
<ol type="1">
|
|
107
|
+
|
|
108
|
+
<li><a href="chapter-5.html#s1">Descriptor Syntax</a></li>
|
|
109
|
+
|
|
110
|
+
<li><a href="chapter-5.html#s2">Tips</a></li>
|
|
111
|
+
|
|
112
|
+
</ol>
|
|
113
|
+
</li>
|
|
114
|
+
|
|
115
|
+
<li>
|
|
116
|
+
<a href="chapter-6.html">
|
|
117
|
+
Service Points
|
|
118
|
+
</a>
|
|
119
|
+
|
|
120
|
+
<ol type="1">
|
|
121
|
+
|
|
122
|
+
<li><a href="chapter-6.html#s1">Descriptor Syntax</a></li>
|
|
123
|
+
|
|
124
|
+
</ol>
|
|
125
|
+
</li>
|
|
126
|
+
|
|
127
|
+
<li>
|
|
128
|
+
<a href="chapter-7.html">
|
|
129
|
+
Service Models
|
|
130
|
+
</a>
|
|
131
|
+
|
|
132
|
+
<ol type="1">
|
|
133
|
+
|
|
134
|
+
<li><a href="chapter-7.html#s1">Standard Models</a></li>
|
|
135
|
+
|
|
136
|
+
<li><a href="chapter-7.html#s2">Deferred Instantiation</a></li>
|
|
137
|
+
|
|
138
|
+
<li><a href="chapter-7.html#s3">Custom Service Models</a></li>
|
|
139
|
+
|
|
140
|
+
</ol>
|
|
141
|
+
</li>
|
|
142
|
+
|
|
143
|
+
<li><strong>
|
|
144
|
+
<a href="chapter-8.html">
|
|
145
|
+
Configuration Points
|
|
146
|
+
</a>
|
|
147
|
+
</strong> <big>←</big>
|
|
148
|
+
<ol type="1">
|
|
149
|
+
|
|
150
|
+
<li><a href="chapter-8.html#s1">Descriptor Syntax</a></li>
|
|
151
|
+
|
|
152
|
+
<li><a href="chapter-8.html#s2">DefaultSymbolSource</a></li>
|
|
153
|
+
|
|
154
|
+
</ol>
|
|
155
|
+
</li>
|
|
156
|
+
|
|
157
|
+
<li>
|
|
158
|
+
<a href="chapter-9.html">
|
|
159
|
+
Contributions
|
|
160
|
+
</a>
|
|
161
|
+
|
|
162
|
+
<ol type="1">
|
|
163
|
+
|
|
164
|
+
</ol>
|
|
165
|
+
</li>
|
|
166
|
+
|
|
167
|
+
<li>
|
|
168
|
+
<a href="chapter-10.html">
|
|
169
|
+
Service Factories
|
|
170
|
+
</a>
|
|
171
|
+
|
|
172
|
+
<ol type="1">
|
|
173
|
+
|
|
174
|
+
<li><a href="chapter-10.html#s1">Schemas</a></li>
|
|
175
|
+
|
|
176
|
+
<li><a href="chapter-10.html#s2">How do they work?</a></li>
|
|
177
|
+
|
|
178
|
+
<li><a href="chapter-10.html#s3">BuilderFactory</a></li>
|
|
179
|
+
|
|
180
|
+
</ol>
|
|
181
|
+
</li>
|
|
182
|
+
|
|
183
|
+
<li>
|
|
184
|
+
<a href="chapter-11.html">
|
|
185
|
+
Schemas
|
|
186
|
+
</a>
|
|
187
|
+
|
|
188
|
+
<ol type="1">
|
|
189
|
+
|
|
190
|
+
<li><a href="chapter-11.html#s1">Basic Format</a></li>
|
|
191
|
+
|
|
192
|
+
<li><a href="chapter-11.html#s2">Subschemas</a></li>
|
|
193
|
+
|
|
194
|
+
<li><a href="chapter-11.html#s3">Arrays</a></li>
|
|
195
|
+
|
|
196
|
+
<li><a href="chapter-11.html#s4">Named vs. Anonymous Schemas</a></li>
|
|
197
|
+
|
|
198
|
+
<li><a href="chapter-11.html#s5">Extending Schemas</a></li>
|
|
199
|
+
|
|
200
|
+
<li><a href="chapter-11.html#s6">Limitations</a></li>
|
|
201
|
+
|
|
202
|
+
</ol>
|
|
203
|
+
</li>
|
|
204
|
+
|
|
205
|
+
<li>
|
|
206
|
+
<a href="chapter-12.html">
|
|
207
|
+
Listeners and Event Producers
|
|
208
|
+
</a>
|
|
209
|
+
|
|
210
|
+
<ol type="1">
|
|
211
|
+
|
|
212
|
+
<li><a href="chapter-12.html#s1">Event Producers</a></li>
|
|
213
|
+
|
|
214
|
+
<li><a href="chapter-12.html#s2">Listeners</a></li>
|
|
215
|
+
|
|
216
|
+
<li><a href="chapter-12.html#s3">The Registry as an Event Producer</a></li>
|
|
217
|
+
|
|
218
|
+
</ol>
|
|
219
|
+
</li>
|
|
220
|
+
|
|
221
|
+
</ol>
|
|
222
|
+
|
|
223
|
+
<h2>API Reference</h2>
|
|
224
|
+
|
|
225
|
+
<ul>
|
|
226
|
+
<li><a href="http://copland.rubyforge.org/api/index.html">Copland API</a></li>
|
|
227
|
+
<li><a href="http://copland.rubyforge.org/packrat/index.html">Package Reference</a></li>
|
|
228
|
+
</ul>
|
|
229
|
+
|
|
230
|
+
<h2>Tutorials</h2>
|
|
231
|
+
<ol>
|
|
232
|
+
|
|
233
|
+
<li>
|
|
234
|
+
<a href="tutorial-1.html">
|
|
235
|
+
Creating Services
|
|
236
|
+
</a>
|
|
237
|
+
<br />
|
|
238
|
+
<p>The basics of creating new services in Copland.</p>
|
|
239
|
+
</li>
|
|
240
|
+
|
|
241
|
+
<li>
|
|
242
|
+
<a href="tutorial-2.html">
|
|
243
|
+
Service Factories
|
|
244
|
+
</a>
|
|
245
|
+
<br />
|
|
246
|
+
<p>Introduces the concept of a “service factory”, and shows how to use them to create complex services.</p>
|
|
247
|
+
</li>
|
|
248
|
+
|
|
249
|
+
<li>
|
|
250
|
+
<a href="tutorial-3.html">
|
|
251
|
+
Service Models
|
|
252
|
+
</a>
|
|
253
|
+
<br />
|
|
254
|
+
<p>Introduces the concept of the “service model”, and shows the difference between “singleton” and “prototype”.</p>
|
|
255
|
+
</li>
|
|
256
|
+
|
|
257
|
+
<li>
|
|
258
|
+
<a href="tutorial-4.html">
|
|
259
|
+
Logging Interceptor
|
|
260
|
+
</a>
|
|
261
|
+
<br />
|
|
262
|
+
<p>Shows how to use the logging interceptor to add logging for method invocations on any service.</p>
|
|
263
|
+
</li>
|
|
264
|
+
|
|
265
|
+
<li>
|
|
266
|
+
<a href="tutorial-5.html">
|
|
267
|
+
Configuration Points
|
|
268
|
+
</a>
|
|
269
|
+
<br />
|
|
270
|
+
<p>Demonstrates the use of configuration points for decentralizing service configuration.</p>
|
|
271
|
+
</li>
|
|
272
|
+
|
|
273
|
+
</ol>
|
|
274
|
+
|
|
275
|
+
<p align="center"><strong>More To Come...</strong></p>
|
|
276
|
+
|
|
277
|
+
<!--
|
|
278
|
+
<h2>Examples</h2>
|
|
279
|
+
<ol>
|
|
280
|
+
|
|
281
|
+
</ol>
|
|
282
|
+
-->
|
|
283
|
+
|
|
284
|
+
<div class="license">
|
|
285
|
+
<a href="http://creativecommons.org/licenses/by-sa/2.0/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights" /></a><br />
|
|
286
|
+
This manual is licensed under a <a href="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons License</a>.
|
|
287
|
+
</div>
|
|
288
|
+
</div>
|
|
289
|
+
|
|
290
|
+
</td><td valign='top' width="100%">
|
|
291
|
+
|
|
292
|
+
<div id="content">
|
|
293
|
+
|
|
294
|
+
<h1>8. Configuration Points</h1>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<div class="section">
|
|
299
|
+
<p>A <em>configuration point</em> is either a list or map that other packages may contribute values to. You can then have Copland automatically wire that configuration point into a service.</p>
|
|
300
|
+
|
|
301
|
+
<p>Why would you want to do this? Various reasons. One is so that you can allow other packages to configure the behavior of a particular service. The <code>copland.remote.DRbServer</code> service, for example, does this, to allow applications to configure the host and port that should be listened to, and whether or not the service should be automatically started.</p>
|
|
302
|
+
|
|
303
|
+
<p>Values are added to a configuration point via the “contributions” section of a package descriptor.<br />
|
|
304
|
+
</p>
|
|
305
|
+
</div>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<h2>
|
|
310
|
+
<a name="s1"></a>
|
|
311
|
+
8.1. Descriptor Syntax
|
|
312
|
+
</h2>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<div class="section">
|
|
317
|
+
<p>Every configuration point must be defined as part of the “configuration-points” section of a package descriptor. The id (or name) of the configuration point will be the key used in that section to reference it, and it may contain any character you wish except for a ”.”. Also, if you use any character that <span class="caps">YAML</span> treats specially (like commas, or colons), you’ll need to put the configuration name in quotes.</p>
|
|
318
|
+
|
|
319
|
+
<p>The allowed attributes of a configuration point are:</p>
|
|
320
|
+
|
|
321
|
+
<table class="list">
|
|
322
|
+
<tr>
|
|
323
|
+
<td style="vertical-align:top;"><code>description</code> </td>
|
|
324
|
+
<td> This is an (optional) description of what the configuration point describes. Where a schema (see below) is insufficient, the description may also be used for describing what kinds of values the configuration point expects.</td>
|
|
325
|
+
</tr>
|
|
326
|
+
<tr>
|
|
327
|
+
<td style="vertical-align:top;"><code>type</code> </td>
|
|
328
|
+
<td> This is the type of the configuration point. By default, only <code>list</code> and <code>map</code> are supported, but you can add your own configuration point types.</td>
|
|
329
|
+
</tr>
|
|
330
|
+
<tr>
|
|
331
|
+
<td style="vertical-align:top;"><code>schema</code></td>
|
|
332
|
+
<td>This must be either a string or a hash. If it is a string, then it references another schema (either in this package or a different one). Otherwise, it’s format is described in more detail in the chapter “Schemas”. This is used to restrict the values that can be contributed to the configuration point. If the configuration point is of type <code>list</code>, then the schema applies to each element of the configuration point. Otherwise, the schema describes the format of the map.</td>
|
|
333
|
+
</tr>
|
|
334
|
+
</table>
|
|
335
|
+
|
|
336
|
+
<p>Of these attributes, only <code>type</code> is required.<br />
|
|
337
|
+
</p>
|
|
338
|
+
</div>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<h2>
|
|
343
|
+
<a name="s2"></a>
|
|
344
|
+
8.2. DefaultSymbolSource
|
|
345
|
+
</h2>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
<div class="section">
|
|
350
|
+
<p>One of the core pre-defined configuration points is the map <code>copland.DefaultSymbolSource</code>. Although you will rarely access this configuration point directly, it is integrated tightly with Copland. Any value you add to it becomes available as a <em>substitution symbol</em>.</p>
|
|
351
|
+
|
|
352
|
+
<p>Substitution symbols will look familiar to those of you coming from a Java background; utilities like <a href="http://ant.apache.org">ant</a> and <a href="http://maven.apache.org">maven</a> make heavy use of them. What they are, is this: any time Copland encounters a value that contains a certain pattern, it replaces that pattern with the value of the same name from the DefaultSymbolSource. The pattern is a dollar sign, followed by curly braces that contain the name of the symbol.</p>
|
|
353
|
+
|
|
354
|
+
<p>For example, suppose you want to allow the application to configure which class gets used when a particular service point is instantiated. You can do this by pulling the name of the class from the DefaultSymbolSource as a substitution symbol:</p>
|
|
355
|
+
|
|
356
|
+
<pre>
|
|
357
|
+
SomeServicePoint:
|
|
358
|
+
implementor: ${the.class.to.use}
|
|
359
|
+
</pre>
|
|
360
|
+
|
|
361
|
+
<p>Then, the application would contribute a value named <code>the.class.to.use</code> to <code>copland.DefaultSymbolSource</code>, and when <code>SomeServicePoint</code> is instantiated, it would use the value thus provided.<br />
|
|
362
|
+
</p>
|
|
363
|
+
</div>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</div>
|
|
369
|
+
|
|
370
|
+
</td></tr>
|
|
371
|
+
</table>
|
|
372
|
+
</body>
|
|
373
|
+
</html>
|