qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Qpid > System Properties
Date Wed, 28 Sep 2011 15:35:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2042/9/21/_/styles/combined.css?spaceKey=qpid&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/qpid/System+Properties">System
Properties</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~k-wall">keith
wall</a>
    </h4>
        <div id="versionComment">
        <b>Comment:</b>
        Add qpid.amqp.version to list of client properties.  It has been supported for sometime.<br
/>
    </div>
        <br/>
                         <h4>Changes (6)</h4>
                                 
    
<div id="page-diffs">
                    <table class="diff" cellpadding="0" cellspacing="0">
    
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" > <br>h4. STRICT_AMQP <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">
<br></td></tr>
            <tr><td class="diff-unchanged" >Type : boolean <br>Default :
FALSE <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" > <br>h4. STRICT_AMQP_FATAL <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">
<br></td></tr>
            <tr><td class="diff-unchanged" >Type : boolean <br>Default :
FALSE <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" > <br>h4. IMMEDIATE_PREFETCH
<br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">
<br></td></tr>
            <tr><td class="diff-unchanged" >Type : boolean <br>Default :
FALSE <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" > <br>h4. amqj.default_syncwrite_timeout
<br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">
<br></td></tr>
            <tr><td class="diff-unchanged" >Type : long <br>Default: 30000
<br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" >Used to set the maximum time the State
Manager should wait before timing out a frame wait. <br> <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">h4.
qpid.amqp.version <br></td></tr>
            <tr><td class="diff-unchanged" > <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">Default
: 0-10 <br>Used to restrict the client to a particular version of the AMQP Protocol.
 Client will begin negotiation at the specified version and only negotiate _downwards_ if
the broker does not support the specified version. <br> <br></td></tr>
            <tr><td class="diff-unchanged" >{anchor:management} <br> <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
    
            </table>
    </div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <h2><a name="SystemProperties-ExplanationofSystempropertiesusedinQpid"></a>Explanation
of System properties used in Qpid</h2>

<p>This page documents the various System Properties that are currently used in the
Qpid Java code base.</p>
<div>
<ul>
    <li><a href='#SystemProperties-ClientProperties'>Client Properties</a></li>
<ul>
    <li><a href='#SystemProperties-STRICTAMQP'>STRICT_AMQP</a></li>
<ul>
    <li><a href='#SystemProperties-FeaturesdisabledbySTRICTAMQP'>Features disabled
by STRICT_AMQP</a></li>
</ul>
    <li><a href='#SystemProperties-STRICTAMQPFATAL'>STRICT_AMQP_FATAL</a></li>
    <li><a href='#SystemProperties-IMMEDIATEPREFETCH'>IMMEDIATE_PREFETCH</a></li>
    <li><a href='#SystemProperties-amqj.defaultsyncwritetimeout'>amqj.default_syncwrite_timeout</a></li>
    <li><a href='#SystemProperties-amq.dynamicsaslregistrar.properties'>amq.dynamicsaslregistrar.properties</a></li>
    <li><a href='#SystemProperties-amqj.heartbeat.timeoutFactor'>amqj.heartbeat.timeoutFactor</a></li>
    <li><a href='#SystemProperties-amqj.tcpNoDelay'>amqj.tcpNoDelay</a></li>
    <li><a href='#SystemProperties-amqj.sendBufferSize'>amqj.sendBufferSize</a></li>
    <li><a href='#SystemProperties-amqj.receiveBufferSize'>amqj.receiveBufferSize</a></li>
    <li><a href='#SystemProperties-amqj.protocolprovider.class'>amqj.protocolprovider.class</a></li>
    <li><a href='#SystemProperties-amqj.protocol.logging.level'>amqj.protocol.logging.level</a></li>
    <li><a href='#SystemProperties-jboss.host'>jboss.host</a></li>
    <li><a href='#SystemProperties-jboss.port'>jboss.port</a></li>
    <li><a href='#SystemProperties-amqj.MaximumStateWait'>amqj.MaximumStateWait</a></li>
    <li><a href='#SystemProperties-qpid.amqp.version'>qpid.amqp.version</a></li>
</ul>
    <li><a href='#SystemProperties-ManagementProperties'>Management Properties</a></li>
<ul>
    <li><a href='#SystemProperties-security'>security</a></li>
    <li><a href='#SystemProperties-jmxconnector'>jmxconnector</a></li>
    <li><a href='#SystemProperties-timeout'>timeout</a></li>
</ul>
    <li><a href='#SystemProperties-PropertiesusedinExamples'>Properties used in
Examples</a></li>
<ul>
    <li><a href='#SystemProperties-archivepath'>archivepath</a></li>
</ul>
</ul></div>

<p><a name="SystemProperties-client"></a></p>

<h3><a name="SystemProperties-ClientProperties"></a>Client Properties</h3>

<p><a name="SystemProperties-STRICTAMQP"></a></p>

<h4><a name="SystemProperties-STRICTAMQP"></a>STRICT_AMQP</h4>

<p>Type : boolean<br/>
Default : FALSE<br/>
This forces the client to only send AMQP compliant frames. This will disable a number of JMS
features.</p>

<h5><a name="SystemProperties-FeaturesdisabledbySTRICTAMQP"></a>Features
disabled by STRICT_AMQP</h5>

<ul>
	<li>Queue Browser</li>
	<li>Message Selectors</li>
	<li>Durable Subscriptions</li>
	<li>Session Recover may result in duplicate message delivery</li>
	<li>Destination validation, so no InvalidDestinationException will be thrown</li>
</ul>


<p>This is associated with property <a href="#SystemProperties-STRICTAMQPFATAL">STRICT_AMQP_FATAL</a></p>



<p><a name="SystemProperties-STRICTAMQPFATAL"></a></p>

<h4><a name="SystemProperties-STRICTAMQPFATAL"></a>STRICT_AMQP_FATAL</h4>

<p>Type : boolean<br/>
Default : FALSE</p>

<p>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.</p>

<p>e.g.<br/>
The Queue Browser will always show no messages.<br/>
Any message selector will be removed.</p>


<p><a name="SystemProperties-IMMEDIATEPREFETCH"></a></p>

<h4><a name="SystemProperties-IMMEDIATEPREFETCH"></a>IMMEDIATE_PREFETCH</h4>

<p>Type : boolean<br/>
Default : FALSE</p>

<p>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.</p>


<h4><a name="SystemProperties-amqj.defaultsyncwritetimeout"></a>amqj.default_syncwrite_timeout</h4>

<p>Type : long<br/>
Default: 30000<br/>
The number length of time in millisecond to wait for a synchronous write to complete.</p>

<h4><a name="SystemProperties-amq.dynamicsaslregistrar.properties"></a>amq.dynamicsaslregistrar.properties</h4>

<p>Type : String<br/>
Default: org/apache/qpid/client/security/DynamicSaslRegistrar.properties<br/>
The name of the SASL configuration properties file.</p>


<h4><a name="SystemProperties-amqj.heartbeat.timeoutFactor"></a>amqj.heartbeat.timeoutFactor</h4>

<p>Type : float<br/>
Default : 2.0<br/>
The factor used to get the timeout from the delay between heartbeats</p>


<h4><a name="SystemProperties-amqj.tcpNoDelay"></a>amqj.tcpNoDelay</h4>

<p>Type : boolean<br/>
Default : TRUE<br/>
Disable Nagle's algorithm on the TCP connection.</p>


<h4><a name="SystemProperties-amqj.sendBufferSize"></a>amqj.sendBufferSize</h4>

<p>Type :  integer<br/>
Default : 32768<br/>
This is the default buffer sized created by Mina.</p>


<h4><a name="SystemProperties-amqj.receiveBufferSize"></a>amqj.receiveBufferSize</h4>

<p>Type : integer<br/>
Default : 32768<br/>
This is the default buffer sized created by Mina.</p>


<h4><a name="SystemProperties-amqj.protocolprovider.class"></a>amqj.protocolprovider.class</h4>

<p>Type : String<br/>
Default : org.apache.qpid.server.protocol.AMQPFastProtocolHandler<br/>
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.</p>

<h4><a name="SystemProperties-amqj.protocol.logging.level"></a>amqj.protocol.logging.level</h4>

<p>Type : boolean<br/>
Default : null<br/>
If set this will turn on protocol logging on the client</p>

<h4><a name="SystemProperties-jboss.host"></a>jboss.host</h4>

<p>Used by the JBossConnectionFactoryInitialiser to specify the host to connect to perform
JNDI lookups.</p>

<h4><a name="SystemProperties-jboss.port"></a>jboss.port</h4>

<p>Used by the JBossConnectionFactoryInitialiser to specify the port to connect to perform
JNDI lookups.</p>

<h4><a name="SystemProperties-amqj.MaximumStateWait"></a>amqj.MaximumStateWait</h4>

<p>Default : 30000<br/>
Used to set the maximum time the State Manager should wait before timing out a frame wait.</p>

<h4><a name="SystemProperties-qpid.amqp.version"></a>qpid.amqp.version</h4>

<p>Default : 0-10<br/>
Used to restrict the client to a particular version of the AMQP Protocol.  Client will begin
negotiation at the specified version and only negotiate <em>downwards</em> if
the broker does not support the specified version.</p>

<p><a name="SystemProperties-management"></a></p>

<h3><a name="SystemProperties-ManagementProperties"></a>Management Properties</h3>

<h4><a name="SystemProperties-security"></a>security</h4>

<p>Default: null<br/>
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.</p>

<h4><a name="SystemProperties-jmxconnector"></a>jmxconnector</h4>

<p>Default: null<br/>
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.</p>

<h4><a name="SystemProperties-timeout"></a>timeout</h4>

<p>Default: 5000<br/>
Long value representing the milli seconds before connection to the broker should timeout.</p>


<p><a name="SystemProperties-examples"></a></p>

<h3><a name="SystemProperties-PropertiesusedinExamples"></a>Properties used
in Examples</h3>

<h4><a name="SystemProperties-archivepath"></a>archivepath</h4>

<p>Used in : FileMessageDispatcher<br/>
This properties specifies the directory to move payload file(s) to archive location as no
error</p>
    </div>
        <div id="commentsSection" class="wiki-content pageSection">
        <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
        </div>
        <a href="https://cwiki.apache.org/confluence/display/qpid/System+Properties">View
Online</a>
        |
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=103546&revisedVersion=6&originalVersion=5">View
Changes</a>
                |
        <a href="https://cwiki.apache.org/confluence/display/qpid/System+Properties?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project:      http://qpid.apache.org
Use/Interact: mailto:commits-subscribe@qpid.apache.org


Mime
View raw message