Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
h2. Broker config.xml format
The broker config.xml file details various options and configuration for the Java Qpid broker implementaiton.

h3. File Format
This is an overview of the top level of the config file. Description of each section is embedded below. Each section is then described in detail in their own section.

{noformat}
<broker>
<!-- Various initial global definitions -->
    <connector>
<!-- Various connection information about the type connections the broker should listen for-->
    <management>
<!-- Enablement of management functionality -->
    <advanced>
<!-- Various advanced flags -->
    <security>
<!-- Definition of available security options -->
    <virtualhosts>
<!-- Definition of available virtual hosts -->
    <heartbeat>
<!-- Heartbeat configuration -->
    <queue>
<!-- General queue configuration options-->
    <virtualhosts>
<!-- Configuariation of various virtual hosts. -->
</broker>

{noformat}

h3. Broker
h2. Broker config.xml format
The broker config.xml file details various options and configuration for the Java Qpid broker implementaiton.

h3. File Format
This is an overview of the top level of the config file. Description of each section is embedded below. Each section is then described in detail in their own section.

{noformat}
<broker>
<!-- Various initial global definitions -->
    <connector>
<!-- Various connection information about the type connections the broker should listen for-->
    <management>
<!-- Enablement of management functionality -->
    <advanced>
<!-- Various advanced flags -->
    <security>
<!-- Definition of available security options -->
    <virtualhosts>
<!-- Definition of available virtual hosts -->
    <heartbeat>
<!-- Heartbeat configuration -->
    <queue>
<!-- General queue configuration options-->
    <virtualhosts>
<!-- Configuariation of various virtual hosts. -->
</broker>

{noformat}

h3. Broker
TBC
{noformat}
<broker>
    <prefix>${QPID_HOME}</prefix>
    <work>${QPID_WORK}</work>
    <conf>${prefix}/etc</conf>
{noformat}

h3. Connector
TBC
{noformat}
    <connector>
        <!-- Uncomment out this block and edit the keystorePath and keystorePassword
             to enable SSL support
        <ssl>
            <enabled>true</enabled>
            <sslOnly>true</sslOnly>
            <keystorePath>/path/to/keystore.ks</keystorePath>
            <keystorePassword>keystorepass</keystorePassword>
        </ssl>-->
        <qpidnio>true</qpidnio>
        <transport>nio</transport>
        <port>5672</port>
        <sslport>8672</sslport>
        <socketReceiveBuffer>32768</socketReceiveBuffer>
        <socketSendBuffer>32768</socketSendBuffer>
    </connector>
{noformat}

h3. Management
TBC
{noformat}
    <management>
        <enabled>true</enabled>
    </management>
{noformat}

h3. Advanced
TBC
{noformat}
    <advanced>
      {noformat}
<broker>
 <filterchain enableExecutorPool="true"/>
        <enablePooledAllocator>false</enablePooledAllocator>
       <prefix>${QPID_HOME}</prefix> <enableDirectBuffers>false</enableDirectBuffers>
    <work>${QPID_WORK}</work>
    <framesize>65535</framesize>
      <conf>${prefix}/etc</conf>  <compressBufferOnQueue>false</compressBufferOnQueue>
    </advanced>
{noformat}

h3. Connector
TBC
{noformat}
    <connector>
        <!-- Uncomment out this block and edit the keystorePath and keystorePassword
             to enable SSL support
        <ssl>
            <enabled>true</enabled>
            <sslOnly>true</sslOnly>
            <keystorePath>/path/to/keystore.ks</keystorePath>
            <keystorePassword>keystorepass</keystorePassword>
        </ssl>-->
        <qpidnio>true</qpidnio>
        <transport>nio</transport>
        <port>5672</port>
        <sslport>8672</sslport>
        <socketReceiveBuffer>32768</socketReceiveBuffer>
        <socketSendBuffer>32768</socketSendBuffer>
    </connector>
{noformat}

h3. Management
TBC
{noformat}
    <management>
        <enabled>true</enabled>
    </management>
{noformat}

h3. Advanced
TBC
{noformat}
    <advanced>
        <filterchain enableExecutorPool="true"/>
        <enablePooledAllocator>false</enablePooledAllocator>
        <enableDirectBuffers>false</enableDirectBuffers>
        <framesize>65535</framesize>
        <compressBufferOnQueue>false</compressBufferOnQueue>
    </advanced>
{noformat}

h3. Security
TBC
{noformat}
    <security>
        <principal-databases>
            <principal-database>
                <name>passwordfile</name>
                <class>org.apache.qpid.server.security.auth.PasswordFilePrincipalDatabase</class>
                <attributes>
                    <attribute>
                        <name>passwordFile</name>
                        <value>$\{conf\}/passwd</value>
                    </attribute>
                </attributes>
            </principal-database>
        </principal-databases>
        <sasl>
            <mechanisms>
                <mechanism>
                    <initialiser>
                        <class>org.apache.qpid.server.security.auth.CRAMMD5Initialiser</class>
                        <principal-database>passwordfile</principal-database>
                    </initialiser>
                </mechanism>
                <mechanism>
                    <initialiser>
                        <class>org.apache.qpid.server.security.auth.amqplain.AmqPlainInitialiser</class>
                        <principal-database>passwordfile</principal-database>
                    </initialiser>
                </mechanism>
                <mechanism>
                    <initialiser>
                        <class>org.apache.qpid.server.security.auth.plain.PlainInitialiser</class>
                        <principal-database>passwordfile</principal-database>
                    </initialiser>
                </mechanism>
            </mechanisms>
        </sasl>
    </security>
{noformat}

h3. Virtualhosts
{noformat}
	<virtualhosts>
		<virtualhost>
			<name>localhost</name>
			<localhost>
			    <store>
					<class>org.apache.qpid.server.store.berkeleydb.BDBMessageStore</class>
					<environment-path>${work}/bdb/localhost-store</environment-path>
			    </store>		
			</localhost>
		</virtualhost>
		
		<virtualhost>
			<name>development</name>
			<development>
			    <store>
					<class>org.apache.qpid.server.store.berkeleydb.BDBMessageStore</class>
					<environment-path>${work}/bdb/dev-store</environment-path>					
			    </store>			
			</development>
		</virtualhost>
		
		<virtualhost>
			<name>test</name>
			<test>
			    <store>
					<class>org.apache.qpid.server.store.berkeleydb.BDBMessageStore</class>
					<environment-path>${work}/bdb/test-store</environment-path>
			    </store>			
			</test>
		</virtualhost>
		
	</virtualhosts>
{noformat}

h3. Heartbeat
TBC
{noformat}
    <heartbeat>
        <delay>0</delay>
        <timeoutFactor>2.0</timeoutFactor>
    </heartbeat>
{noformat}

h3. Queue
TBC
{noformat}
    <queue>
        <auto_register>true</auto_register>
    </queue>
{noformat}

h3. Virtualhosts
TBC
{noformat}
    <virtualhosts>${conf}/virtualhosts.xml</virtualhosts>
{noformat}
  <filterchain enableExecutorPool="true"/>
        <enablePooledAllocator>false</enablePooledAllocator>
        <enableDirectBuffers>false</enableDirectBuffers>
        <framesize>65535</framesize>
        <compressBufferOnQueue>false</compressBufferOnQueue>
    </advanced>
{noformat}

h3. Security
TBC
{noformat}
    <security>
        <principal-databases>
            <principal-database>
                <name>passwordfile</name>
                <class>org.apache.qpid.server.security.auth.PasswordFilePrincipalDatabase</class>
                <attributes>
                    <attribute>
                        <name>passwordFile</name>
                        <value>${conf}/passwd</value>
                    </attribute>
                </attributes>
            </principal-database>
        </principal-databases>
        <sasl>
            <mechanisms>
                <mechanism>
                    <initialiser>
                        <class>org.apache.qpid.server.security.auth.CRAMMD5Initialiser</class>
                        <principal-database>passwordfile</principal-database>
                    </initialiser>
                </mechanism>
                <mechanism>
                    <initialiser>
                        <class>org.apache.qpid.server.security.auth.amqplain.AmqPlainInitialiser</class>
                        <principal-database>passwordfile</principal-database>
                    </initialiser>
                </mechanism>
                <mechanism>
                    <initialiser>
                        <class>org.apache.qpid.server.security.auth.plain.PlainInitialiser</class>
                        <principal-database>passwordfile</principal-database>
                    </initialiser>
                </mechanism>
            </mechanisms>
        </sasl>
    </security>
{noformat}

h3. Virtualhosts
{noformat}
	<virtualhosts>
		<virtualhost>
			<name>localhost</name>
			<localhost>
			    <store>
					<class>org.apache.qpid.server.store.berkeleydb.BDBMessageStore</class>
					<environment-path>${work}/bdb/localhost-store</environment-path>
			    </store>		
			</localhost>
		</virtualhost>
		
		<virtualhost>
			<name>development</name>
			<development>
			    <store>
					<class>org.apache.qpid.server.store.berkeleydb.BDBMessageStore</class>
					<environment-path>${work}/bdb/dev-store</environment-path>					
			    </store>			
			</development>
		</virtualhost>
		
		<virtualhost>
			<name>test</name>
			<test>
			    <store>
					<class>org.apache.qpid.server.store.berkeleydb.BDBMessageStore</class>
					<environment-path>${work}/bdb/test-store</environment-path>
			    </store>			
			</test>
		</virtualhost>
		
	</virtualhosts>
{noformat}

h3. Heartbeat
TBC
{noformat}
    <heartbeat>
        <delay>0</delay>
        <timeoutFactor>2.0</timeoutFactor>
    </heartbeat>
{noformat}

h3. Queue
TBC
{noformat}
    <queue>
        <auto_register>true</auto_register>
    </queue>
{noformat}

h3. Virtualhosts
TBC
{noformat}
    <virtualhosts>${conf}/virtualhosts.xml</virtualhosts>
{noformat}