Author: buildbot
Date: Wed Apr 23 14:18:47 2014
New Revision: 906646
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/openshift.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/openshift.html
==============================================================================
--- websites/production/camel/content/openshift.html (original)
+++ websites/production/camel/content/openshift.html Wed Apr 23 14:18:47 2014
@@ -98,19 +98,23 @@
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[openshift:clientId[?options]
]]></script>
</div></div><p>You can append query options to the URI in the following
format, <code>?option=value&option=value&...</code></p><h3
id="Openshift-Options">Options</h3><div class="confluenceTableSmall">
-<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> <code>domain</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> Domain name. If not specified
then the default domain is used. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>username</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Mandatory</strong>: The username to login to
openshift server. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>password</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>&
#160;</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<strong>Mandatory:</strong> The password for login to openshift server.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>server</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> Url to the openshift server. If not specified then the
default value from the local openshift configuration file
<code>~/.openshift/express.conf</code> is used. </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>operation</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>list</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The operation to
perform which can be: <code>list</code>, <code>start</code>, <code>stop</code>,
<code>restart</code>, and <code>state</code>. The <code>list</code> operation
returns information about all the applications in json format. T
he <code>state</code> operation returns the state such as: started, stopped
etc. The other operations does not return any value. </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>application</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> The application name to
<code>start</code>, <code>stop</code>, <code>restart</code>, or get the
<code>state</code>. </p></td></tr></tbody></table>
+<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> <code>domain</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> Domain name. If not specified
then the default domain is used. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>username</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Mandatory</strong>: The username to login to
openshift server. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>password</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>&
#160;</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<strong>Mandatory:</strong> The password for login to openshift server.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>server</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> Url to the openshift server. If not specified then the
default value from the local openshift configuration file
<code>~/.openshift/express.conf</code> is used. And if that fails as well then
"openshift.redhat.com" is used. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>delay</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>10s</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <strong>Consumer only:</strong> How
frequent to poll for state changes for the applications. By default we poll
every 10 seconds. </p></td></tr><tr><td colspan="1" rowspan="1" class=
"confluenceTd"><p> <code>operation</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>list</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <strong>Producer only</strong>: The
operation to perform which can be: <code>list</code>, <code>start</code>,
<code>stop</code>, <code>restart</code>, and <code>state</code>. The
<code>list</code> operation returns information about all the applications in
json format. The <code>state</code> operation returns the state such as:
started, stopped etc. The other operations does not return any value.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>application</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Producer only</strong>: The application name
to <code>start</code>, <code>stop</code>, <code>restart</code>, or get the
<code>state</code>. </p></td></tr><tr><td colspan="1" rows
pan="1" class="confluenceTd"><p> <code>mode</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Producer only</strong>: Whether to output the
message body as a pojo or json. For pojo the message is a
<code>List<com.openshift.client.IApplication></code> type.
</p></td></tr></tbody></table>
</div><h3 id="Openshift-Examples">Examples</h3><h4
id="Openshift-Listingallapplications">Listing all applications</h4><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[// sending route
from("direct:apps")
.to("openshift:myClient?username=foo&password=secret&operation=list");
.to("log:apps");
]]></script>
-</div></div><p>In this case the information about all the applications is
returned as json.</p><h4 id="Openshift-Stoppinganapplication">Stopping an
application</h4><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[// sending route
+</div></div><p>In this case the information about all the applications is
returned as pojo. If you want a json response, then set mode=json.</p><h4
id="Openshift-Stoppinganapplication">Stopping an application</h4><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[// stopping the foobar application
from("direct:control")
.to("openshift:myClient?username=foo&password=secret&operation=stop&application=foobar");
 ]]></script>
-</div></div><p>In the example above we stop the application named
foobar.</p><p></p><h3 id="Openshift-SeeAlso">See Also</h3>
+</div></div><p>In the example above we stop the application named
foobar.</p><p> </p><p>Polling for gear state changes</p><p>The consumer is
used for polling state changes in gears. Such as when a new gear is
added/removed/ or its lifecycle is changed, eg started, or stopped etc.</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[// trigger when state changes on our gears
+from("openshift:myClient?username=foo&password=secret&delay=30s")
+ .log("Event ${header.CamelOpenShiftEventType} on application
${body.name} changed state to
${header.CamelOpenShiftEventNewState}");]]></script>
+</div></div><p> </p><p>When the consumer emits an Exchange then the body
contains the <code>com.openshift.client.IApplication</code> as the message
body. And the following headers is included.</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Header</th><th colspan="1" rowspan="1"
class="confluenceTh">May be null</th><th colspan="1" rowspan="1"
class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">CamelOpenShiftEventType</td><td colspan="1" rowspan="1"
class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd">The type of the event which can be one of: added, removed
or changed.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">CamelOpenShiftEventOldState</td><td colspan="1"
rowspan="1" class="confluenceTd">Yes</td><td colspan="1" rowspan="1"
class="confluenceTd">The old state, when the event type is
changed.</td></tr><tr><td colspan="1
" rowspan="1" class="confluenceTd">CamelOpenShiftEventNewState</td><td
colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd">The new state, for any of the event
types</td></tr></tbody></table></div><p> </p><p> </p><p></p><h3
id="Openshift-SeeAlso">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul></div>
</td>
<td valign="top">
