Using TCP Adapters with Ensemble - InterSystems Documentation

More documents

Recommendations

Info

Using the TCP Counted Inbound AdapterFigure 2–1: Using the TCP Counted Inbound Adapter and Business ServiceThe figure above shows the flow of a request from an external data source into Ensemble after you have set up an Ensemblebusiness service to work with an inbound adapter. This figure shows the ingoing data stream only; any response simplyretraces this path. The sequence is as follows:1. At production startup, Ensemble creates a background process for each of the business services in the productionconfiguration. Ensemble can allocate more than one background process per business service. The business service’sconfigured PoolSize specifies the number of background processes.2. Within each background process, Ensemble creates an instance of the business service class and an instance of itsassociated inbound adapter class.3. Ensemble calls the OnInit() methods of the business service object and inbound adapter object, respectively.4. Thereafter, whenever the production is running and the business service is enabled and scheduled to be active, thefollowing cycle can occur:• Each time the adapter encounters input from its configured data source, it calls the Ensemble framework’sProcessInput() method.• The call to ProcessInput() automatically prompts the Ensemble framework to call the associated business service’sOnProcessInput() method.• Code within OnProcessInput() determines what to do with the incoming data stream. For example, if anEnsemble business process needs to be started, the business service formulates an Ensemble request message andissues the synchronous or asynchronous call that starts the business process.If the data source expects an acknowledgment or response of some kind, it is the business service’sOnProcessInput() that constructs it. The inbound adapter simply relays this response back to the external datasource.Note:There is no default implementation of OnProcessInput(). The developer of each business service classis responsible for writing an OnProcessInput() method for that class. For instructions, see the nextsection, “Using the Adapter.”6 Using TCP Adapters with Ensemble
Using the AdapterAn Ensemble production continues running until it is stopped, either programmatically or by an administrator using theManagement Portal. When a production stops, the following events related to inbound adapters occur:1. Ensemble disables each business service; no more incoming requests are accepted for this production.2. The OnTearDown() method in each inbound adapter is called.3. All inbound adapter and business service objects are destroyed and their background processes are killed.4. Each business service’s OnProductionStop class method is called, once for each configured item of that class in theproduction.When a business service is disabled by a system administrator, or becomes inactive according to its configured schedule,the production continues to run but the associated inbound adapter is shut down, and its OnTearDown() method is executed,as described above.2.2 Using the AdapterOnce you determine that your production needs the EnsLib.TCP.CountedInboundAdapter, you can include it in the productionconfiguration as follows:1. Choose or create a business service class that uses the EnsLib.TCP.CountedInboundAdapter.2. If you create a new business service class, be sure to:• Implement its OnProcessInput() method.• Compile the class.3. Configure the production. Add a business service of the chosen class.4. Configure the new business service. To do so, click it and specify values for the settings on the right.To enable it, select the Enabled box.The next sections provide details.2.3 Creating a New Business Service ClassThe simplest way to deploy the EnsLib.TCP.CountedInboundAdapter is to choose an existing business service class thatalready uses it.If no existing class has the functionality you need, create a business service class that uses theEnsLib.TCP.CountedInboundAdapter. Create the new class in Studio as follows:1. From the File menu, choose New. A dialog pops up. Edit it as follows:• Click on the Production tab.• Select the Business Service icon and click OK.• Enter a package and class name and click Next.Important:Be sure to avoid reserved package names; see “Reserved Package Names” in DevelopingEnsemble Productions.Using TCP Adapters with Ensemble 7
Page 2: Using TCP Adapters with EnsembleEns
Page 6 and 7: List of TablesTable 6-1: TCP Status
Page 9 and 10: 1Choosing a TCP AdapterThis chapter
Page 11: 2Using the TCP Counted Inbound Adap
Page 15 and 16: Sample Business Service Class Code4
Page 17: Adapter SettingsEndianA choice of B
Page 20 and 21: Using the TCP Counted Outbound Adap
Page 28 and 29: Using the TCP Counted XML Inbound A
Page 34 and 35: Using the TCP Counted XML Outbound
Page 42 and 43: Using the TCP Text Line Inbound Ada
Page 50 and 51: Using the TCP Text Line Outbound Ad
Page 58 and 59: Creating Custom TCP Adapter Classes
Page 60 and 61: Creating Custom TCP Adapter Classes
Page 62 and 63:
Settings for the Abstract TCP Adapt
Page 65 and 66:
BCommon Tasks in the Management Por
show all

Using TCP Adapters with Ensemble - InterSystems Documentation

Create successful ePaper yourself

Delete template?

Save as template?