Modified: websites/production/camel/content/component-list.html ============================================================================== --- websites/production/camel/content/component-list.html (original) +++ websites/production/camel/content/component-list.html Mon Oct 20 16:18:43 2014 @@ -257,7 +257,10 @@ disruptor-vm:someName[?<option>] </div></div><p><span><br clear="none"></span></p></td><td colspan="1" rowspan="1" class="confluenceTd">Supports to work with NoSQL databases using the <a shape="rect" class="external-link" href="http://gora.apache.org/";>Apache Gora</a> framework.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="geocoder.html">Geocoder</a> / camel-geocoder</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[geocoder:<address|latlng:latitude,longitude>[?options] ]]></script> -</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Supports looking up geocoders for an address, or reverse lookup geocoders from an address.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="guava-eventbus.html">Google Guava EventBus</a> / camel-guava-eventbus</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Supports looking up geocoders for an address, or reverse lookup geocoders from an address.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="github.html">GitHub</a> / camel-github</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[github://endpoint[?options] +]]></script> +</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>For interacting with GitHub</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="guava-eventbus.html">Google Guava EventBus</a> / camel-guava-eventbus</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[guava-eventbus:busName[?options] ]]></script> </div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The <a shape="rect" class="external-link" href="http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/package-summary.html"; rel="nofollow">Google Guava EventBus</a> allows publish-subscribe-style communication between components without requiring the components to explicitly register with one another (and thus be aware of each other). This component provides integration bridge between Camel and <a shape="rect" class="external-link" href="http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/package-summary.html"; rel="nofollow">Google Guava EventBus</a> infrastructure.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="hazelcast-component.html">Hazelcast</a> / <a shape="rect" href="hazelcast-component.html">camel-hazelcast</a></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent p dl"> @@ -313,7 +316,10 @@ disruptor-vm:someName[?<option>] </div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>For exposing services over HTTP</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="jgroups.html">JGroups</a> / camel-jgroups</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[jgroups:clusterName[?options] ]]></script> -</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The <code>jgroups:</code> component provides exchange of messages between Camel infrastructure and <a shape="rect" class="external-link" href="http://jgroups.org"; rel="nofollow">JGroups</a> clusters.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="jms.html">JMS</a> / camel-jms</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The <code>jgroups:</code> component provides exchange of messages between Camel infrastructure and <a shape="rect" class="external-link" href="http://jgroups.org"; rel="nofollow">JGroups</a> clusters.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="jira.html">JIRA</a> / camel-jira</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[jira://endpoint[?options] +]]></script> +</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>For interacting with JIRA</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="jms.html">JMS</a> / camel-jms</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[jms:[queue:|topic:]destinationName[?options] ]]></script> </div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Working with JMS providers</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="jmx.html">JMX</a> / camel-jmx</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
Modified: websites/production/camel/content/components.html ============================================================================== --- websites/production/camel/content/components.html (original) +++ websites/production/camel/content/components.html Mon Oct 20 16:18:43 2014 @@ -266,7 +266,10 @@ disruptor-vm:someName[?<option>] </div></div><p><span><br clear="none"></span></p></td><td colspan="1" rowspan="1" class="confluenceTd">Supports to work with NoSQL databases using the <a shape="rect" class="external-link" href="http://gora.apache.org/";>Apache Gora</a> framework.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="geocoder.html">Geocoder</a> / camel-geocoder</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[geocoder:<address|latlng:latitude,longitude>[?options] ]]></script> -</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Supports looking up geocoders for an address, or reverse lookup geocoders from an address.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="guava-eventbus.html">Google Guava EventBus</a> / camel-guava-eventbus</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Supports looking up geocoders for an address, or reverse lookup geocoders from an address.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="github.html">GitHub</a> / camel-github</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[github://endpoint[?options] +]]></script> +</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>For interacting with GitHub</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="guava-eventbus.html">Google Guava EventBus</a> / camel-guava-eventbus</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[guava-eventbus:busName[?options] ]]></script> </div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The <a shape="rect" class="external-link" href="http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/package-summary.html"; rel="nofollow">Google Guava EventBus</a> allows publish-subscribe-style communication between components without requiring the components to explicitly register with one another (and thus be aware of each other). This component provides integration bridge between Camel and <a shape="rect" class="external-link" href="http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/package-summary.html"; rel="nofollow">Google Guava EventBus</a> infrastructure.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="hazelcast-component.html">Hazelcast</a> / <a shape="rect" href="hazelcast-component.html">camel-hazelcast</a></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent p dl"> @@ -322,7 +325,10 @@ disruptor-vm:someName[?<option>] </div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>For exposing services over HTTP</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="jgroups.html">JGroups</a> / camel-jgroups</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[jgroups:clusterName[?options] ]]></script> -</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The <code>jgroups:</code> component provides exchange of messages between Camel infrastructure and <a shape="rect" class="external-link" href="http://jgroups.org"; rel="nofollow">JGroups</a> clusters.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="jms.html">JMS</a> / camel-jms</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The <code>jgroups:</code> component provides exchange of messages between Camel infrastructure and <a shape="rect" class="external-link" href="http://jgroups.org"; rel="nofollow">JGroups</a> clusters.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="jira.html">JIRA</a> / camel-jira</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[jira://endpoint[?options] +]]></script> +</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>For interacting with JIRA</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="jms.html">JMS</a> / camel-jms</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="theme: Default; brush: plain; gutter: false" type="syntaxhighlighter"><![CDATA[jms:[queue:|topic:]destinationName[?options] ]]></script> </div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Working with JMS providers</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="jmx.html">JMX</a> / camel-jmx</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> Added: websites/production/camel/content/github.html ============================================================================== --- websites/production/camel/content/github.html (added) +++ websites/production/camel/content/github.html Mon Oct 20 16:18:43 2014 @@ -0,0 +1,166 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- + + 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> +<head> + <link href="//camel.apache.org/styles/site.css" rel="stylesheet" type="text/css"> + <link href="//camel.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css"> + <script src="//camel.apache.org/styles/prototype.js" type="text/javascript"></script> + <script src="//camel.apache.org/styles/rico.js" type="text/javascript"></script> + <script src="//camel.apache.org/styles/site.js" type="text/javascript"></script> + + <meta http-equiv="Content-type" content="text/html;charset=UTF-8"> + + <style type="text/css"> + .maincontent { overflow:hidden; } + </style> + <!--[if IE]> + <style type="text/css"> + .maincontent { width:100%; } + </style> + <![endif]--> + + + <link href='//camel.apache.org/styles/highlighter/styles/shCoreCamel.css' rel='stylesheet' type='text/css' /> + <link href='//camel.apache.org/styles/highlighter/styles/shThemeCamel.css' rel='stylesheet' type='text/css' /> + <script src='//camel.apache.org/styles/highlighter/scripts/shCore.js' type='text/javascript'></script> + <script src='//camel.apache.org/styles/highlighter/scripts/shBrushXml.js' type='text/javascript'></script> + <script src='//camel.apache.org/styles/highlighter/scripts/shBrushPlain.js' type='text/javascript'></script> + + <script type="text/javascript"> + SyntaxHighlighter.defaults['toolbar'] = false; + SyntaxHighlighter.all(); + </script> + + <title> + Apache Camel: GitHub + </title> +</head> +<body> +<div class="white_box"> +<div class="header"> + <div class="header_l"> + <div class="header_r"> + </div> + </div> +</div> +<div class="content"> + <div class="content_l"> + <div class="content_r"> + <div> + <!-- Banner --> +<div id="banner-content"><div id="asf_logo"> + <div id="activemq_logo" style="height:108px; background:transparent url(banner.data/apache-camel-7.png) no-repeat scroll left top;"> + <a shape="rect" style="float:left; width:310px;display:block;text-indent:-5000px;text-decoration:none;line-height:140px; margin-top:20px; margin-left:18px;" href="http://camel.apache.org/";>Camel</a> + <a shape="rect" style="float:right; width:180px;display:block;text-indent:-5000px;text-decoration:none;line-height:80px; margin-top:45px; margin-right:10px;" href="http://www.apache.org";>Apache</a> + </div> +</div></div> + <!-- Banner --> + <div class="top_red_bar"> + <div id="site-breadcrumbs"> + <!-- Breadcrumbs --> +<a href="index.html">Apache Camel</a> > <a href="documentation.html">Documentation</a> > <a href="components.html">Components</a> > <a href="github.html">GitHub</a> + </div> + <!-- Quicklinks --> +<div id="site-quicklinks"><p><a shape="rect" href="download.html">Download</a> | <a shape="rect" href="javadoc.html">JavaDoc</a> | <a shape="rect" href="source.html">Source</a> | <a shape="rect" href="discussion-forums.html">Forums</a> | <a shape="rect" href="support.html">Support</a></p></div> + <!-- Quicklinks --> + </div> + + <table border="0"> + <tbody> + <tr> + <td valign="top" width="100%"> +<div class="wiki-content maincontent"><h2 id="GitHub-GitHub">GitHub</h2><p><strong>Available as of Camel 2.15</strong></p><p>The GitHub component interacts with the GitHub API by encapsulating <a shape="rect" class="external-link" href="http://org.eclipse.egit.github.core"; rel="nofollow">egit-github</a>. It currently provides polling for new pull requests, pull request comments, tags, and commits.  It is also able to produce comments on pull requests, as well as close the pull request entirely.</p><p>Rather than webhooks, this endpoint relies on simple polling. Reasons include:</p><ul><li>Concern for reliability/stability</li><li>The types of payloads we're polling aren't typically large (plus, paging is available in the API)</li><li>The need to support apps running somewhere not publicly accessible where a webhook would fail</li></ul><p>Note that the GitHub API is fairly expansive.  Therefore, this component could be easily expanded to provide additional interactions .</p><p>Maven users will need to add the following dependency to their pom.xml for this component:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-github</artifactId> + <version>${camel-version}</version> +</dependency> +]]></script> +</div></div><h3 id="GitHub-URIformat">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[gihub://endpoint[?options]]]></script> +</div></div><h3 id="GitHub-MandatoryOptions:">Mandatory Options:</h3><p>Note that these can be configured directly through the endpoint.</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>username</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>GitHub username, required unless oauthToken is provided</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>password</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>GitHub password, required unless oauthToken is provided</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>oauthToken</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>GitHub OAuth token, required unless username & password are provided</p></td></tr><tr><td colspan="1" rowspan="1" c lass="confluenceTd"><p>repoOwner</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>GitHub repository owner (organization)</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">repoName</td><td colspan="1" rowspan="1" class="confluenceTd">GitHub repository name</td></tr></tbody></table></div><h3 id="GitHub-ConsumerEndpoints:">Consumer Endpoints:</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Context</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Body Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>pullRequest</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>org.eclipse.egit.github.core.PullRequest</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>pullRequestComment</p></td> <td colspan="1" rowspan="1" class="confluenceTd"><p>polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>org.eclipse.egit.github.core.</span><span>Comment (comment on the general pull request discussion) or <span>org.eclipse.egit.github.core.CommitComment (inline comment on a pull request diff)</span></span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>tag</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>org.eclipse.egit.github.core.RepositoryTag</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>commit</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>org.eclipse.egit.github.core.</span><span>RepositoryCommit</span></p></td></tr></tbody></table></div><h3 id="GitHub-ProducerEndpoints:">Producer Endpoints:</h3><div class="table-wrap"><table class="c onfluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Body</p></th><th colspan="1" rowspan="1" class="confluenceTh">Message Headers</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>pullRequestComment</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>String (comment text)</p></td><td colspan="1" rowspan="1" class="confluenceTd"><ul><li>GitHubPullRequest (integer) (REQUIRED): Pull request number.</li><li>GitHubInResponseTo (integer): Required if responding to another inline comment on the pull request diff. If left off, a general comment on the pull request discussion is assumed.</li></ul></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><span>closePullRequest</span></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>none</p></td><td colspan="1" rowspan="1" class="confluenceTd"><ul><li>GitHubPullRequest (integer) (REQUIRED): Pull request numb er.</li></ul></td></tr></tbody></table></div><h3 id="GitHub-URIOptions">URI Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>delay</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>60</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>in seconds</p></td></tr></tbody></table></div></div> + </td> + <td valign="top"> + <div class="navigation"> + <div class="navigation_top"> + <!-- NavigationBar --> +<div class="navigation_bottom" id="navigation_bottom"><h3 id="Navigation-Overview"><a shape="rect" href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a shape="rect" href="download.html">Download</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentation"><a shape="rect" href="documentation.html">Documentation</a></h3><ul class="alternate"><li><a shape="rect" href="user-guide.html">User Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a shape="rect" href="books.html">Books</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="examples.html">Examples</a></li><li><a shape="rect" href="cookbook.html">Cookbook</a></li><li><a shape="rect" href="architecture.html">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect" href="components.html">Components</a></li><li><a shape="rect" href="data-format.html">Data Format</a></li><li><a shape="rect" href="languages.html">Languages</a></li><li><a shape="rect" href="security.html">Security</a></li><li><a shape="rect" href="security-advisories.html">Security Advisories</a></li></ul><h3 id="Navigation-Search">Search</h3><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse";> + <div> + <input type="hidden" name="cx" value="007878419884033443453:m5nhvy4hmyq"> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" size="21"> + <input type="submit" name="sa" value="Search"> + </div> +</form> +<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en";></script><h3 id="Navigation-Community"><a shape="rect" href="community.html">Community</a></h3><ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" href="contributing.html">Contributing</a></li><li><a shape="rect" href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" href="user-stories.html">User Stories</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="articles.html">Articles</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" href="team.html">Team</a></li><li><a shape="rect" class="external-link" href="http://camel-extra.googlecode.com/"; rel="nofollow">Camel Extra</a></li></ul><h3 id="Navigation-Developers"><a shape="rect" href="developers.html">Developers</a></h3><ul class="alternate" ><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a >shape="rect" href="source.html">Source</a></li><li><a shape="rect" >href="building.html">Building</a></li><li><a shape="rect" >href="javadoc.html">JavaDoc</a></li><li><a shape="rect" >href="irc-room.html">IRC Room</a></li></ul><h3 >id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul >class="alternate"><li><a shape="rect" class="external-link" >href="http://www.apache.org/licenses/";>License</a></li><li><a shape="rect" >class="external-link" >href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a > shape="rect" class="external-link" >href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li><li><a >shape="rect" class="external-link" >href="http://www.apache.org/security/";>Security</a></li></ul></div> + <!-- NavigationBar --> + </div> + </div> + </td> + </tr> + </tbody> + </table> + + + <div class="bottom_red_bar"></div> + </div> + </div> + </div> +</div> +<div class="black_box"> +<div class="footer"> + <div class="footer_l"> + <div class="footer_r"> + <div> + <a href="$base/privacy-policy.html">Privacy Policy</a> - + (<a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=47383683";>edit page</a>) + (<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=47383683&showComments=true&showCommentArea=true#addcomment";>add comment</a>) + </div> + </div> + </div> +</div> +</div> +</div> +<div class="design_attribution"> +© 2004-2014 The Apache Software Foundation. +<br> +Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. +<br> +<a href="http://hiramchirino.com";>Graphic Design By Hiram</a> +</div> + +<!-- Camel committers that would like access to the Analytics, send a note to priv...@camel.apache.org --> +<script type="text/javascript"> + + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-25976253-1']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + +</script> + +</body> +</html> + + Added: websites/production/camel/content/jira.html ============================================================================== --- websites/production/camel/content/jira.html (added) +++ websites/production/camel/content/jira.html Mon Oct 20 16:18:43 2014 @@ -0,0 +1,170 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- + + 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> +<head> + <link href="//camel.apache.org/styles/site.css" rel="stylesheet" type="text/css"> + <link href="//camel.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css"> + <script src="//camel.apache.org/styles/prototype.js" type="text/javascript"></script> + <script src="//camel.apache.org/styles/rico.js" type="text/javascript"></script> + <script src="//camel.apache.org/styles/site.js" type="text/javascript"></script> + + <meta http-equiv="Content-type" content="text/html;charset=UTF-8"> + + <style type="text/css"> + .maincontent { overflow:hidden; } + </style> + <!--[if IE]> + <style type="text/css"> + .maincontent { width:100%; } + </style> + <![endif]--> + + + <link href='//camel.apache.org/styles/highlighter/styles/shCoreCamel.css' rel='stylesheet' type='text/css' /> + <link href='//camel.apache.org/styles/highlighter/styles/shThemeCamel.css' rel='stylesheet' type='text/css' /> + <script src='//camel.apache.org/styles/highlighter/scripts/shCore.js' type='text/javascript'></script> + <script src='//camel.apache.org/styles/highlighter/scripts/shBrushXml.js' type='text/javascript'></script> + <script src='//camel.apache.org/styles/highlighter/scripts/shBrushPlain.js' type='text/javascript'></script> + + <script type="text/javascript"> + SyntaxHighlighter.defaults['toolbar'] = false; + SyntaxHighlighter.all(); + </script> + + <title> + Apache Camel: JIRA + </title> +</head> +<body> +<div class="white_box"> +<div class="header"> + <div class="header_l"> + <div class="header_r"> + </div> + </div> +</div> +<div class="content"> + <div class="content_l"> + <div class="content_r"> + <div> + <!-- Banner --> +<div id="banner-content"><div id="asf_logo"> + <div id="activemq_logo" style="height:108px; background:transparent url(banner.data/apache-camel-7.png) no-repeat scroll left top;"> + <a shape="rect" style="float:left; width:310px;display:block;text-indent:-5000px;text-decoration:none;line-height:140px; margin-top:20px; margin-left:18px;" href="http://camel.apache.org/";>Camel</a> + <a shape="rect" style="float:right; width:180px;display:block;text-indent:-5000px;text-decoration:none;line-height:80px; margin-top:45px; margin-right:10px;" href="http://www.apache.org";>Apache</a> + </div> +</div></div> + <!-- Banner --> + <div class="top_red_bar"> + <div id="site-breadcrumbs"> + <!-- Breadcrumbs --> +<a href="index.html">Apache Camel</a> > <a href="documentation.html">Documentation</a> > <a href="components.html">Components</a> > <a href="jira.html">JIRA</a> + </div> + <!-- Quicklinks --> +<div id="site-quicklinks"><p><a shape="rect" href="download.html">Download</a> | <a shape="rect" href="javadoc.html">JavaDoc</a> | <a shape="rect" href="source.html">Source</a> | <a shape="rect" href="discussion-forums.html">Forums</a> | <a shape="rect" href="support.html">Support</a></p></div> + <!-- Quicklinks --> + </div> + + <table border="0"> + <tbody> + <tr> + <td valign="top" width="100%"> +<div class="wiki-content maincontent"><h2 id="JIRA-JIRA">JIRA</h2><p><strong>Available as of Camel 2.15</strong></p><p>The JIRA component interacts with the JIRA API by encapsulating Atlassian's <a shape="rect" class="external-link" href="https://marketplace.atlassian.com/plugins/com.atlassian.jira.jira-rest-java-client"; rel="nofollow">REST Java Client for JIRA</a>. It currently provides polling for new issues and new comments.  It is also able to create new issues.</p><p>Rather than webhooks, this endpoint relies on simple polling. Reasons include:</p><ul><li>Concern for reliability/stability</li><li>The types of payloads we're polling aren't typically large (plus, paging is available in the API)</li><li>The need to support apps running somewhere not publicly accessible where a webhook would fail</li></ul><p>Note that the JIRA API is fairly expansive.  Therefore, this component could be easily expanded to provide additional interactions.</p><p>Maven users will n eed to add the following dependency to their pom.xml for this component:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-jira</artifactId> + <version>${camel-version}</version> +</dependency> +]]></script> +</div></div><h3 id="JIRA-URIformat">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[jira://endpoint[?options]]]></script> +</div></div><h3 id="JIRA-MandatoryOptions:">Mandatory Options:</h3><p>Note that these can be configured directly through the endpoint.</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">serverUrl</td><td colspan="1" rowspan="1" class="confluenceTd">JIRA host server URL</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>username</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>JIRA username</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>password</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>JIRA password</p></td></tr></tbody></table></div><h3 id="JIRA-ConsumerEndpoints:">Consumer Endpoints:</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>En dpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Context</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Body Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>newIssue</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>com.atlassian.jira.rest.client.domain.BasicIssue</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>newComment</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>com.atlassian.jira.rest.client.domain.Comment</p></td></tr></tbody></table></div><h3 id="JIRA-ProducerEndpoints:">Producer Endpoints:</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Body</p></th><th colspan="1" rowspan="1" class="confluenceTh">Re quired Message Headers</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>pullRequestComment</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>String (issue description)</p></td><td colspan="1" rowspan="1" class="confluenceTd"><ul><li>ProjectKey (String): The project key</li><li>IssueTypeId (long): The issue type id (ex: "Bug" is typically 1 in most default configs)</li><li>IssueSummary (String): The issue summary (title)</li></ul></td></tr></tbody></table></div><h3 id="JIRA-URIOptions:">URI Options:</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>delay</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>60</code></p></td><td colspan="1" rowspan="1" class=" confluenceTd"><p>in seconds</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">jql</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">Used by the consumer endpoints. More info below.</td></tr></tbody></table></div><h3 id="JIRA-JQL:">JQL:</h3><p>The JQL URI option is used by both consumer endpoints.  Theoretically, items like "project key", etc. could be URI options themselves.  However, by requiring the use of JQL, the consumers become much more flexible and powerful.</p><p>At the bare minimum, the consumers will require the following:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[jira://[endpoint]?[required options]&jql=project=[project key]]]></script> +</div></div><p>One important thing to note is that the newIssue consumer will automatically append "ORDER BY key desc" to your JQL.  This is in order to optimize startup processing, rather than having to index every single issue in the project.</p><p>Another note is that, similarly, the newComment consumer will have to index every single issue <strong>and</strong> comment in the project.  Therefore, for large projects, it's <strong>vital</strong> to optimize the JQL expression as much as possible.  For example, <span style="line-height: 1.4285715;">the JIRA Toolkit Plugin includes a </span><span style="line-height: 1.4285715;">"Number of comments" custom field -- use '"Number of comments" > 0' in your query. Also try to minimize based on </span><span style="line-height: 1.4285715;">state (status=Open), increase the polling delay, etc.  Example:</span></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeConten t panelContent pdl"> +<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[jira://[endpoint]?[required options]&jql=RAW(project=[project key] AND status in (Open, \"Coding In Progress\") AND \"Number of comments\">0)"]]></script> +</div></div></div> + </td> + <td valign="top"> + <div class="navigation"> + <div class="navigation_top"> + <!-- NavigationBar --> +<div class="navigation_bottom" id="navigation_bottom"><h3 id="Navigation-Overview"><a shape="rect" href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a shape="rect" href="download.html">Download</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentation"><a shape="rect" href="documentation.html">Documentation</a></h3><ul class="alternate"><li><a shape="rect" href="user-guide.html">User Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a shape="rect" href="books.html">Books</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="examples.html">Examples</a></li><li><a shape="rect" href="cookbook.html">Cookbook</a></li><li><a shape="rect" href="architecture.html">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect" href="components.html">Components</a></li><li><a shape="rect" href="data-format.html">Data Format</a></li><li><a shape="rect" href="languages.html">Languages</a></li><li><a shape="rect" href="security.html">Security</a></li><li><a shape="rect" href="security-advisories.html">Security Advisories</a></li></ul><h3 id="Navigation-Search">Search</h3><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse";> + <div> + <input type="hidden" name="cx" value="007878419884033443453:m5nhvy4hmyq"> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" size="21"> + <input type="submit" name="sa" value="Search"> + </div> +</form> +<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en";></script><h3 id="Navigation-Community"><a shape="rect" href="community.html">Community</a></h3><ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" href="contributing.html">Contributing</a></li><li><a shape="rect" href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" href="user-stories.html">User Stories</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="articles.html">Articles</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" href="team.html">Team</a></li><li><a shape="rect" class="external-link" href="http://camel-extra.googlecode.com/"; rel="nofollow">Camel Extra</a></li></ul><h3 id="Navigation-Developers"><a shape="rect" href="developers.html">Developers</a></h3><ul class="alternate" ><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a >shape="rect" href="source.html">Source</a></li><li><a shape="rect" >href="building.html">Building</a></li><li><a shape="rect" >href="javadoc.html">JavaDoc</a></li><li><a shape="rect" >href="irc-room.html">IRC Room</a></li></ul><h3 >id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul >class="alternate"><li><a shape="rect" class="external-link" >href="http://www.apache.org/licenses/";>License</a></li><li><a shape="rect" >class="external-link" >href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a > shape="rect" class="external-link" >href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li><li><a >shape="rect" class="external-link" >href="http://www.apache.org/security/";>Security</a></li></ul></div> + <!-- NavigationBar --> + </div> + </div> + </td> + </tr> + </tbody> + </table> + + + <div class="bottom_red_bar"></div> + </div> + </div> + </div> +</div> +<div class="black_box"> +<div class="footer"> + <div class="footer_l"> + <div class="footer_r"> + <div> + <a href="$base/privacy-policy.html">Privacy Policy</a> - + (<a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=47383691";>edit page</a>) + (<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=47383691&showComments=true&showCommentArea=true#addcomment";>add comment</a>) + </div> + </div> + </div> +</div> +</div> +</div> +<div class="design_attribution"> +© 2004-2014 The Apache Software Foundation. +<br> +Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. +<br> +<a href="http://hiramchirino.com";>Graphic Design By Hiram</a> +</div> + +<!-- Camel committers that would like access to the Analytics, send a note to priv...@camel.apache.org --> +<script type="text/javascript"> + + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-25976253-1']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + +</script> + +</body> +</html> + +
