blob: d61673f234160aab78b9b83519b6ad3b9199a8f3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
|
<?xml version="1.0" encoding="utf-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section>
<title>
System Properties
</title>
<section role="h2" id="SystemProperties-ExplanationofSystempropertiesusedinQpid">
<title> Explanation of System properties used in Qpid </title>
<para>
This page documents the various System Properties that are
currently used in the Qpid Java code base.
</para>
<!-- ######################################################### -->
<section role="h3" id="SystemProperties-ClientProperties">
<title> Client Properties </title>
<variablelist>
<varlistentry>
<term>STRICT_AMQP</term>
<listitem>
<variablelist>
<varlistentry>
<term>Type</term>
<listitem><para>Boolean</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>FALSE</para></listitem>
</varlistentry>
</variablelist>
<para> This forces the client to only send AMQP compliant
frames. This will disable a number of JMS features.</para>
<itemizedlist>
<title> Features disabled by STRICT_AMQP</title>
<listitem><para>Queue Browser
</para></listitem>
<listitem><para>Message Selectors
</para></listitem>
<listitem><para>Durable Subscriptions
</para></listitem>
<listitem><para>Session Recover may result in duplicate message delivery
</para></listitem>
<listitem><para>Destination validation, so no InvalidDestinationException
will be thrown
</para></listitem>
</itemizedlist>
<para>
This is associated with property <xref linkend="SystemProperties-STRICTAMQPFATAL"/>
</para>
</listitem>
</varlistentry>
<varlistentry id="SystemProperties-STRICTAMQPFATAL">
<term>STRICT_AMQP_FATAL</term>
<listitem>
<variablelist>
<varlistentry>
<term>Type</term>
<listitem><para>Boolean</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>FALSE</para></listitem>
</varlistentry>
</variablelist>
<para>
This will cause any attempt to utilise an enhanced feature to
throw and UnsupportedOperationException. When set to false then
the exception will not occur but the feature will be disabled.
</para>
<para>
e.g.
The Queue Browser will always show no messages.
Any message selector will be removed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IMMEDIATE_PREFETCH</term>
<listitem>
<variablelist>
<varlistentry>
<term>Type</term>
<listitem><para>Boolean</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>FALSE</para></listitem>
</varlistentry>
</variablelist>
<para>
The default with AMQP is to start prefetching messages. However,
with certain 3rd party Java tools, such as Mule this can cause a
problem. Mule will create a consumer but never consume from it so
any any prefetched messages will be stuck until that session is
closed. This property is used to re-instate the default AMQP
behaviour. The default Qpid behaviour is to prevent prefetch
occurring, by starting the connection Flow Controlled, until a
request for a message is made on the consumer either via a
receive() or setting a message listener.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>amqj.default_syncwrite_timeout</term>
<listitem>
<variablelist>
<varlistentry>
<term>Type</term>
<listitem><para>long</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>30000</para></listitem>
</varlistentry>
</variablelist>
<para> The number length of time in millisecond to wait
for a synchronous write to complete.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>amq.dynamicsaslregistrar.properties</term>
<listitem>
<variablelist>
<varlistentry>
<term>Type</term>
<listitem><para>String</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>org/apache/qpid/client/security/DynamicSaslRegistrar.properties</para></listitem>
</varlistentry>
</variablelist>
<para>The name of the SASL configuration properties file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>amqj.heartbeat.timeoutFactor</term>
<listitem>
<variablelist>
<varlistentry>
<term>Type</term>
<listitem><para>float</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>2.0</para></listitem>
</varlistentry>
</variablelist>
<para>
The factor used to get the timeout from the delay between
heartbeats
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>amqj.tcpNoDelay</term>
<listitem>
<variablelist>
<varlistentry>
<term>Type</term>
<listitem><para>Boolean</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>TRUE</para></listitem>
</varlistentry>
</variablelist>
<para> Disable Nagle's algorithm on the TCP connection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>amqj.sendBufferSize</term>
<listitem>
<variablelist>
<varlistentry>
<term>integer</term>
<listitem><para>Boolean</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>32768</para></listitem>
</varlistentry>
</variablelist>
<para>This is the default buffer sized created by Mina.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>amqj.receiveBufferSize</term>
<listitem>
<variablelist>
<varlistentry>
<term>Type</term>
<listitem><para>integer</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>32768</para></listitem>
</varlistentry>
</variablelist>
<para>This is the default buffer sized created by Mina.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>amqj.protocolprovider.class</term>
<listitem>
<variablelist>
<varlistentry>
<term>Type</term>
<listitem><para>String</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>org.apache.qpid.server.protocol.AMQPFastProtocolHandler</para></listitem>
</varlistentry>
</variablelist>
<para> This specifies the default IoHandlerAdapter that
represents the InVM broker. The IoHandlerAdapter must have
a constructor that takes a single Integer that represents
the InVM port number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>amqj.protocol.logging.level</term>
<listitem>
<variablelist>
<varlistentry>
<term>Type</term>
<listitem><para>Boolean</para></listitem>
</varlistentry>
<varlistentry>
<term>Default</term>
<listitem><para>null</para></listitem>
</varlistentry>
</variablelist>
<para>If set this will turn on protocol logging on the
client. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>jboss.host</term>
<listitem>
<para>
Used by the JBossConnectionFactoryInitialiser to specify the host
to connect to perform JNDI lookups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>jboss.port</term>
<listitem>
<para>
Used by the JBossConnectionFactoryInitialiser to specify the port
to connect to perform JNDI lookups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>amqj.MaximumStateWait</term>
<listitem>
<variablelist>
<varlistentry>
<term>Default</term>
<listitem><para>30000</para></listitem>
</varlistentry>
</variablelist>
<para>
Used to set the maximum time the State Manager should wait before
timing out a frame wait.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- ######################################################### -->
<section role="h3" id="SystemProperties-ManagementProperties">
<title>
Management Properties
</title>
<variablelist>
<varlistentry>
<term>security</term>
<listitem>
<variablelist>
<varlistentry>
<term>Default</term>
<listitem><para>null</para></listitem>
</varlistentry>
</variablelist>
<para>
String representing the Security level to be used to on
the connection to the broker. The null default results
in no security or PLAIN. When used with jmxconnector
'javax.management.remote.jmxmp.JMXMPConnector' a
security value of 'CRAM-MD5' will result in all
communication to the broker being encrypted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>jmxconnector</term>
<listitem>
<variablelist>
<varlistentry>
<term>Default</term>
<listitem><para>null</para></listitem>
</varlistentry>
</variablelist>
<para>
String representing the JMXConnector class used to
perform the connection to the broker. The null default
results in the standard JMX connector. Utilising
'javax.management.remote.jmxmp.JMXMPConnector' and
security 'CRAM-MD5' will result in all communication to
the broker being encrypted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>timeout</term>
<listitem>
<variablelist>
<varlistentry>
<term>Default</term>
<listitem><para>5000</para></listitem>
</varlistentry>
</variablelist>
<para>
Long value representing the milli seconds before
connection to the broker should timeout.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- ######################################################### -->
<section role="h3" id="SystemProperties-PropertiesusedinExamples">
<title> Properties used in Examples </title>
<variablelist>
<varlistentry>
<term>archivepath</term>
<listitem>
<para>
Used in <filename>FileMessageDispatcher</filename>. This
properties specifies the directory to move payload
file(s) to archive location as no error</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
</section>
|
