blob: 656eff3a561f7b6c52c455aa2ec96b77e143b256 [file] [log] [blame]
<!DOCTYPE html>
<!--
-
- 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.
-
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>Chapter&#160;1.&#160;HelloWorld Example - Apache Qpid&#8482;</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<link rel="stylesheet" href="/site.css" type="text/css" async="async"/>
<link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/>
<script type="text/javascript">var _deferredFunctions = [];</script>
<script type="text/javascript" src="/deferred.js" defer="defer"></script>
<!--[if lte IE 8]>
<link rel="stylesheet" href="/ie.css" type="text/css"/>
<script type="text/javascript" src="/html5shiv.js"></script>
<![endif]-->
<!-- Redirects for `go get` and godoc.org -->
<meta name="go-import"
content="qpid.apache.org git https://git-wip-us.apache.org/repos/asf/qpid-proton.git"/>
<meta name="go-source"
content="qpid.apache.org
https://github.com/apache/qpid-proton/blob/go1/README.md
https://github.com/apache/qpid-proton/tree/go1{/dir}
https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/>
</head>
<body>
<div id="-content">
<div id="-top" class="panel">
<a id="-menu-link"><img width="16" height="16" src="" alt="Menu"/></a>
<a id="-search-link"><img width="22" height="16" src="" alt="Search"/></a>
<ul id="-global-navigation">
<li><a id="-logotype" href="/index.html">Apache Qpid<sup>&#8482;</sup></a></li>
<li><a href="/documentation.html">Documentation</a></li>
<li><a href="/download.html">Download</a></li>
<li><a href="/discussion.html">Discussion</a></li>
</ul>
</div>
<div id="-menu" class="panel" style="display: none;">
<div class="flex">
<section>
<h3>Project</h3>
<ul>
<li><a href="/overview.html">Overview</a></li>
<li><a href="/components/index.html">Components</a></li>
<li><a href="/releases/index.html">Releases</a></li>
</ul>
</section>
<section>
<h3>Messaging APIs</h3>
<ul>
<li><a href="/proton/index.html">Qpid Proton</a></li>
<li><a href="/components/jms/index.html">Qpid JMS</a></li>
<li><a href="/components/messaging-api/index.html">Qpid Messaging API</a></li>
</ul>
</section>
<section>
<h3>Servers and tools</h3>
<ul>
<li><a href="/components/broker-j/index.html">Broker-J</a></li>
<li><a href="/components/cpp-broker/index.html">C++ broker</a></li>
<li><a href="/components/dispatch-router/index.html">Dispatch router</a></li>
</ul>
</section>
<section>
<h3>Resources</h3>
<ul>
<li><a href="/dashboard.html">Dashboard</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/qpid/Index">Wiki</a></li>
<li><a href="/resources.html">More resources</a></li>
</ul>
</section>
</div>
</div>
<div id="-search" class="panel" style="display: none;">
<form action="http://www.google.com/search" method="get">
<input type="hidden" name="sitesearch" value="qpid.apache.org"/>
<input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/>
<button type="submit">Search</button>
<a href="/search.html">More ways to search</a>
</form>
</div>
<div id="-middle" class="panel">
<ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-jms-amqp-0-x-6.3.1/index.html">Qpid JMS AMQP 0-x 6.3.1</a></li><li><a href="/releases/qpid-jms-amqp-0-x-6.3.1/jms-amqp-0-10-book/index.html">Apache Qpid JMS Client for AMQP 0-10</a></li><li>Chapter&#160;1.&#160;HelloWorld Example</li></ul>
<div id="-middle-content">
<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter&#160;1.&#160;HelloWorld Example</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="JMS-Client-0-10-Book.html">Prev</a>&#160;</td><th align="center" width="60%">&#160;</th><td align="right" width="20%">&#160;<a accesskey="n" href="JMS-Client-0-10-Configuring.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="JMS-Client-0-10-Example"></a>Chapter&#160;1.&#160;HelloWorld Example</h1></div></div></div><p>The following program shows how to send and receive a
message using the Apache Qpid JMS client for AMQP 0-10 . JMS programs typically use
JNDI to obtain connection factory and destination objects which
the application needs. In this way the configuration is kept
separate from the application code itself.</p><p>In this example, we create a JNDI context using a
properties file, use the context to lookup a connection factory,
create and start a connection, create a session, and lookup a
destination from the JNDI context. Then we create a producer and
a consumer, send a message with the producer and receive it with
the consumer. This code should be straightforward for anyone
familiar with JMS.</p><div class="example"><a id="d0e12"></a><p class="title"><strong>Example&#160;1.1.&#160;"Hello world!" in Java</strong></p><div class="example-contents"><pre class="programlisting" xml:lang="java">
package org.apache.qpid.example.jmsexample.hello;
import javax.jms.*;
import javax.naming.Context;
import javax.naming.InitialContext;
import java.util.Properties;
public class Hello {
public Hello() {
}
public static void main(String[] args) {
Hello producer = new Hello();
producer.runTest();
}
private void runTest() {
try {
Properties properties = new Properties();
properties.load(this.getClass().getResourceAsStream("hello.properties")); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-properties" id="hello-java-properties"><span><img alt="1" border="0" src="images/callouts/1.png" /></span></a>
Context context = new InitialContext(properties); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-context" id="hello-java-context"><span><img alt="2" border="0" src="images/callouts/2.png" /></span></a>
ConnectionFactory connectionFactory
= (ConnectionFactory) context.lookup("qpidConnectionfactory"); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-connection-factory" id="hello-java-connection-factory"><span><img alt="3" border="0" src="images/callouts/3.png" /></span></a>
Connection connection = connectionFactory.createConnection(); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-connection" id="hello-java-connection"><span><img alt="4" border="0" src="images/callouts/4.png" /></span></a>
connection.start(); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-start" id="hello-java-start"><span><img alt="5" border="0" src="images/callouts/5.png" /></span></a>
Session session=connection.createSession(false,Session.AUTO_ACKNOWLEDGE);<a class="co" href="JMS-Client-0-10-Example.html#callout-java-session" id="hello-java-session"><span><img alt="6" border="0" src="images/callouts/6.png" /></span></a>
Destination destination = (Destination) context.lookup("topicExchange"); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-destination" id="hello-java-destination"><span><img alt="7" border="0" src="images/callouts/7.png" /></span></a>
MessageProducer messageProducer = session.createProducer(destination); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-producer" id="hello-java-producer"><span><img alt="8" border="0" src="images/callouts/8.png" /></span></a>
MessageConsumer messageConsumer = session.createConsumer(destination); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-consumer" id="hello-java-consumer"><span><img alt="9" border="0" src="images/callouts/9.png" /></span></a>
TextMessage message = session.createTextMessage("Hello world!");
messageProducer.send(message);
message = (TextMessage)messageConsumer.receive(); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-receive" id="hello-java-receive"><span><img alt="10" border="0" src="images/callouts/10.png" /></span></a>
System.out.println(message.getText());
connection.close(); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-close" id="hello-java-close"><span><img alt="11" border="0" src="images/callouts/11.png" /></span></a>
context.close(); <a class="co" href="JMS-Client-0-10-Example.html#callout-java-jndi-close" id="hello-java-jndi-close"><span><img alt="12" border="0" src="images/callouts/12.png" /></span></a>
}
catch (Exception exp) {
exp.printStackTrace();
}
}
}
</pre></div></div><br class="example-break" /><div class="calloutlist"><table border="0" summary="Callout list"><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-properties"></a><a href="#hello-java-properties"><span><img alt="1" border="0" src="images/callouts/1.png" /></span></a> </p></td><td align="left" valign="top"><p>Loads the JNDI properties file, which specifies connection properties, queues, topics, and addressing options. See below for further details.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-context"></a><a href="#hello-java-context"><span><img alt="2" border="0" src="images/callouts/2.png" /></span></a> </p></td><td align="left" valign="top"><p>Creates the JNDI initial context.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-connection-factory"></a><a href="#hello-java-connection-factory"><span><img alt="3" border="0" src="images/callouts/3.png" /></span></a> </p></td><td align="left" valign="top"><p>Creates a JMS connection factory for Qpid.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-connection"></a><a href="#hello-java-connection"><span><img alt="4" border="0" src="images/callouts/4.png" /></span></a> </p></td><td align="left" valign="top"><p>Creates a JMS connection.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-start"></a><a href="#hello-java-start"><span><img alt="5" border="0" src="images/callouts/5.png" /></span></a> </p></td><td align="left" valign="top"><p>Activates the connection.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-session"></a><a href="#hello-java-session"><span><img alt="6" border="0" src="images/callouts/6.png" /></span></a> </p></td><td align="left" valign="top"><p>Creates a session. This session is not transactional (transactions='false'), and messages are automatically acknowledged.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-destination"></a><a href="#hello-java-destination"><span><img alt="7" border="0" src="images/callouts/7.png" /></span></a> </p></td><td align="left" valign="top"><p>Creates a destination for the topic exchange, so senders and receivers can use it.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-producer"></a><a href="#hello-java-producer"><span><img alt="8" border="0" src="images/callouts/8.png" /></span></a> </p></td><td align="left" valign="top"><p>Creates a producer that sends messages to the topic exchange.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-consumer"></a><a href="#hello-java-consumer"><span><img alt="9" border="0" src="images/callouts/9.png" /></span></a> </p></td><td align="left" valign="top"><p>Creates a consumer that reads messages from the topic exchange.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-receive"></a><a href="#hello-java-receive"><span><img alt="10" border="0" src="images/callouts/10.png" /></span></a> </p></td><td align="left" valign="top"><p>Reads the next available message.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-close"></a><a href="#hello-java-close"><span><img alt="11" border="0" src="images/callouts/11.png" /></span></a> </p></td><td align="left" valign="top"><p>Closes the connection, all sessions managed by the connection, and all senders and receivers managed by each session.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-java-jndi-close"></a><a href="#hello-java-jndi-close"><span><img alt="12" border="0" src="images/callouts/12.png" /></span></a> </p></td><td align="left" valign="top"><p>Closes the JNDI context.</p></td></tr></table></div><p>The contents of the hello.properties file are shown below.</p><div class="example"><a id="d0e80"></a><p class="title"><strong>Example&#160;1.2.&#160;JNDI Properties File for "Hello world!" example</strong></p><div class="example-contents"><pre class="programlisting">
java.naming.factory.initial
= org.apache.qpid.jndi.PropertiesFileInitialContextFactory
# connectionfactory.[jndiname] = [ConnectionURL]
connectionfactory.qpidConnectionfactory
= amqp://guest:guest@clientid/test?brokerlist='tcp://localhost:5672' <a class="co" href="JMS-Client-0-10-Example.html#callout-hello-properties-connectionfactory" id="hello-properties-connectionfactory"><span><img alt="1" border="0" src="images/callouts/1.png" /></span></a>
# destination.[jndiname] = [address_string]
destination.topicExchange = amq.topic <a class="co" href="JMS-Client-0-10-Example.html#callout-hello-properties-destination" id="hello-properties-destination"><span><img alt="2" border="0" src="images/callouts/2.png" /></span></a>
</pre></div></div><br class="example-break" /><div class="calloutlist"><table border="0" summary="Callout list"><tr><td align="left" valign="top" width="5%"><p><a id="callout-hello-properties-connectionfactory"></a><a href="#hello-properties-connectionfactory"><span><img alt="1" border="0" src="images/callouts/1.png" /></span></a> </p></td><td align="left" valign="top"><p>Defines a connection factory from which connections
can be created. The syntax of a ConnectionURL is given in
<a class="xref" href="JMS-Client-0-10-Configuring-JNDI.html" title="2.2.&#160;JNDI Properties">Section&#160;2.2, &#8220;JNDI Properties&#8221;</a>.</p></td></tr><tr><td align="left" valign="top" width="5%"><p><a id="callout-hello-properties-destination"></a><a href="#hello-properties-destination"><span><img alt="2" border="0" src="images/callouts/2.png" /></span></a> </p></td><td align="left" valign="top"><p>Defines a destination for which MessageProducers
and/or MessageConsumers can be created to send and receive
messages. The value for the destination in the properties
file is an address string as described in
<a class="xref" href="JMS-Client-0-10-Configuring-Addresses.html" title="2.4.&#160;Addresses">Section&#160;2.4, &#8220;Addresses&#8221;</a>. In the JMS
implementation MessageProducers are analogous to senders in
the Qpid Message API, and MessageConsumers are analogous to
receivers.</p></td></tr></table></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="JMS-Client-0-10-Book.html">Prev</a>&#160;</td><td align="center" width="20%">&#160;</td><td align="right" width="40%">&#160;<a accesskey="n" href="JMS-Client-0-10-Configuring.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Apache Qpid JMS Client for AMQP 0-10&#160;</td><td align="center" width="20%"><a accesskey="h" href="JMS-Client-0-10-Book.html">Home</a></td><td align="right" valign="top" width="40%">&#160;Chapter&#160;2.&#160;Configuring the Client</td></tr></table></div></div>
<hr/>
<ul id="-apache-navigation">
<li><a href="http://www.apache.org/">Apache</a></li>
<li><a href="http://www.apache.org/licenses/">License</a></li>
<li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks!</a></li>
<li><a href="/security.html">Security</a></li>
<li><a href="http://www.apache.org/"><img id="-apache-feather" width="48" height="14" src="" alt="Apache"/></a></li>
</ul>
<p id="-legal">
Apache Qpid, Messaging built on AMQP; Copyright &#169; 2015
The Apache Software Foundation; Licensed under
the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache
License, Version 2.0</a>; Apache Qpid, Qpid, Qpid Proton,
Proton, Apache, the Apache feather logo, and the Apache Qpid
project logo are trademarks of The Apache Software
Foundation; All other marks mentioned may be trademarks or
registered trademarks of their respective owners
</p>
</div>
</div>
</div>
</body>
</html>