Added: synapse/site/3_0_1/userguide/samples.html URL: http://svn.apache.org/viewvc/synapse/site/3_0_1/userguide/samples.html?rev=1817077&view=auto ============================================================================== --- synapse/site/3_0_1/userguide/samples.html (added) +++ synapse/site/3_0_1/userguide/samples.html Mon Dec 4 09:53:57 2017 @@ -0,0 +1,621 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-12-04 + | Rendered using Apache Maven Fluido Skin 1.6 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20171204" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Synapse – Apache Synapse - Samples Catalog</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + <script type="text/javascript" src="../js/apache-maven-fluido-1.6.min.js"></script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><div id="bannerLeft"><h2>Apache Synapse</h2> +</div> +</div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li id="publishDate">Last Published: 2017-12-04<span class="divider">|</span> +</li> + <li id="projectVersion">Version: 3.0.1</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> +<ul class="nav nav-list"> + <li class="nav-header">Main Menu</li> + <li><a href="../index.html" title="Home"><span class="none"></span>Home</a> </li> + <li><a href="../download.html" title="Download"><span class="none"></span>Download</a> </li> + <li><a href="../history.html" title="History"><span class="none"></span>History</a> </li> + <li><a href="http://www.apache.org/licenses/LICENSE-2.0"; class="externalLink" title="License"><span class="none"></span>License</a> </li> + <li><a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a> </li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a> </li> + <li><a href="http://www.apache.org/security/"; class="externalLink" title="Security"><span class="none"></span>Security</a> </li> + <li class="nav-header">Documentation</li> + <li><a href="../userguide/installation.html" title="Installation Guide"><span class="none"></span>Installation Guide</a> </li> + <li><a href="../userguide/quick_start.html" title="Quick Start Guide"><span class="none"></span>Quick Start Guide</a> </li> + <li><a href="../userguide/samples/setup/index.html" title="Samples Setup Guide"><span class="none"></span>Samples Setup Guide</a> </li> + <li class="active"><a href="#"><span class="none"></span>Samples Catalog</a> + </li> + <li><a href="../userguide/config.html" title="Configuration Language"><span class="none"></span>Configuration Language</a> </li> + <li><a href="../userguide/mediators.html" title="Mediators Catalog"><span class="none"></span>Mediators Catalog</a> </li> + <li><a href="../userguide/transports.html" title="Transports Catalog"><span class="none"></span>Transports Catalog</a> </li> + <li><a href="../userguide/properties.html" title="Properties Catalog"><span class="none"></span>Properties Catalog</a> </li> + <li><a href="../userguide/xpath.html" title="XPath functions and Variables"><span class="none"></span>XPath functions and Variables</a> </li> + <li><a href="../userguide/extending.html" title="Extending Synapse"><span class="none"></span>Extending Synapse</a> </li> + <li><a href="../userguide/template_library.html" title="Synapse Template Libraries"><span class="none"></span>Synapse Template Libraries</a> </li> + <li><a href="../userguide/upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a> </li> + <li><a href="../userguide/deployment.html" title="Deployment"><span class="none"></span>Deployment</a> </li> + <li><a href="../apidocs/" title="Javadocs"><span class="none"></span>Javadocs</a> </li> + <li><a href="../userguide/faq.html" title="FAQ"><span class="none"></span>FAQ</a> </li> + <li class="nav-header">Developer Resources</li> + <li><a href="../dev/developer-guide.html" title="Developer Guide"><span class="none"></span>Developer Guide</a> </li> + <li><a href="../dev/best-practices.html" title="Development Best Practices"><span class="none"></span>Development Best Practices</a> </li> + <li><a href="../dev/release-process.html" title="Release Process"><span class="none"></span>Release Process</a> </li> + <li class="nav-header">Project Details</li> + <li><a href="../project-info.html" title="Overview"><span class="none"></span>Overview</a> </li> + <li><a href="../mail-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a> </li> + <li><a href="../source-repository.html" title="Source Repository"><span class="none"></span>Source Repository</a> </li> + <li><a href="../issue-tracking.html" title="Issue Tracking"><span class="none"></span>Issue Tracking</a> </li> + <li><a href="../dependency-management.html" title="Dependencies"><span class="none"></span>Dependencies</a> </li> + <li><a href="../team-list.html" title="Project Team"><span class="none"></span>Project Team</a> </li> + </ul> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > + + + <div class="section"> +<h2><a name="Apache_Synapse_Samples_Catalog"></a>Apache Synapse Samples Catalog</h2> + +<p> + Apache Synapse comes preloaded with a horde of sample configurations that + demonstrate various features of the service bus. This catalog lists out all + these sample configurations and provides detailed information on how to run + them. These samples require an Apache ANT installation for you to be able to + try them out. If you are new to Synapse and have no experience running Synapse, + the Quick Start Guide may be a better starting point. If you are comfortable + with running Synapse samples, please go ahead and pick the samples you are + interested in. + </p> + +<div class="section"> +<h3><a name="Message_Mediation"></a>Message Mediation</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample0.html">Sample 0: Introduction to Synapse</a></li> + +<li><a href="samples/sample1.html">Sample 1: Simple content based routing (CBR) of messages</a></li> + +<li><a href="samples/sample2.html">Sample 2: CBR with the Switch-case mediator, using message properties</a></li> + +<li><a href="samples/sample3.html">Sample 3: Local Registry entry definitions, reusable endpoints and sequences</a></li> + +<li><a href="samples/sample4.html">Sample 4: Introduction to error handling</a></li> + +<li><a href="samples/sample5.html">Sample 5: Creating SOAP fault messages and changing the direction of a message</a></li> + +<li><a href="samples/sample6.html">Sample 6: Manipulating SOAP headers, and filtering incoming and outgoing messages</a></li> + +<li><a href="samples/sample7.html">Sample 7: Introduction to local registry entries and using schema validation</a></li> + +<li><a href="samples/sample8.html">Sample 8: Introduction to static and dynamic registry resources, and using XSLT transformations</a></li> + +<li><a href="samples/sample9.html">Sample 9: Introduction to dynamic sequences with registry</a></li> + +<li><a href="samples/sample10.html">Sample 10: Introduction to dynamic endpoints with registry</a></li> + +<li><a href="samples/sample11.html">Sample 11: A full registry based configuration, and sharing a configuration between multiple instances</a></li> + +<li><a href="samples/sample12.html">Sample 12: One-way messaging / fire-and-forget through Synapse</a></li> + +<li><a href="samples/sample14.html">Sample 14: Sequences and Endpoints as local registry items</a></li> + +<li><a href="samples/sample15.html">Sample 15: Message Copying and Content Enriching with Enrich Mediator</a></li> + +<li><a href="samples/sample16.html">Sample 16: Introduction to dynamic and static keys</a></li> + +<li><a href="samples/sample17.html">Sample 17: Introduction to the payloadFactory mediator</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Endpoints"></a>Endpoints</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample50.html">Sample 50: POX to SOAP conversion</a></li> + +<li><a href="samples/sample51.html">Sample 51: MTOM and SwA optimizations and request/response correlation</a></li> + +<li><a href="samples/sample52.html">Sample 52: Session less load balancing between 3 endpoints</a></li> + +<li><a href="samples/sample53.html">Sample 53: Fail-over routing among 3 endpoints</a></li> + +<li><a href="samples/sample54.html">Sample 54: Session affinity load balancing between 3 endpoints</a></li> + +<li><a href="samples/sample55.html">Sample 55: Session affinity load balancing between fail-over endpoints</a></li> + +<li><a href="samples/sample56.html">Sample 56: WSDL endpoint</a></li> + +<li><a href="samples/sample57.html">Sample 57: Dynamic load balancing between 3 nodes</a></li> + +<li><a href="samples/sample58.html">Sample 58: Static load balancing between 3 nodes</a></li> + +<li><a href="samples/sample59.html">Sample 59: Weighted Round-Robin loadbalancing between 3 endpoints</a></li> + +<li><a href="samples/sample61.html">Sample 61: Routing message to 3 static recipients</a></li> + +<li><a href="samples/sample62.html">Sample 62: Routing message to dynamic recipients</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="QoS_AdditionRemoval_with_Message_Mediation"></a>QoS Addition/Removal with Message Mediation</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample100.html">Sample 100: Using WS-Security for outgoing messages</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Proxy_Services"></a>Proxy Services</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample150.html">Sample 150: Introduction to proxy services</a></li> + +<li><a href="samples/sample151.html">Sample 151: Custom sequences and endpoints with proxy services</a></li> + +<li><a href="samples/sample152.html">Sample 152: Switching transports and message format from SOAP to REST/POX</a></li> + +<li><a href="samples/sample153.html">Sample 153: Routing the messages without processing the security headers</a></li> + +<li><a href="samples/sample154.html">Sample 154: Load Balancing with proxy services</a></li> + +<li><a href="samples/sample155.html">Sample 155: Dual channel invocation on client side and server side</a></li> + +<li><a href="samples/sample156.html">Sample 156: Service integration with specifying the receiving sequence</a></li> + +<li><a href="samples/sample157.html">Sample 157: Conditional router mediator for implementing complex routing scenarios</a></li> + +<li><a href="samples/sample158.html">Sample 158: Exposing a SOAP service over JSON</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="QoS_AdditionRemoval_with_Proxy_Services"></a>QoS Addition/Removal with Proxy Services</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample200.html">Sample 200: Engaging WS-Security on proxy services</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Transports"></a>Transports</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample250.html">Sample 250: Introduction to transport switching - JMS to HTTP/S</a></li> + +<li><a href="samples/sample251.html">Sample 251: Switching from http/s to JMS</a></li> + +<li><a href="samples/sample252.html">Sample 252: Pure text, binary and POX message support with JMS</a></li> + +<li><a href="samples/sample253.html">Sample 253: One way bridging from JMS to http and replying with a 202 Accepted response</a></li> + +<li><a href="samples/sample254.html">Sample 254: Using file system as the transport medium (reading/writing files)</a></li> + +<li><a href="samples/sample255.html">Sample 255: Switching from file transport (ftp) to the mail transport</a></li> + +<li><a href="samples/sample256.html">Sample 256: Proxy services with the mail transport</a></li> + +<li><a href="samples/sample257.html">Sample 257: Proxy services with the FIX transport</a></li> + +<li><a href="samples/sample258.html">Sample 258: Switching from HTTP to FIX </a></li> + +<li><a href="samples/sample259.html">Sample 259: Switching from FIX to HTTP </a></li> + +<li><a href="samples/sample260.html">Sample 260: Switching from FIX to AMQP </a></li> + +<li><a href="samples/sample261.html">Sample 261: Switch between different FIX versions </a></li> + +<li><a href="samples/sample262.html">Sample 262: Content Based Routing of FIX messages </a></li> + +<li><a href="samples/sample263.html">Sample 263: Transport switching - JMS to http/s using JBoss Messaging (JBM)</a></li> + +<li><a href="samples/sample264.html">Sample 264: Request-response invocations with the JMS transport</a></li> + +<li><a href="samples/sample265.html">Sample 265: Switching from TCP to HTTP/S</a></li> + +<li><a href="samples/sample266.html">Sample 266: Switching from UDP to HTTP/S</a></li> + +<li><a href="samples/sample269.html">Sample 269: AMQP transport-consumer proxy</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Scheduled_Tasks"></a>Scheduled Tasks</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample300.html">Sample 300: Introduction to tasks with simple trigger</a></li> + +<li><a href="samples/sample301.html">Sample 301: Message Injector Task to invoke a named sequence</a></li> + +<li><a href="samples/sample302.html">Sample 302: Message Injector Task to invoke a Proxy service</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Advanced_Mediators"></a>Advanced Mediators</h3> + +<div class="section"> +<h4><a name="Script_Mediator_Writing_Mediation_Logic_in_Scripting_Languages"></a>Script Mediator (Writing Mediation Logic in Scripting Languages)</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample350.html">Sample 350: Introduction to the script mediator using js scripts</a></li> + +<li><a href="samples/sample351.html">Sample 351: Inline scripts with the script mediator</a></li> + +<li><a href="samples/sample352.html">Sample 352: Accessing Synapse MessageContext API through scripts</a></li> + +<li><a href="samples/sample353.html">Sample 353: Using Ruby scripts for mediation</a></li> + +<li><a href="samples/sample354.html">Sample 354: Using In-lined Ruby scripts for mediation</a></li> + +<li><a href="samples/sample355.html">Sample 355: Using Python scripts for mediation</a></li> + </ul> + + </div> +<div class="section"> +<h4><a name="Database_Mediators_Interacting_with_Databases"></a>Database Mediators (Interacting with Databases)</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample360.html">Sample 360: Introduction to dblookup mediator</a></li> + +<li><a href="samples/sample361.html">Sample 361: Introduction to dbreport mediator</a></li> + +<li><a href="samples/sample362.html">Sample 362: Perform database lookups and updates in the same mediation sequence</a></li> + +<li><a href="samples/sample363.html">Sample 363: Reusable database connection pools</a></li> + +<li><a href="samples/sample364.html">Sample 364: Executing database Stored Procedures</a></li> + </ul> + + </div> +<div class="section"> +<h4><a name="Throttle_Mediator"></a>Throttle Mediator</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample370.html">Sample 370: Introduction to throttle mediator and concurrency throttling</a></li> + +<li><a href="samples/sample371.html">Sample 371: Restricting requests based on policies</a></li> + +<li><a href="samples/sample372.html">Sample 372: Use of both concurrency throttling and request rate based throttling </a></li> + </ul> + + </div> +<div class="section"> +<h4><a name="Class_Mediator_Writing_Mediation_Logic_in_Java"></a>Class Mediator (Writing Mediation Logic in Java)</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample380.html">Sample 380: Writing custom mediation logic in Java</a></li> + +<li><a href="samples/sample381.html">Sample 381: Class mediator for CBR of binary messages</a></li> + </ul> + + </div> +<div class="section"> +<h4><a name="XQuery_Mediator"></a>XQuery Mediator</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample390.html">Sample 390: Introduction to the XQuery mediator</a></li> + +<li><a href="samples/sample391.html">Sample 391: Using external XML documents in the XQuery mediator</a></li> + </ul> + + </div> +<div class="section"> +<h4><a name="Iterate_Mediator_and_Aggregate_Mediator"></a>Iterate Mediator and Aggregate Mediator</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample400.html">Sample 400: Message splitting and aggregation</a></li> + </ul> + + </div> +<div class="section"> +<h4><a name="Transaction_Mediator"></a>Transaction Mediator</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample410.html">Sample 410: Distributed transactions management with the transaction mediator</a></li> + </ul> + + </div> +<div class="section"> +<h4><a name="Cache_Mediator"></a>Cache Mediator</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample420.html">Sample 420: Simple response caching scenario</a></li> + </ul> + + </div> +<div class="section"> +<h4><a name="Callout_Mediator"></a>Callout Mediator</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample430.html">Sample 430: Callout mediator for synchronous web service invocations</a></li> + +<li><a href="samples/sample431.html">Sample 431: Callout Mediator with WS-Security for Outgoing Messages</a></li> + +<li><a href="samples/sample432.html">Sample 432: Callout Mediator - Invoke a secured service which has different policies for inbound and outbound flows</a></li> + +<li><a href="samples/sample433.html">Sample 433: Callout Mediator - Invoke a service using a defined Endpoint</a></li> + +<li><a href="samples/sample434.html">Sample 434: Callout Mediator - Invoke a service using an inline Endpoint</a></li> + </ul> + + </div> +<div class="section"> +<h4><a name="Respond_Mediator"></a>Respond Mediator</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample440.html">Sample 440: Respond Mediator - Echo Service with a Proxy service</a></li> + +<li><a href="samples/sample441.html">Sample 441: Respond Mediator - Mock Service with a Proxy service</a></li> + + </ul> + + </div> +<div class="section"> +<h4><a name="URL_Rewrite_Mediator"></a>URL Rewrite Mediator</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample450.html">Sample 450: Introduction to the URL Rewrite mediator</a></li> + +<li><a href="samples/sample451.html">Sample 451: Conditional URL rewriting</a></li> + +<li><a href="samples/sample452.html">Sample 452: Conditional URL rewriting with multiple rules</a></li> + </ul> + + </div> +<div class="section"> +<h4><a name="Spring_Mediator"></a>Spring Mediator</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample460.html">Sample 460: Introduction to the Spring mediator</a></li> + </ul> + + + + </div> +<div class="section"> +<h4><a name="EJB_Mediator"></a>EJB Mediator</h4> + +<p> + </p> +<ul> + +<li><a href="samples/sample470.html">Sample 470: Introduction to the EJB mediator I: Invoking Stateless Session Beans</a></li> + +<li><a href="samples/sample471.html">Sample 471: Introduction to the EJB mediator II: Invoking Stateful Session Beans</a></li> + </ul> + + + + </div></div> + +<div class="section"> +<h3><a name="Eventing"></a>Eventing</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample500.html">Sample 500: Introduction to Eventing</a></li> + +<li><a href="samples/sample501.html">Sample 501: Event source with static subscriptions</a></li> + +<li><a href="samples/sample502.html">Sample 502: Transforming events before publish</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Synapse_Configuration_Model"></a>Synapse Configuration Model</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample600.html">Sample 600: File hierarchy based configuration builder</a></li> + +<li><a href="samples/sample601.html">Sample 601: Using Synapse Observers</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Priority_Based_Mediation"></a>Priority Based Mediation</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample650.html">Sample 650: Introduction to priority based mediation</a></li> + +<li><a href="samples/sample651.html">Sample 651: Priority based dispatching at transport level</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Message_Stores_and_Message_Processors"></a>Message Stores and Message Processors</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample700.html">Sample 700: Introduction to Synapse Message Stores</a></li> + +<li><a href="samples/sample701.html">Sample 701: Introduction to Message Sampling Processor</a></li> + +<li><a href="samples/sample702.html">Sample 702: Introduction to Message Forwarding Processor</a></li> + +<li><a href="samples/sample703.html">Sample 703: Introduction to Message Resequencing Processor</a></li> + +<li><a href="samples/sample704.html">Sample 704: Invoke Secured Services with Scheduled Message Forwarding Processor</a></li> + +<li><a href="samples/sample705.html">Sample 705: Introduction to Message Forwarding Processor With Advance Parameters</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Templates"></a>Templates</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample750.html">Sample 750: Introduction to Synapse Templates</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="REST_API"></a>REST API</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample800.html">Sample 800: Introduction to REST APIs</a></li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Synapse_EIP_Library"></a>Synapse EIP Library</h3> + +<p> + </p> +<ul> + +<li><a href="samples/sample850.html">Sample 850: Introduction to Synapse Callout Block function template</a></li> + +<li><a href="samples/sample851.html">Sample 851: Introduction to Synapse Splitter and Aggregator eip function templates</a></li> + +<li><a href="samples/sample852.html">Sample 852: Introduction to Synapse Splitter-Agrregator combined function template</a></li> + +<li><a href="samples/sample853.html">Sample 853: Introduction to Synapse Scatter-Gather eip function template</a></li> + +<li><a href="samples/sample854.html">Sample 854: Introduction to Synapse Wire Tap eip function template</a></li> + +<li><a href="samples/sample855.html">Sample 855: Introduction to Synapse Content Based Router eip function template</a></li> + +<li><a href="samples/sample856.html">Sample 856: Introduction to Synapse Dynamic Router eip function template</a></li> + +<li><a href="samples/sample857.html">Sample 857: Introduction to Synapse Recipient List eip function template</a></li> + </ul> + + </div> + </div> + + + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2017 +<a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html>
Added: synapse/site/3_0_1/userguide/samples/sample0.html URL: http://svn.apache.org/viewvc/synapse/site/3_0_1/userguide/samples/sample0.html?rev=1817077&view=auto ============================================================================== --- synapse/site/3_0_1/userguide/samples/sample0.html (added) +++ synapse/site/3_0_1/userguide/samples/sample0.html Mon Dec 4 09:53:57 2017 @@ -0,0 +1,208 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-12-04 + | Rendered using Apache Maven Fluido Skin 1.6 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20171204" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Synapse – Apache Synapse - Sample 0</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" /> + <link rel="stylesheet" href="../../css/site.css" /> + <link rel="stylesheet" href="../../css/print.css" media="print" /> + <script type="text/javascript" src="../../js/apache-maven-fluido-1.6.min.js"></script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><div id="bannerLeft"><h2>Apache Synapse</h2> +</div> +</div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li id="publishDate">Last Published: 2017-12-04<span class="divider">|</span> +</li> + <li id="projectVersion">Version: 3.0.1</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> +<ul class="nav nav-list"> + <li class="nav-header">Main Menu</li> + <li><a href="../../index.html" title="Home"><span class="none"></span>Home</a> </li> + <li><a href="../../download.html" title="Download"><span class="none"></span>Download</a> </li> + <li><a href="../../history.html" title="History"><span class="none"></span>History</a> </li> + <li><a href="http://www.apache.org/licenses/LICENSE-2.0"; class="externalLink" title="License"><span class="none"></span>License</a> </li> + <li><a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a> </li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a> </li> + <li><a href="http://www.apache.org/security/"; class="externalLink" title="Security"><span class="none"></span>Security</a> </li> + <li class="nav-header">Documentation</li> + <li><a href="../../userguide/installation.html" title="Installation Guide"><span class="none"></span>Installation Guide</a> </li> + <li><a href="../../userguide/quick_start.html" title="Quick Start Guide"><span class="none"></span>Quick Start Guide</a> </li> + <li><a href="../../userguide/samples/setup/index.html" title="Samples Setup Guide"><span class="none"></span>Samples Setup Guide</a> </li> + <li><a href="../../userguide/samples.html" title="Samples Catalog"><span class="none"></span>Samples Catalog</a> </li> + <li><a href="../../userguide/config.html" title="Configuration Language"><span class="none"></span>Configuration Language</a> </li> + <li><a href="../../userguide/mediators.html" title="Mediators Catalog"><span class="none"></span>Mediators Catalog</a> </li> + <li><a href="../../userguide/transports.html" title="Transports Catalog"><span class="none"></span>Transports Catalog</a> </li> + <li><a href="../../userguide/properties.html" title="Properties Catalog"><span class="none"></span>Properties Catalog</a> </li> + <li><a href="../../userguide/xpath.html" title="XPath functions and Variables"><span class="none"></span>XPath functions and Variables</a> </li> + <li><a href="../../userguide/extending.html" title="Extending Synapse"><span class="none"></span>Extending Synapse</a> </li> + <li><a href="../../userguide/template_library.html" title="Synapse Template Libraries"><span class="none"></span>Synapse Template Libraries</a> </li> + <li><a href="../../userguide/upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a> </li> + <li><a href="../../userguide/deployment.html" title="Deployment"><span class="none"></span>Deployment</a> </li> + <li><a href="../../apidocs/" title="Javadocs"><span class="none"></span>Javadocs</a> </li> + <li><a href="../../userguide/faq.html" title="FAQ"><span class="none"></span>FAQ</a> </li> + <li class="nav-header">Developer Resources</li> + <li><a href="../../dev/developer-guide.html" title="Developer Guide"><span class="none"></span>Developer Guide</a> </li> + <li><a href="../../dev/best-practices.html" title="Development Best Practices"><span class="none"></span>Development Best Practices</a> </li> + <li><a href="../../dev/release-process.html" title="Release Process"><span class="none"></span>Release Process</a> </li> + <li class="nav-header">Project Details</li> + <li><a href="../../project-info.html" title="Overview"><span class="none"></span>Overview</a> </li> + <li><a href="../../mail-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a> </li> + <li><a href="../../source-repository.html" title="Source Repository"><span class="none"></span>Source Repository</a> </li> + <li><a href="../../issue-tracking.html" title="Issue Tracking"><span class="none"></span>Issue Tracking</a> </li> + <li><a href="../../dependency-management.html" title="Dependencies"><span class="none"></span>Dependencies</a> </li> + <li><a href="../../team-list.html" title="Project Team"><span class="none"></span>Project Team</a> </li> + </ul> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > + + + <div class="section"> +<h2><a name="Sample_0:_Introduction_to_Synapse"></a>Sample 0: Introduction to Synapse</h2> + +<div class="xmlConf"><definitions xmlns="http://ws.apache.org/ns/synapse"> + + <sequence name="main"> + <!-- log all attributes of messages passing through --> + <log level="full"/> + + <!-- Send the message to implicit destination --> + <send/> + <sequence/> + +</definitions></div> + +<div class="section"> +<h3><a name="Objective"></a>Objective</h3> + +<p> + Introduction to Synapse - Shows how Synape can be configured to log and pass + messages through. + </p> + </div> + +<div class="section"> +<h3><a name="Pre-requisites"></a>Pre-requisites</h3> + +<p> + </p> +<ul> + +<li>Deploy the SimpleStockQuoteService in the sample Axis2 server and start Axis2</li> + +<li> + Start Synapse using the configuration numbered 0 (repository/conf/sample/synapse_sample_0.xml) + +<div class="command"> + Unix/Linux: sh synapse.sh -sample 0<br /> + Windows: synapse.bat -sample 0 + </div> + </li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Executing_the_Client"></a>Executing the Client</h3> + +<div class="section"> +<h4><a name="Smart_Client_Mode"></a>Smart Client Mode</h4> + +<p> + Execute the client in the smart client mode using the following command. + </p> + +<div class="command">ant stockquote -Daddurl=http://localhost:9000/services/SimpleStockQuoteService -Dtrpurl=http://localhost:8280/</div> + +<p> + By tracing the execution of Synapse with the log output level set to DEBUG, + you will see that the client request is arriving at Synapse with a WS-Addressing 'To' + header set to EPR http://localhost:9000/services/SimpleStockQuoteService. The + Synapse engine logs the message at the 'full' log level (i.e. all the + message headers and the body) and then sends it to its explicit 'To' + address which is http://localhost:9000/services/SimpleStockQuoteService. + You will see a log entry in the Axis2 server console confirming that the message + got routed to the sample server and the service hosted at the server generated + a stock quote for the requested symbol. + </p> + +<div class="consoleOutput">Sat Nov 18 21:01:23 IST 2006 SimpleStockQuoteService :: Generating quote for : IBM</div> + +<p> + The response message generated by the service is received by Synapse, + and flows through the same mediation rules, which log the response and + send back to the client. On the client console you should see an output + similar to the following based on the message received by the client. + </p> + +<div class="consoleOutput">Standard :: Stock price = $95.26454380258552</div> + + </div> +<div class="section"> +<h4><a name="Proxy_Client_Mode"></a>Proxy Client Mode</h4> + +<p> + Execute the sample Axis2 client as follows to run it in the proxy mode. + </p> + +<div class="command">ant stockquote -Daddurl=http://localhost:9000/services/SimpleStockQuoteService -Dprxurl=http://localhost:8280/</div> + +<p> + You will see the exact same behaviour as per the previous example when you run + this scenario. However this time the client sends the message to the Axis2 server + using Synapse as a HTTP proxy. + </p> + +<p> + The Axis2 client supports another mode of operation known as the 'dumb client + mode'. This will be addressed in <a href="sample1.html">sample 1</a>. + </p> + </div></div> + </div> + +<p><a href="../samples.html">Back to Catalog</a></p> + + + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2017 +<a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> Added: synapse/site/3_0_1/userguide/samples/sample1.html URL: http://svn.apache.org/viewvc/synapse/site/3_0_1/userguide/samples/sample1.html?rev=1817077&view=auto ============================================================================== --- synapse/site/3_0_1/userguide/samples/sample1.html (added) +++ synapse/site/3_0_1/userguide/samples/sample1.html Mon Dec 4 09:53:57 2017 @@ -0,0 +1,194 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-12-04 + | Rendered using Apache Maven Fluido Skin 1.6 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20171204" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Synapse – Apache Synapse - Sample 1</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" /> + <link rel="stylesheet" href="../../css/site.css" /> + <link rel="stylesheet" href="../../css/print.css" media="print" /> + <script type="text/javascript" src="../../js/apache-maven-fluido-1.6.min.js"></script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><div id="bannerLeft"><h2>Apache Synapse</h2> +</div> +</div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li id="publishDate">Last Published: 2017-12-04<span class="divider">|</span> +</li> + <li id="projectVersion">Version: 3.0.1</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> +<ul class="nav nav-list"> + <li class="nav-header">Main Menu</li> + <li><a href="../../index.html" title="Home"><span class="none"></span>Home</a> </li> + <li><a href="../../download.html" title="Download"><span class="none"></span>Download</a> </li> + <li><a href="../../history.html" title="History"><span class="none"></span>History</a> </li> + <li><a href="http://www.apache.org/licenses/LICENSE-2.0"; class="externalLink" title="License"><span class="none"></span>License</a> </li> + <li><a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a> </li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a> </li> + <li><a href="http://www.apache.org/security/"; class="externalLink" title="Security"><span class="none"></span>Security</a> </li> + <li class="nav-header">Documentation</li> + <li><a href="../../userguide/installation.html" title="Installation Guide"><span class="none"></span>Installation Guide</a> </li> + <li><a href="../../userguide/quick_start.html" title="Quick Start Guide"><span class="none"></span>Quick Start Guide</a> </li> + <li><a href="../../userguide/samples/setup/index.html" title="Samples Setup Guide"><span class="none"></span>Samples Setup Guide</a> </li> + <li><a href="../../userguide/samples.html" title="Samples Catalog"><span class="none"></span>Samples Catalog</a> </li> + <li><a href="../../userguide/config.html" title="Configuration Language"><span class="none"></span>Configuration Language</a> </li> + <li><a href="../../userguide/mediators.html" title="Mediators Catalog"><span class="none"></span>Mediators Catalog</a> </li> + <li><a href="../../userguide/transports.html" title="Transports Catalog"><span class="none"></span>Transports Catalog</a> </li> + <li><a href="../../userguide/properties.html" title="Properties Catalog"><span class="none"></span>Properties Catalog</a> </li> + <li><a href="../../userguide/xpath.html" title="XPath functions and Variables"><span class="none"></span>XPath functions and Variables</a> </li> + <li><a href="../../userguide/extending.html" title="Extending Synapse"><span class="none"></span>Extending Synapse</a> </li> + <li><a href="../../userguide/template_library.html" title="Synapse Template Libraries"><span class="none"></span>Synapse Template Libraries</a> </li> + <li><a href="../../userguide/upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a> </li> + <li><a href="../../userguide/deployment.html" title="Deployment"><span class="none"></span>Deployment</a> </li> + <li><a href="../../apidocs/" title="Javadocs"><span class="none"></span>Javadocs</a> </li> + <li><a href="../../userguide/faq.html" title="FAQ"><span class="none"></span>FAQ</a> </li> + <li class="nav-header">Developer Resources</li> + <li><a href="../../dev/developer-guide.html" title="Developer Guide"><span class="none"></span>Developer Guide</a> </li> + <li><a href="../../dev/best-practices.html" title="Development Best Practices"><span class="none"></span>Development Best Practices</a> </li> + <li><a href="../../dev/release-process.html" title="Release Process"><span class="none"></span>Release Process</a> </li> + <li class="nav-header">Project Details</li> + <li><a href="../../project-info.html" title="Overview"><span class="none"></span>Overview</a> </li> + <li><a href="../../mail-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a> </li> + <li><a href="../../source-repository.html" title="Source Repository"><span class="none"></span>Source Repository</a> </li> + <li><a href="../../issue-tracking.html" title="Issue Tracking"><span class="none"></span>Issue Tracking</a> </li> + <li><a href="../../dependency-management.html" title="Dependencies"><span class="none"></span>Dependencies</a> </li> + <li><a href="../../team-list.html" title="Project Team"><span class="none"></span>Project Team</a> </li> + </ul> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > + + + <div class="section"> +<h2><a name="Sample_1:_Simple_Content_Based_Routing_CBR_of_Messages"></a>Sample 1: Simple Content Based Routing (CBR) of Messages</h2> + +<div class="xmlConf"><definitions xmlns="http://ws.apache.org/ns/synapse"> + + <sequence name="main"> + <!-- filtering of messages with XPath and regex matches --> + <filter source="get-property('To')" regex=".*/StockQuote.*"> + <then> + <send> + <endpoint> + <address uri="http://localhost:9000/services/SimpleStockQuoteService"/> + </endpoint> + </send> + <drop/> + </then> + </filter> + <send/> + </sequence> + +</definitions></div> + +<div class="section"> +<h3><a name="Objective"></a>Objective</h3> + +<p> + Introduction to simple content based routing - Shows how a message could be + made to pass through Synapse using the dumb client mode, where Synapse acts as + a gateway to accept all messages and then perform mediation and routing based + on message properties or content. + </p> + </div> + +<div class="section"> +<h3><a name="Pre-requisites"></a>Pre-requisites</h3> + +<p> + </p> +<ul> + +<li> + Deploy the SimpleStockQuoteService in the sample Axis2 server and start Axis2 + </li> + +<li> + Start Synapse using the configuration numbered 1 (repository/conf/sample/synapse_sample_1.xml) + +<div class="command"> + Unix/Linux: sh synapse.sh -sample 1<br /> + Windows: synapse.bat -sample 1 + </div> + </li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Executing_the_Client"></a>Executing the Client</h3> + +<p>Execute the sample client in the dumb client mode using the following command.</p> + +<div class="command">ant stockquote -Dtrpurl=http://localhost:8280/services/StockQuote</div> + + +<p> + This time you will see Synapse receiving a message for which Synapse was set + as the ultimate receiver. The filter mediator in the main sequence performs + a regular expression match on the 'To' header (http://localhost:8280/services/StockQuote) + to check whether it matches the expression ".*/StockQuote.*". Since the 'To' header + matches this expression the child mediators of the filter mediator get executed. + As a result, the message is sent to the Axis2 server. The drop mediator after + the send mediator terminates the flow of the sequence. Axis2 server will print + the following log when it receives the stock quote request from Synapse. + </p> + +<div class="consoleOutput">Sat Nov 18 21:01:23 IST 2006 SimpleStockQuoteService :: Generating quote for : IBM</div> + +<p> + During response processing, the filter condition fails, and thus the child mediators + of the filter are skipped. The 'send' mediator at the end of the sequence + forwards the response back to the client using the implicit 'To' address. + The client will print a message similar to the following when it receives the + response. + </p> + +<div class="consoleOutput">Standard :: Stock price = $95.26454380258552</div> + </div> + </div> + +<p><a href="../samples.html">Back to Catalog</a></p> + + + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2017 +<a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> Added: synapse/site/3_0_1/userguide/samples/sample10.html URL: http://svn.apache.org/viewvc/synapse/site/3_0_1/userguide/samples/sample10.html?rev=1817077&view=auto ============================================================================== --- synapse/site/3_0_1/userguide/samples/sample10.html (added) +++ synapse/site/3_0_1/userguide/samples/sample10.html Mon Dec 4 09:53:57 2017 @@ -0,0 +1,196 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-12-04 + | Rendered using Apache Maven Fluido Skin 1.6 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20171204" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Synapse – Apache Synapse - Sample 10</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" /> + <link rel="stylesheet" href="../../css/site.css" /> + <link rel="stylesheet" href="../../css/print.css" media="print" /> + <script type="text/javascript" src="../../js/apache-maven-fluido-1.6.min.js"></script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><div id="bannerLeft"><h2>Apache Synapse</h2> +</div> +</div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li id="publishDate">Last Published: 2017-12-04<span class="divider">|</span> +</li> + <li id="projectVersion">Version: 3.0.1</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> +<ul class="nav nav-list"> + <li class="nav-header">Main Menu</li> + <li><a href="../../index.html" title="Home"><span class="none"></span>Home</a> </li> + <li><a href="../../download.html" title="Download"><span class="none"></span>Download</a> </li> + <li><a href="../../history.html" title="History"><span class="none"></span>History</a> </li> + <li><a href="http://www.apache.org/licenses/LICENSE-2.0"; class="externalLink" title="License"><span class="none"></span>License</a> </li> + <li><a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a> </li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a> </li> + <li><a href="http://www.apache.org/security/"; class="externalLink" title="Security"><span class="none"></span>Security</a> </li> + <li class="nav-header">Documentation</li> + <li><a href="../../userguide/installation.html" title="Installation Guide"><span class="none"></span>Installation Guide</a> </li> + <li><a href="../../userguide/quick_start.html" title="Quick Start Guide"><span class="none"></span>Quick Start Guide</a> </li> + <li><a href="../../userguide/samples/setup/index.html" title="Samples Setup Guide"><span class="none"></span>Samples Setup Guide</a> </li> + <li><a href="../../userguide/samples.html" title="Samples Catalog"><span class="none"></span>Samples Catalog</a> </li> + <li><a href="../../userguide/config.html" title="Configuration Language"><span class="none"></span>Configuration Language</a> </li> + <li><a href="../../userguide/mediators.html" title="Mediators Catalog"><span class="none"></span>Mediators Catalog</a> </li> + <li><a href="../../userguide/transports.html" title="Transports Catalog"><span class="none"></span>Transports Catalog</a> </li> + <li><a href="../../userguide/properties.html" title="Properties Catalog"><span class="none"></span>Properties Catalog</a> </li> + <li><a href="../../userguide/xpath.html" title="XPath functions and Variables"><span class="none"></span>XPath functions and Variables</a> </li> + <li><a href="../../userguide/extending.html" title="Extending Synapse"><span class="none"></span>Extending Synapse</a> </li> + <li><a href="../../userguide/template_library.html" title="Synapse Template Libraries"><span class="none"></span>Synapse Template Libraries</a> </li> + <li><a href="../../userguide/upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a> </li> + <li><a href="../../userguide/deployment.html" title="Deployment"><span class="none"></span>Deployment</a> </li> + <li><a href="../../apidocs/" title="Javadocs"><span class="none"></span>Javadocs</a> </li> + <li><a href="../../userguide/faq.html" title="FAQ"><span class="none"></span>FAQ</a> </li> + <li class="nav-header">Developer Resources</li> + <li><a href="../../dev/developer-guide.html" title="Developer Guide"><span class="none"></span>Developer Guide</a> </li> + <li><a href="../../dev/best-practices.html" title="Development Best Practices"><span class="none"></span>Development Best Practices</a> </li> + <li><a href="../../dev/release-process.html" title="Release Process"><span class="none"></span>Release Process</a> </li> + <li class="nav-header">Project Details</li> + <li><a href="../../project-info.html" title="Overview"><span class="none"></span>Overview</a> </li> + <li><a href="../../mail-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a> </li> + <li><a href="../../source-repository.html" title="Source Repository"><span class="none"></span>Source Repository</a> </li> + <li><a href="../../issue-tracking.html" title="Issue Tracking"><span class="none"></span>Issue Tracking</a> </li> + <li><a href="../../dependency-management.html" title="Dependencies"><span class="none"></span>Dependencies</a> </li> + <li><a href="../../team-list.html" title="Project Team"><span class="none"></span>Project Team</a> </li> + </ul> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > + + + <div class="section"> +<h2><a name="Sample_10:_Introduction_to_Dynamic_Endpoints_with_Registry"></a>Sample 10: Introduction to Dynamic Endpoints with Registry</h2> + +<div class="xmlConf"><definitions xmlns="http://ws.apache.org/ns/synapse"> + + <registry provider="org.apache.synapse.registry.url.SimpleURLRegistry"> + <parameter name="root">file:repository/conf/sample/resources/</parameter> + <parameter name="cachableDuration">15000</parameter> + </registry> + + <sequence name="main"> + <in> + <send> + <endpoint key="endpoint/dynamic_endpt_1.xml"/> + </send> + </in> + <out> + <send/> + </out> + </sequence> + +</definitions></div> + +<div class="section"> +<h3><a name="Objective"></a>Objective</h3> + +<p> + Demonstrating the ability to load endpoint definitions dynamically from the + remote registry. + </p> + </div> + +<div class="section"> +<h3><a name="Pre-requisites"></a>Pre-requisites</h3> + +<p> + </p> +<ul> + +<li> + Deploy the SimpleStockQuoteService in the sample Axis2 server and start Axis2 + </li> + +<li> + Start another Axis2 server instance on different ports (use the following command) + +<div class="command"> + Unix/Linux: sh axis2server.sh -http 9001 -https 9003<br /> + Windows: axis2server.bat -http 9001 -https 9003 + </div> + </li> + +<li> + Start Synapse using the configuration numbered 10 (repository/conf/sample/synapse_sample_10.xml) + +<div class="command"> + Unix/Linux: sh synapse.sh -sample 10<br /> + Windows: synapse.bat -sample 10 + </div> + </li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Executing_the_Client"></a>Executing the Client</h3> + +<p> + This example introduces dynamic endpoints, where the definition of the endpoint + is stored in the registry. To follow this example execute the stock quote client + as 'ant stockquote..' and see that the message is routed to the SimpleStockQuoteService + on the default Axis2 instance on HTTP port 9000. + </p> + +<div class="command">ant stockquote -Dtrpurl=http://localhost:8280/</div> + +<p> + Repeat the above command immediately again, and notice that the endpoint is + cached and reused by Synapse - similarly to <a href="sample8.html">sample 8</a>. + </p> + +<p> + Now edit the repository/conf/sample/resources/endpoint/dynamic_endpt_1.xml file + and update the address to 'http://localhost:9001/services/SimpleStockQuoteService'. + After the cached value expires, the Registry loads the new definition of the + endpoint, and then the messages are routed to the second sample Axis2 server on + HTTP port 9001. + </p> + </div> + </div> + +<p><a href="../samples.html">Back to Catalog</a></p> + + + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2017 +<a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> Added: synapse/site/3_0_1/userguide/samples/sample100.html URL: http://svn.apache.org/viewvc/synapse/site/3_0_1/userguide/samples/sample100.html?rev=1817077&view=auto ============================================================================== --- synapse/site/3_0_1/userguide/samples/sample100.html (added) +++ synapse/site/3_0_1/userguide/samples/sample100.html Mon Dec 4 09:53:57 2017 @@ -0,0 +1,237 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-12-04 + | Rendered using Apache Maven Fluido Skin 1.6 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20171204" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Synapse – Apache Synapse - Sample 100</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" /> + <link rel="stylesheet" href="../../css/site.css" /> + <link rel="stylesheet" href="../../css/print.css" media="print" /> + <script type="text/javascript" src="../../js/apache-maven-fluido-1.6.min.js"></script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><div id="bannerLeft"><h2>Apache Synapse</h2> +</div> +</div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li id="publishDate">Last Published: 2017-12-04<span class="divider">|</span> +</li> + <li id="projectVersion">Version: 3.0.1</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> +<ul class="nav nav-list"> + <li class="nav-header">Main Menu</li> + <li><a href="../../index.html" title="Home"><span class="none"></span>Home</a> </li> + <li><a href="../../download.html" title="Download"><span class="none"></span>Download</a> </li> + <li><a href="../../history.html" title="History"><span class="none"></span>History</a> </li> + <li><a href="http://www.apache.org/licenses/LICENSE-2.0"; class="externalLink" title="License"><span class="none"></span>License</a> </li> + <li><a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a> </li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a> </li> + <li><a href="http://www.apache.org/security/"; class="externalLink" title="Security"><span class="none"></span>Security</a> </li> + <li class="nav-header">Documentation</li> + <li><a href="../../userguide/installation.html" title="Installation Guide"><span class="none"></span>Installation Guide</a> </li> + <li><a href="../../userguide/quick_start.html" title="Quick Start Guide"><span class="none"></span>Quick Start Guide</a> </li> + <li><a href="../../userguide/samples/setup/index.html" title="Samples Setup Guide"><span class="none"></span>Samples Setup Guide</a> </li> + <li><a href="../../userguide/samples.html" title="Samples Catalog"><span class="none"></span>Samples Catalog</a> </li> + <li><a href="../../userguide/config.html" title="Configuration Language"><span class="none"></span>Configuration Language</a> </li> + <li><a href="../../userguide/mediators.html" title="Mediators Catalog"><span class="none"></span>Mediators Catalog</a> </li> + <li><a href="../../userguide/transports.html" title="Transports Catalog"><span class="none"></span>Transports Catalog</a> </li> + <li><a href="../../userguide/properties.html" title="Properties Catalog"><span class="none"></span>Properties Catalog</a> </li> + <li><a href="../../userguide/xpath.html" title="XPath functions and Variables"><span class="none"></span>XPath functions and Variables</a> </li> + <li><a href="../../userguide/extending.html" title="Extending Synapse"><span class="none"></span>Extending Synapse</a> </li> + <li><a href="../../userguide/template_library.html" title="Synapse Template Libraries"><span class="none"></span>Synapse Template Libraries</a> </li> + <li><a href="../../userguide/upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a> </li> + <li><a href="../../userguide/deployment.html" title="Deployment"><span class="none"></span>Deployment</a> </li> + <li><a href="../../apidocs/" title="Javadocs"><span class="none"></span>Javadocs</a> </li> + <li><a href="../../userguide/faq.html" title="FAQ"><span class="none"></span>FAQ</a> </li> + <li class="nav-header">Developer Resources</li> + <li><a href="../../dev/developer-guide.html" title="Developer Guide"><span class="none"></span>Developer Guide</a> </li> + <li><a href="../../dev/best-practices.html" title="Development Best Practices"><span class="none"></span>Development Best Practices</a> </li> + <li><a href="../../dev/release-process.html" title="Release Process"><span class="none"></span>Release Process</a> </li> + <li class="nav-header">Project Details</li> + <li><a href="../../project-info.html" title="Overview"><span class="none"></span>Overview</a> </li> + <li><a href="../../mail-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a> </li> + <li><a href="../../source-repository.html" title="Source Repository"><span class="none"></span>Source Repository</a> </li> + <li><a href="../../issue-tracking.html" title="Issue Tracking"><span class="none"></span>Issue Tracking</a> </li> + <li><a href="../../dependency-management.html" title="Dependencies"><span class="none"></span>Dependencies</a> </li> + <li><a href="../../team-list.html" title="Project Team"><span class="none"></span>Project Team</a> </li> + </ul> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > + + + <div class="section"> +<h2><a name="Sample_100:_Using_WS-Security_for_Outgoing_Messages"></a>Sample 100: Using WS-Security for Outgoing Messages</h2> + +<div class="xmlConf"><definitions xmlns="http://ws.apache.org/ns/synapse"> + + <localEntry key="sec_policy" src="file:repository/conf/sample/resources/policy/policy_3.xml"/> + + <sequence name="main"> + <in> + <send> + <endpoint name="secure"> + <address uri="http://localhost:9000/services/SecureStockQuoteService"> + <enableSec policy="sec_policy"/> + </address> + </endpoint> + </send> + </in> + <out> + <send/> + </out> + </sequence> + +</definitions></div> + +<div class="section"> +<h3><a name="Objective"></a>Objective</h3> + +<p> + Showcase the ability of Synapse to connect to secured endpoints using WS-Security + standards + </p> + </div> + +<div class="section"> +<h3><a name="Pre-requisites"></a>Pre-requisites</h3> + +<p> + </p> +<ul> + +<li> + Download and install the Java Cryptography Extension (JCE) unlimited + strength policy files for your JDK + </li> + +<li> + Deploy the SecureStockQuoteService in the sample Axis2 server and start Axis2 + </li> + +<li> + Start Synapse using the configuration numbered 100 (repository/conf/sample/synapse_sample_100.xml) + +<div class="command"> + Unix/Linux: sh synapse.sh -sample 100<br /> + Windows: synapse.bat -sample 100 + </div> + </li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Executing_the_Client"></a>Executing the Client</h3> + +<p> + Use the stock quote client to send a request without WS-Security. Synapse is + configured to enable WS-Security as per the policy specified by 'policy_3.xml' + for the outgoing messages to the SecureStockQuoteService endpoint. + The debug log messages on Synapse shows the encrypted message flowing to the + service and the encrypted response being received by Synapse. The wsse:Security + header is then removed from the decrypted message and the response is delivered + back to the client, as expected. You may execute the client as follows: + </p> + +<div class="command">ant stockquote -Dtrpurl=http://localhost:8280/</div> + +<p> + The message sent by Synapse to the secure service can be seen as follows, when + TCPMon is used. + </p> + +<div class="consoleOutput">POST http://localhost:9001/services/SecureStockQuoteService HTTP/1.1 +Host: 127.0.0.1 +SOAPAction: urn:getQuote +Content-Type: text/xml; charset=UTF-8 +Transfer-Encoding: chunked +Connection: Keep-Alive +User-Agent: Synapse-HttpComponents-NIO + +800 +<?xml version='1.0' encoding='UTF-8'?> +<soapenv:Envelope xmlns:xenc="http://www.w3.org/2001/04/xmlenc#" xmlns:wsa="http://www.w3.org/2005/08/addressing" ..> + <soapenv:Header> + <wsse:Security ..> + <wsu:Timestamp ..> + ... + </wsu:Timestamp> + <xenc:EncryptedKey..> + ... + </xenc:EncryptedKey> + <wsse:BinarySecurityToken ...> + <ds:SignedInfo> + ... + </ds:SignedInfo> + <ds:SignatureValue> + ... + </ds:SignatureValue> + <ds:KeyInfo Id="KeyId-29551621"> + ... + </ds:KeyInfo> + </ds:Signature> + </wsse:Security> + <wsa:To>http://localhost:9001/services/SecureStockQuoteService</wsa:To> + <wsa:MessageID>urn:uuid:1C4CE88B8A1A9C09D91177500753443</wsa:MessageID> + <wsa:Action>urn:getQuote</wsa:Action> + </soapenv:Header> + <soapenv:Body xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Id-3789605"> + <xenc:EncryptedData Id="EncDataId-3789605" Type="http://www.w3.org/2001/04/xmlenc#Content"> + <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes256-cbc" /> + <xenc:CipherData> + <xenc:CipherValue>Layg0xQcnH....6UKm5nKU6Qqr</xenc:CipherValue> + </xenc:CipherData> + </xenc:EncryptedData> + </soapenv:Body> +</soapenv:Envelope>0</div> + +<p> + Note the WS-Security headers and the encrypted payload added by Synapse. + </p> + </div> + </div> + +<p><a href="../samples.html">Back to Catalog</a></p> + + + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2017 +<a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> Added: synapse/site/3_0_1/userguide/samples/sample11.html URL: http://svn.apache.org/viewvc/synapse/site/3_0_1/userguide/samples/sample11.html?rev=1817077&view=auto ============================================================================== --- synapse/site/3_0_1/userguide/samples/sample11.html (added) +++ synapse/site/3_0_1/userguide/samples/sample11.html Mon Dec 4 09:53:57 2017 @@ -0,0 +1,190 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-12-04 + | Rendered using Apache Maven Fluido Skin 1.6 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20171204" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Synapse – Apache Synapse - Sample 11</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" /> + <link rel="stylesheet" href="../../css/site.css" /> + <link rel="stylesheet" href="../../css/print.css" media="print" /> + <script type="text/javascript" src="../../js/apache-maven-fluido-1.6.min.js"></script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><div id="bannerLeft"><h2>Apache Synapse</h2> +</div> +</div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li id="publishDate">Last Published: 2017-12-04<span class="divider">|</span> +</li> + <li id="projectVersion">Version: 3.0.1</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> +<ul class="nav nav-list"> + <li class="nav-header">Main Menu</li> + <li><a href="../../index.html" title="Home"><span class="none"></span>Home</a> </li> + <li><a href="../../download.html" title="Download"><span class="none"></span>Download</a> </li> + <li><a href="../../history.html" title="History"><span class="none"></span>History</a> </li> + <li><a href="http://www.apache.org/licenses/LICENSE-2.0"; class="externalLink" title="License"><span class="none"></span>License</a> </li> + <li><a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a> </li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a> </li> + <li><a href="http://www.apache.org/security/"; class="externalLink" title="Security"><span class="none"></span>Security</a> </li> + <li class="nav-header">Documentation</li> + <li><a href="../../userguide/installation.html" title="Installation Guide"><span class="none"></span>Installation Guide</a> </li> + <li><a href="../../userguide/quick_start.html" title="Quick Start Guide"><span class="none"></span>Quick Start Guide</a> </li> + <li><a href="../../userguide/samples/setup/index.html" title="Samples Setup Guide"><span class="none"></span>Samples Setup Guide</a> </li> + <li><a href="../../userguide/samples.html" title="Samples Catalog"><span class="none"></span>Samples Catalog</a> </li> + <li><a href="../../userguide/config.html" title="Configuration Language"><span class="none"></span>Configuration Language</a> </li> + <li><a href="../../userguide/mediators.html" title="Mediators Catalog"><span class="none"></span>Mediators Catalog</a> </li> + <li><a href="../../userguide/transports.html" title="Transports Catalog"><span class="none"></span>Transports Catalog</a> </li> + <li><a href="../../userguide/properties.html" title="Properties Catalog"><span class="none"></span>Properties Catalog</a> </li> + <li><a href="../../userguide/xpath.html" title="XPath functions and Variables"><span class="none"></span>XPath functions and Variables</a> </li> + <li><a href="../../userguide/extending.html" title="Extending Synapse"><span class="none"></span>Extending Synapse</a> </li> + <li><a href="../../userguide/template_library.html" title="Synapse Template Libraries"><span class="none"></span>Synapse Template Libraries</a> </li> + <li><a href="../../userguide/upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a> </li> + <li><a href="../../userguide/deployment.html" title="Deployment"><span class="none"></span>Deployment</a> </li> + <li><a href="../../apidocs/" title="Javadocs"><span class="none"></span>Javadocs</a> </li> + <li><a href="../../userguide/faq.html" title="FAQ"><span class="none"></span>FAQ</a> </li> + <li class="nav-header">Developer Resources</li> + <li><a href="../../dev/developer-guide.html" title="Developer Guide"><span class="none"></span>Developer Guide</a> </li> + <li><a href="../../dev/best-practices.html" title="Development Best Practices"><span class="none"></span>Development Best Practices</a> </li> + <li><a href="../../dev/release-process.html" title="Release Process"><span class="none"></span>Release Process</a> </li> + <li class="nav-header">Project Details</li> + <li><a href="../../project-info.html" title="Overview"><span class="none"></span>Overview</a> </li> + <li><a href="../../mail-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a> </li> + <li><a href="../../source-repository.html" title="Source Repository"><span class="none"></span>Source Repository</a> </li> + <li><a href="../../issue-tracking.html" title="Issue Tracking"><span class="none"></span>Issue Tracking</a> </li> + <li><a href="../../dependency-management.html" title="Dependencies"><span class="none"></span>Dependencies</a> </li> + <li><a href="../../team-list.html" title="Project Team"><span class="none"></span>Project Team</a> </li> + </ul> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > + + + <div class="section"> +<h2><a name="Sample_11:_A_Full_Registry_based_Configuration_and_Sharing_Configuration_Between_Multiple_Instances"></a>Sample 11: A Full Registry based Configuration, and Sharing Configuration Between Multiple Instances</h2> + +<div class="xmlConf"><definitions xmlns="http://ws.apache.org/ns/synapse"> + + <registry provider="org.apache.synapse.registry.url.SimpleURLRegistry"> + <parameter name="root">file:./repository/conf/sample/resources/</parameter> + <parameter name="cachableDuration">15000</parameter> + </registry> + +</definitions></div> + +<div class="section"> +<h3><a name="Objective"></a>Objective</h3> + +<p> + Demonstrating the ability of Synapse to load the entire configuration from + a remote registry. This approach can also be used to share a single configuration + between multiple Synapse instances by pointing all the Synapse instances to the + same URL registry. + </p> + </div> + +<div class="section"> +<h3><a name="Pre-requisites"></a>Pre-requisites</h3> + +<p> + </p> +<ul> + +<li> + Deploy the SimpleStockQuoteService in the sample Axis2 server and start Axis2 + </li> + +<li> + Start Synapse using the configuration numbered 11 (repository/conf/sample/synapse_sample_11.xml) + +<div class="command"> + Unix/Linux: sh synapse.sh -sample 11<br /> + Windows: synapse.bat -sample 11 + </div> + </li> + </ul> + + </div> + +<div class="section"> +<h3><a name="Executing_the_Client"></a>Executing the Client</h3> + +<p> + This example shows a full registry based Synapse configuration. This makes it + possible to easily start multiple instances of Synapse sharing a single configuration + in a clustered environment. The Synapse configuration of a given node hosting + Synapse simply points to the registry and looks up the actual configuration by + requesting the key 'synapse.xml'. + </p> + +<p>(Note: Full registry based configuration is not dynamic atleast for the moment - + i.e. it is not reloading itself)</p> + +<p> + Invoke the client as follows. + </p> + +<div class="command">ant stockquote -Daddurl=http://localhost:9000/services/SimpleStockQuoteService -Dtrpurl=http://localhost:8280/</div> + +<p> + Synapse will generate the following log output. + </p> + +<div class="consoleOutput">[HttpServerWorker-1] INFO LogMediator - message = This is a dynamic Synapse configuration</div> + +<p>The actual synapse.xml loaded from the registry is: </p> + +<div class="xmlConf"><!-- a registry based Synapse configuration --> +<definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton"> + <log level="custom"> + <property name="message" value="This is a dynamic Synapse configuration $$$"/> + </log> + <send/> +</definitions></div> + + </div> + </div> + +<p><a href="../samples.html">Back to Catalog</a></p> + + + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2017 +<a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html>
