Using TCP Adapters with Ensemble - InterSystems Documentation

More documents

Recommendations

Info

Using the TCP Text Line Inbound AdapterImportant:Be sure to avoid reserved package names; see “Reserved Package Names” in DevelopingEnsemble Productions.• Choose EnsLib.TCP.TextLineInboundAdapter from the drop-down list of adapter classes.• Click Finish.The result is a template class like the following:Class Dev.Test.NewService1Extends Ens.BusinessService [ ProcedureBlock ]{Parameter ADAPTER = "EnsLib.TCP.TextLineInboundAdapter";Method OnProcessInput(pInput As %RegisteredObject,pOutput As %RegisteredObject) As %Status{Quit $$$ERROR($$$NotImplemented)}}2. Implement the OnProcessInput() method in your new business service class. This is the method that uses the inputdata gathered by the EnsLib.TCP.TextLineInboundAdapter.You can implement the OnProcessInput() method by replacing the following line in the template class with your owncode:Quit $$$ERROR($$$NotImplemented)Your OnProcessInput() method must know the types of incoming and outgoing data for communicating with theEnsLib.TCP.TextLineInboundAdapter. However, the New Business Service Wizard specifies both types in theOnProcessInput() method signature as the generic object type %RegisteredObject.InterSystems suggests that, as your first action in coding the new business service, you change each OnProcessInput()argument to its specific type passed from the adapter:Method OnProcessInput(pInput As Ens.StringContainer,Output pOutput As Ens.StringContainer) As %StatusWhere:• pInput is of type Ens.StringContainer and contains the incoming line of text.• pOutput is of type Ens.StringContainer and contains the outgoing response string (if any).Keep in mind that the method must quit by returning a %Status object. See the code sample in “Sample BusinessService Class Code.”3. Optionally, you may implement the OnConnect() callback method in your business service class.OnConnect() is available for a TCP inbound adapter to call back to its associated business service. If present in thebusiness service, this method is called each time the TCP inbound adapter establishes a new connection to or from aremote system.If you add an OnConnect() method to your business service class, it must have the following signature:Method OnConnect(pTimeout As %Numeric) As %StatusImplement an OnConnect() method in your business service if you need to take some action each time a new connectionis established, for example to send a logon sequence or a handshake token. The timeout argument is automaticallyprovided by the TCP inbound adapter. It takes its value from the ReadTimeout adapter setting. For details, see “AdapterSettings.”38 Using TCP Adapters with Ensemble
Sample Business Service Class CodeReturning an error status from OnConnect() causes the new connection to fail and be disconnected. If an untrappedexception occurs within OnConnect(), the adapter catches it and continues as if OnConnect() were not implemented.4. Compile your new business service class. Compiling also saves it.5. After creating and compiling the business service class in Studio, add an instance of the business service to the productionand configure it using the Management Portal. See the appendix “Common Tasks in the Management Portal.”When you configure the adapter, you specify a value for the AllowedIPAddresses settings, along other settings. Notethat AllowedIPAddresses provides a way to enable the adapter to initiate the connection; see “Adapter Settings.”6.4 Sample Business Service Class CodeThe following is an example of a business service class that references the EnsLib.TCP.TextLineInboundAdapter.Class TestTCPTextLine.AuthorizationTCPServiceExtends Ens.BusinessService [ ProcedureBlock ]{/// Name of the adapter classParameter ADAPTER = "EnsLib.TCP.TextLineInboundAdapter";Method OnProcessInput(pInput As Ens.StringContainer,pOutput As Ens.StringContainer) As %Status{set $ZT = "EXCEPTION"set st = $$$OKdo {if ('$isobject($get(pInput))) { quit }// Input must have the following format: 'PatientCode:ProcedureCode'set tSubject = pInput.StringValue$$$TRACE("received line "_tSubject)set req = ##class(TestTCPTextLine.AuthorizationRequest).%New()set req.PatientCode = $piece(tSubject,":",1)set req.ProcedureCode = $piece(tSubject,":",2)set st = ..SendRequestSync("AuthorizationProcess", req, .resp)quit:$$$ISERR(st)set pOutput=##class(Ens.StringContainer).%New(resp.AuthorizationFlag_":"_resp.AuthorizationCode)} while (0)EXIT//do ..Adapter.Disconnect()quit stEXCEPTIONset $ZT = ""set st = $$$EnsSystemErrorgoto EXIT}}6.5 Adapter SettingsThis topic describes the settings that are specific to the EnsLib.TCP.TextLineInboundAdapter associated with the businessservice. For settings not listed here, see “Business Service Settings” in the chapter “Configuration” in ManagingEnsemble Productions.Using TCP Adapters with Ensemble 39
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 and 12: 2Using the TCP Counted Inbound Adap
Page 13 and 14: Using the AdapterAn Ensemble produc
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

Using TCP Adapters with Ensemble - InterSystems Documentation

Create successful ePaper yourself

Delete template?

Save as template?