WSO2 ESB Introduction to Inbound Endpoints
- 1. Introduction to Inbound Endpoints Isuru Udana Associate Technical Lead Viraj Senevirathne Software Engineer Nov 2015
- 2. About the Presenters ● Isuru UdanaAssociate Technical Lead WSO2 ● Viraj Senevirathne Software Engineer WSO2
- 3. Outline ● Background ● ESB Basics ● Introduction to Inbound Endpoints ● HTTP Inbound Endpoint ● JMS Inbound Endpoint ● File Inbound Endpoint ● Demo ● Q & A
- 4. WSO2 ESB ● A lightweight, high performance ESB ● Feature rich and standards compliant ○ SOAP and WS-* standards ○ REST support ● Domain specific protocol support (eg: FIX, HL7) ● User friendly and highly extensible ● 100% free and open source with commercial support
- 5. Key Features - Routing
- 6. Key Features - Filtering
- 7. Key Features - Transformation
- 8. Key Features - Protocol Switch
- 9. Key Features - Load Balancing
- 10. Key Features - Quality of Service
- 11. WSO2 ESB Basics
- 12. High Level Message Flow
- 13. High Level Message Flow
- 14. Basic Constructs
- 15. Building Blocks
- 17. Invoking Messages Flows Messages can be injected into sequences through the following interfaces:
- 18. Invoking Messages Flows Proxy Services ● Acts like a virtual service. ● Receives messages and mediates them before sending them to the endpoint (usually an actual service) Eg: Perform necessary transformations and/or introduce additional functionality without changing existing service.
- 19. Invoking Messages Flows APIs (HTTP Services) ● APIs can accept REST messages which allow clients to provide additional information on how to manage the message ● Unmanaged API (API-Manager for managed APIs) ● Can handle multiple URLs ● Can handle parameters in the URL
- 20. Invoking Messages Flows Main Sequence ● Messages not destined for Proxy Services/API are sent through Main
- 21. Invoking Messages Flows Tasks ● Allow configuration of scheduled jobs to execute internal/external commands ● Inject a message into a proxy service, Main sequence or a named sequence
- 22. Invoking Messages Flows Inbound Endpoints ● Newly introduced in ESB 4.9.0 release ● New Message Entry point
- 24. Inbound Endpoints ● New Message Entry point
- 25. Why Inbound Endpoints ? Limitations prior to ESB 4.9.0 ● Conventional axis2 based Transports does not support dynamic configuration Ex: To change the ports, restart is required axis2.xml configuration
- 26. Why Inbound Endpoints ? Limitations prior to ESB 4.9.0 ● Multi-tenancy support is limited ○ Only HTTP Transport supports multi-tenancy
- 27. Inbound Endpoints Features ● A message source that can be configured dynamically
- 28. ● Inbound architecture allows Multi-tenancy for all transports ○ JMS, VFS, HL7, etc Inbound Endpoints Features
- 29. ● Coordination Support ○ Controlled execution on clustered environment ○ Worker-Manager deployment for all transports Inbound Endpoints Features
- 30. Coordination Support - Single Consumer Inbound Endpoints Features
- 31. Inbound Endpoints Features Coordination Support - Multiple Consumer
- 32. ● Injects messages directly from transport layer to mediation layer without going through the axis2 engine ● Dedicated thread pools per inbound ● Extending the functionality with custom inbound endpoints Inbound Endpoints Features
- 33. Inbound Endpoint Types ● Listening Inbound Endpoints ● Polling Inbound Endpoints ● Event Based Inbound Endpoints ● Custom Inbound Endpoints
- 34. Listening Inbound Endpoint ● In this endpoint type messages send to the inbound endpoint by client. ○ Ex: HTTP, HTTPS ● Starts message listening interfaces dynamically ● Fully supported in multi-tenant environments. ● HTTP, HL7, WS-RM, TCP Inbound Endpoints
- 35. ● Dynamically creates message polling interfaces. Ex: JMS Inbound Endpoint – polls a given JMS queue and inject messages into an ESB message flow. ● The the inbound endpoint will perform polling task with that specified time interval. ● We have to specify a polling interval when creating these type of inbound endpoints. Ex: File, JMS, Kafka ● Fully supported in multi-tenant environments ● Coordination support Polling Inbound Endpoint
- 36. Event Based Inbound Endpoints ● This endpoint task will run only once to establish connection with remote server. This connection will be used for executing inbound endpoint task. Ex: MQTT, RabbitMQ
- 37. Custom Inbound Endpoints ● Custom Inbound Endpoints are user defined inbound endpoints for custom tasks. ○ You will have to extend following classes for different implementations ■ Custom Listening Inbounds - GenericInboundListener ■ Custom Polling Inbounds - GenericPollingConsumer
- 39. ● Dynamically configurable http and https endpoints at ESB runtime ○ Can create separate HTTP or HTTPS listeners which can handle messages separately ● Can directly inject messages to APIs, Proxies and sequences. ○ e.g.: There is a HTTP inbound endpoint running on port 8290.In order to inject messages to a, ■ API (stockquote) - http://127.0.0.1:8290/stockquote/view/IBM ■ Proxy(StockQuoteProxy) - http://localhost:8290/services/StockQuoteProxy ■ Sequence - http://localhost:8290 ● It is possible to specify different worker pool configuration for any inbound endpoint HTTP/HTTPS Inbound Endpoint
- 40. HTTP and HTTPS Inbound Endpoints Important parameters used in HTTP and HTTPS Inbound Endpoint Parameter Description inbound.http.port The port on which the endpoint listener should be started. ( HTTP and HTTPS) keystore The KeyStore location where keys are stored.( HTTPS Only) Worker Pool Configuration Parameters (Optional) inbound.worker.pool.size.core The initial number of threads in the worker thread pool. This value can be changed accordingly based on the number of messages to be processed. (default 400) inbound.worker.pool.size.max The maximum number of threads in the worker thread pool. (default 500) Proxy Configurations related to HTTP/HTTPS inbound endpoints inbound.only Whether the proxy service needs to be exposed only via inbound endpoints.
- 41. Sample HTTP Inbound Configuration HTTP and HTTPS Inbound Endpoints
- 43. ● This is a much improved alternative to JMS Transport ● Supports multi-tenancy unlike JMS Transport ● JMS inbound protocol implementation can receive messages from active JMS server ● Supports coordination in clustered environment JMS Inbound Endpoint
- 44. Important parameters used in JMS Inbound Endpoint JMS Inbound Endpoint Parameter Description Interval How frequently JMS inbound should poll the source JMS location Eg: 10 (ms) sequential Set this to true if you want to process list of messages one after another. coordination Set this to true if you want JMS polling in one instance at a time in a clustered environment java.naming.factory.initial The JNDI initial context factory class. This class must implement the java.naming.spi.InitialContextFactory interface. java.naming.provider.url The URL of the JNDI provider. transport.jms.Destination The JNDI name of the destination. transport.jms.ConnectionFactoryJNDIName The JNDI name of the connection factory.
- 45. Sample JMS Inbound Configuration JMS Inbound Endpoint
- 47. ● This is a much improved alternative to VFS Transport ○ Improved functionality over VFS Transport ○ Improved Error handling ● Supports multi-tenancy unlike VFS Transport ● Supports coordination in clustered environment ○ When co-orrdination is enabled in clustered environment file inbound task will run on only one ESB instant at a time ● Capable of handling major major file systems like local file system, ftp, sftp, smb etc. File Inbound Endpoint
- 48. Important parameters used in File Inbound Endpoint File Inbound Endpoint Parameter Description transport.vfs. FileURI Specifies file source. Should use file system prefix in front of the location uri. Eg: file://<path> Interval How frequently file inbound should poll the source file location Eg: 1000 (ms) sequential Set this to true if you want to process list of files one after another coordination Set this to true if you want file polling in one instance at a time in a clustered environment transport.vfs. ContentType Content type of the files processed by the file inbound. To specify the encoding when reading a file, follow the content type with a semi-colon and the character set. Eg: text/plain;charset=UTF-32 transport.vfs. ActionAfterProcess transport.vfs. ActionAfterFailure transport.vfs. MoveAfterProcess transport.vfs. MoveAfterFailure These parameters can be used to specify the operation that should be done after processing a file or incase of processing failure transport.vfs.DistributedLock This applies only in cluster deployments. Set to true if you need to avoid multiple servers trying to process the same file simultaneously.
- 49. Sample File Inbound Configuration File Inbound Endpoint
- 50. Demo
- 51. QnA
- 52. Contact us !