camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Camel > Web Console
Date Mon, 07 Jan 2013 12:48:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2042/9/1/_/styles/combined.css?spaceKey=CAMEL&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/CAMEL/Web+Console">Web
Console</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~jstrachan">James
Strachan</a>
    </h4>
        <br/>
                         <h4>Changes (1)</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" >Web Console provide route viewing
and editing functionality. You can view your route via http://localhost:8080/routes/yourRouteId
and it default present the route in XML. <br>Camel uses JAXB to process the XML route
definitions. <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">
<br>h1. External Web Consoles <br> <br>There are a number of external web
consoles for Apache Camel in separate open source projects: <br> <br>|| External
Project || Description || <br>| [hawt.io|http://hawt.io/] | hawt.io is an open source
HTML5 web application for visualising, managing and tracing Camel routes &amp; endpoints,
ActiveMQ brokers, JMX, OSGi and logging. | <br>| [CamelWatch|http://sksamuel.github.com/camelwatch/]
| A web app for monitoring Camel applications. | <br></td></tr>
    
            </table>
    </div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <h1><a name="WebConsole-WebConsole"></a>Web Console</h1>

<p>The Camel Web Console is available from versions 2.0 onwards and provides a full
access over a RESTful API to camel endpoints, messages and routes.</p>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/information.gif" width="16"
height="16" align="absmiddle" alt="" border="0"></td><td><b>Camel 2.5
or better</b><br />The <a href="/confluence/display/CAMEL/Web+Console" title="Web
Console">Web Console</a> from Camel 2.5 onwards requires JDK 1.6 as minimum to run.</td></tr></table></div>

<h2><a name="WebConsole-DownloadandRuntheConsole"></a>Download and Run the
Console</h2>

<p>Download the console from Maven Central at <a href="http://repo2.maven.org/maven2/org/apache/camel/camel-web-standalone/"
class="external-link" rel="nofollow">http://repo2.maven.org/maven2/org/apache/camel/camel-web-standalone/</a></p>

<p>Then from the command line type</p>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
java -jar camel-web-standalone-2.8.0.jar 
</pre>
</div></div>

<p>You should now be able to point your browser at: <a href="http://localhost:8080/"
class="external-link" rel="nofollow">http://localhost:8080/</a></p>

<h2><a name="WebConsole-BuildandRuntheConsole"></a>Build and Run the Console
</h2>

<p>First get the latest <a href="/confluence/display/CAMEL/Source" title="Source">Source</a>
then from the command line type</p>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
cd components/camel-web
mvn jetty:run
</pre>
</div></div>

<p>Then point your web browse at <a href="http://localhost:8080/" class="external-link"
rel="nofollow">http://localhost:8080/</a></p>

<p>You should be able to do things like</p>

<ul>
	<li>browse the available endpoints</li>
	<li>browse the messages on an endpoint if it is a <a href="/confluence/display/CAMEL/BrowsableEndpoint"
title="BrowsableEndpoint">BrowsableEndpoint</a></li>
	<li>send a message to an endpoint</li>
	<li>create new endpoints</li>
</ul>


<h3><a name="WebConsole-RunningusingTomcat"></a>Running using Tomcat</h3>
<p><b>Available as of Camel 2.10</b></p>

<p>You can also run the web console from an embedded Apache Tomcat using</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
cd components/camel-web
mvn tomcat7:run
</pre>
</div></div>

<p>Then point your web browse at <a href="http://localhost:8080/" class="external-link"
rel="nofollow">http://localhost:8080/</a></p>


<h2><a name="WebConsole-Embeddingwebconsoleinyourownwebapplication."></a>Embedding
web console in your own web application.</h2>

<p>See these relevant discussions for more information (more information to come soon):</p>

<p><a href="http://camel.465427.n5.nabble.com/Embedded-web-console-td478885.html"
class="external-link" rel="nofollow">http://camel.465427.n5.nabble.com/Embedded-web-console-td478885.html</a></p>

<p><a href="http://camel.465427.n5.nabble.com/example-app-to-embed-camel-web-console-td4512075.html"
class="external-link" rel="nofollow">http://camel.465427.n5.nabble.com/example-app-to-embed-camel-web-console-td4512075.html</a></p>

<h2><a name="WebConsole-RESTAPI"></a>REST API</h2>

<p>Camel comes with a full RESTful API for interacting with the Camel context, the available
endpoints and routes. You can browse details of the running API via <a href="http://localhost:8080/api"
class="external-link" rel="nofollow">http://localhost:8080/api</a></p>

<p>The web application uses mostly the same URIs for the HTML representation of a resource
(e.g. <b>/endpoints</b>) as the JSON and XML representations. To help rendering
the different representations in your browser you can append <b>.xml</b>, <b>.html</b>,
<b>.json</b> or even <b>.dot</b> to URLs. </p>

<p>For example viewing these URLs are equivalent</p>

<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> URL </th>
<th class='confluenceTh'> Same as </th>
</tr>
<tr>
<td class='confluenceTd'> <a href="http://localhost:8080/endpoints.xml" class="external-link"
rel="nofollow">http://localhost:8080/endpoints.xml</a> </td>
<td class='confluenceTd'> 
<a href="http://localhost:8080/endpoints" class="external-link" rel="nofollow">http://localhost:8080/endpoints</a>
<p> with Accept header of text/xml or application/xml</p></td>
</tr>
<tr>
<td class='confluenceTd'> <a href="http://localhost:8080/endpoints.json" class="external-link"
rel="nofollow">http://localhost:8080/endpoints.json</a> </td>
<td class='confluenceTd'> 
<a href="http://localhost:8080/endpoints" class="external-link" rel="nofollow">http://localhost:8080/endpoints</a>
<p> with Accept header of application/json</p></td>
</tr>
<tr>
<td class='confluenceTd'> <a href="http://localhost:8080/routes.dot" class="external-link"
rel="nofollow">http://localhost:8080/routes.dot</a> </td>
<td class='confluenceTd'> 
<a href="http://localhost:8080/routes" class="external-link" rel="nofollow">http://localhost:8080/routes</a>
<p> with Accept header of text/vnd.graphviz </p></td>
</tr>
</tbody></table>
</div>



<p>For more details try viewing the <a href="http://localhost:8080/api" class="external-link"
rel="nofollow">API documentation in your local Camel instance</a></p>

<h2><a name="WebConsole-RouteViewingandEditingthroughWebConsole"></a>Route
Viewing and Editing through Web Console</h2>
<p>Web Console provide route viewing and editing functionality. You can view your route
via <a href="http://localhost:8080/routes/yourRouteId" class="external-link" rel="nofollow">http://localhost:8080/routes/yourRouteId</a>
and it default present the route in XML.<br/>
Camel uses JAXB to process the XML route definitions.</p>

<h1><a name="WebConsole-ExternalWebConsoles"></a>External Web Consoles</h1>

<p>There are a number of external web consoles for Apache Camel in separate open source
projects:</p>

<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> External Project </th>
<th class='confluenceTh'> Description </th>
</tr>
<tr>
<td class='confluenceTd'> <a href="http://hawt.io/" class="external-link" rel="nofollow">hawt.io</a>
</td>
<td class='confluenceTd'> hawt.io is an open source HTML5 web application for visualising,
managing and tracing Camel routes &amp; endpoints, ActiveMQ brokers, JMX, OSGi and logging.
</td>
</tr>
<tr>
<td class='confluenceTd'> <a href="http://sksamuel.github.com/camelwatch/" class="external-link"
rel="nofollow">CamelWatch</a> </td>
<td class='confluenceTd'> A web app for monitoring Camel applications. </td>
</tr>
</tbody></table>
</div>

    </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/CAMEL/Web+Console">View
Online</a>
        |
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=110677&revisedVersion=19&originalVersion=18">View
Changes</a>
                |
        <a href="https://cwiki.apache.org/confluence/display/CAMEL/Web+Console?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message