[CONF] Apache Qpid: Qpid Java FAQ (page edited)

[confluence]

Page Edited : qpid : Qpid Java FAQ Qpid Java FAQ has been edited by Martin Ritchie (Mar 22, 2007). Change summary: added My client application appears to have hung? (View changes) Content: What is Qpid ? The java implementation of Qpid is a pure Java message broker that implements the AMQP protocol. Essentially, Qpid is a robust, performant middleware component that can handle your messaging traffic. One of the most attractive aspects of Qpid is its cost - there is no licensing cost  ! It currently supports the following features: High performance header-based routing for messages Most features required by the JMS 1.1 specification. See our roadmap for details of missing JMS features and when we expect to add them. Transaction support Persistence using the high performance Berkeley DB Java Edition. The persistence layer is also pluggable should an alternative implementation be required. Pluggable security using SASL. Any Java SASL provider should be capable of working with Blaze. Management using JMX and MC4J (again see our roadmap for details of this feature and our future plans in this area) Clustering for scalability .NET API implementation (currently an alpha release; see our roadmap) Can you help me get started with Qpid? Have a look at our Getting Started Guide How do I install the Qpid broker ? Please follow the instructions provided on our Getting Started Guide. How do I run the Qpid broker ? The broker comes with a script for unix/linux/cygwin called qpid-server, which can be found in the bin directory of the installed package. This command can be executed without any paramters and will then use the default configuration file provided on install. For the Windows OS, please use qpid-server.bat. There's no need to set your classpath for QPID as the scripts take care of that by adding jar's with classpath defining manifest files to your classpath. For more information on running the broker please see our Getting Started page. How can I create a connection using a URL ? The format for connection URL in QPID is as follows: amqp://[user:[EMAIL PROTECTED]/virtualhost?brokerlist='[transport://]host[:port][?option='value'[&option='value']];' [&failover='method[?option='value'[&option='value']]'] [&option='value']" Don't be alarmed - it's really not that complex ! You could use a URL which looks something like this: amqp://guest:[EMAIL PROTECTED]/development?brokerlist='tcp://localhost:5672' Breaking this example down, here's what it all means: amqp = the protocol we're using guest:[EMAIL PROTECTED] = username:[EMAIL PROTECTED] where the clientid is the name of your server (used under the covers but don't worry about this for now). Always use the guest:guest combination at the moment. development = the name of the virtualhost, where the virtualhost is a path which acts as a namespace. You can effectively use any value here so long as you're consistent throughout. The virtualhost must start with a slash "/" and continue with names separated by slashes. A name consists of any combination of at least one of [A-Za-z0-9] plus zero or more of [.-_+!=:]. brokerlist = this is the host address and port for the broker you want to connect to. The connection factory will assume tcp if you don't specify a transport protocol. The port also defaults to 5672. Naturally you have to put at least one broker in this list. This example is not using failover so only provides one host for the broker. If you do wish to connect using failover you can provide two (or more) brokers in the format: brokerlist='tcp://host1;tcp://host2:5673' The default failover setup will automatically retry each broker once after a failed connection. If the brokerlist contains more than one server then these servers are tried in a round robin. Details on how to modifiy this behaviour will follow soon ! How do I represent a JMS Destination string with QPID ? Queues A queue can be created in QPID using the following URL format. direct://amq.direct//<Queue Name> For example: direct://amq.direct//simpleQueue Queue names may consist of any mixture of digits, letters, and underscores. Topics A topic can be created in QPID using the following URL format. topic://amq.topic/<Topic Subscription>/ The topic subscription may only contain the letters A-Z and a-z and digits 0-9. cloak.memory.duration = 0 The topic subscription is formed from a series of words that may only contain the letters A-Z and a-z and digits 0-9. The words are delimited by dots. Each dot represents a new level. For example: stocks.nyse.ibm Wildcards can be used on subscription with the following meaning. match a single level # match zero or more levels For example: With two clients 1 - stocks.*.ibm 2 - stocks.#.ibm Publishing stocks.nyse.ibm will be received by both clients but stocks.ibm and stocks.world.us.ibm will only be received by client 2. The topic currently does not support wild cards. How do I connect to the broker using JNDI ? see How to use JNDI I'm using Spring and Weblogic - can you help me with the configuration for moving over to Qpid ? Here is a donated Spring configuration file appContext.zip which shows the config for Qpid side by side with Weblogic. HtH ! How do I configure the logging level for Qpid ? The system property amqj.logging.level can be used to configure the logging level. For the broker, you can use the environment variable AMQJ_LOGGING_LEVEL which is picked up by the qpid-run script (called by qpid-server to start the broker) at runtime. For client code that you've written, simply pass in a system property to your command line to set it to the level you'd like i.e. -Damqj.logging.level=INFO The log level for the broker defaults to INFO if the env variable is not set, but you may find that your log4j properties affect this. Setting the property noted above should address this. How can I configure the broker ? The broker configuration is contained in the <installed-dir>/etc/config.xml file. You can copy and edit this file and then specify your own configuration file as a parameter to the startup script using the -c flag i.e. qpid-server -c <your_config_file's_path> For more detailed information on configuration, please see Qpid Design - Configuration How can I change the port the broker uses at runtime ? The broker defaults to use port 5672 at startup. To change this, use the -p flag at startup i.e. qpid-server -p <port_number_to_use> Use this to get round any issues on your host server with port 5672 being in use/unavailable. For more detailed information on configuration, please see Qpid Design - Configuration What command line options can I pass into the qpid-server script ? The following options are available: Option Long Option Description b bind Bind to the specified address overriding any value in the config file c config Use the given configuration file h help Prints list of options l logconfig Use the specified log4j.xml file rather than that in the etc directory p port Specify port to listen on. Overrides value in config file v version Print version information and exit w logwatch Specify interval for checking for logging config changes. Zero means no checking For more detailed information on configuration, please see Qpid Design - Configuration How do I authenticate with the broker ? What user id & password should I use ? You should login as user guest with password guest How do I create queues that will always be instantiated at broker startup ? You can configure queues which will be created at broker startup by tailoring a copy of the virtualhosts.xml file provided in the installed qpid-version/etc directory. So, if you're using a queue called 'MY_QUEUE' you can ensure that it is created at startup by using an entry something like this: <virtualhosts> <virtualhost> <path>/temp</path> <bind>direct://amq.direct//MY_QUEUE</bind> </virtualhost> </virtualhosts> Note that the path element should match the virtualhost that you're using to create connections to the broker. This is effectively a namespace used to prevent queue name clashes etc. You can amend the config.xml to point at a different virtualhosts.xml file by editing the <virtualhosts/> element. So, for example, you could tell the broker to use a file in your home directory by creating a new config.xml file with the following entry: <virtualhosts>/home/myhomedir/virtualhosts.xml</virtualhosts> You can then pass this amended config.xml into the broker at startup using the -c flag i.e. qpid-server -c <path>/config.xml Where do undeliverable messages end up ? At present, messages with an invalid routing key will be returned to the sender. If you register an exception listener for your publisher (easiest to do by making your publisher implement the ExceptionListener interface and coding the onException method) you'll see that you end up in onException in this case. You can expect to be catching a subclass of org.apache.qpid.AMQUndeliveredException. Can I configure the name of the Qpid broker log file at runtime ? If you simply start the Qpid broker using the default configuration, then the log file is written to $QPID_WORK/log/qpid.log This is not ideal if you want to run several instances from one install, or acrhive logs to a shared drive from several hosts. To make life easier, there are two optional ways to configure the naming convention used for the broker log. Setting a prefix or suffix Users should set the following environment variables before running qpid-server: QPID_LOG_PREFIX - will prefix the log file name with the specified value e.g. if you set this value to be the name of your host (for example) it could look something like host123qpid.log QPID_LOG_SUFFIX - will suffix the file name with the specified value e.g. if you set this value to be the name of your application (for example) if could look something like qpidMyApp.log Including the PID Setting either of these variables to the special value PID will introduce the process id of the java process into the file name as a prefix or suffix as specified** My client application appears to have hung? The client code currently has various timeouts scattered throughout the code. These can cause your client to appear like it has hung when it is actually waiting for the timeout ot compelete. One example is when the broker becomes non-responsive, the client code has a hard coded 2 minute timeout that it will wait when closing a connection. These timeouts need to be consolidated and exposed. see QPID-429 How do I contact the Qpid team ? For now, subscribe to our [EMAIL PROTECTED] list (email [EMAIL PROTECTED]). A users list is expected shortly !

Powered by Atlassian Confluence (Version: 2.2.9 Build:#527 Sep 07, 2006) - Bug/feature request

Unsubscribe or edit your notifications preferences