Using SOAP and Web Services with Ensemble - InterSystems ...

More documents

Recommendations

Info

Creating an Ensemble Web Client}}• It generates the request and response message classes needed by the business operation. Therequest class is as follows:Class MyClient.BusOp.AddRequest Extends Ens.Request [ ClassType = persistent ]{Parameter RESPONSECLASSNAME = "MyClient.BusOp.AddResponse";Property a As MyClient.ComplexNumber;Property b As MyClient.ComplexNumber;}The response class is as follows:Class MyClient.BusOp.AddResponse Extends Ens.Response [ ClassType = persistent ]{Property AddResult As MyClient.ComplexNumber;}• Finally, it generates the MyClient.ComplexNumber class, which defines a complex numberand which is used by the other classes./// Created from: http://localhost:57772/csp/gsop/MyApp.AddService.CLS?WSDL=1Class MyClient.ComplexNumber Extends (%RegisteredObject, %XML.Adaptor){Parameter XMLNAME = "ComplexNumber";Parameter XMLSEQUENCE = 1;Property Real As %xsd.double(XMLNAME = "Real") [ SqlFieldName = _Real ];Property Imaginary As %xsd.double(XMLNAME = "Imaginary");}When you compile these classes, the compiler also generates a class for each method defined in theWeb service. These classes are not automatically added to your project and their internal details aresubject to change. These classes extend %SOAP.ProxyDescriptor, which you should never subclassyourself.36 Using SOAP and Web Services with Ensemble
Creating a Business Operation Class Manually3.6 Creating a Business Operation ClassManuallyRather than using the business operation class that the SOAP client wizard generates, you can createyour own class. This section describes how to do so. It discusses the following:• Basic requirements of the business operation class• Basic requirements of the methods in the business operation class• Specific techniques, with examples, for calling the proxy methods• Reference information for the adapter property and methods used hereImportant:InterSystems recommends that you do not place custom code or data in the systemprovidednamespaces ENSLIB or ENSDEMO where it will be deleted the next timeyou upgrade Ensemble. The ENSEMBLE namespace and any new namespace thatyou create to hold your work is preserved across Ensemble upgrades.3.6.1 Basic Requirements of the ClassThe following list describes the basic requirements of the business operation class• Your business operation class should extend Ens.BusinessOperation.• In your class, the ADAPTER parameter should equal EnsLib.SOAP.OutboundAdapter.• In your class, the INVOCATION parameter should specify the invocation style you want to use,which must be one of the following.- Queue means the message is created within one background job and placed on a queue, atwhich time the original job is released. Later, when the message is processed, a differentbackground job will be allocated for the task. This is the most common setting.- InProc means the message will be formulated, sent, and delivered in the same job in whichit was created. The job will not be released to the sender’s pool until the message is deliveredto the target. This is only suitable for special cases.• Your class should define one method for each method of the proxy client, as described in the followingsection.• Your class should define a message map that includes one entry for each method. A message mapis an XData block entry that has the following structure:Using SOAP and Web Services with Ensemble 37
Page 1 and 2: Using SOAP and WebServices with Ens
Page 3 and 4: Table of ContentsAbout This Book ..
Page 5: List of TablesBasic Web Service Par
Page 9 and 10: 1About SOAP and Web ServicesEnsembl
Page 11 and 12: 1.2 Ensemble Support for Web Client
Page 13 and 14: Ensemble Support for Web ClientsAs
Page 15 and 16: 2Creating an Ensemble Web ServiceTh
Page 17 and 18: Basic RequirementsCommunication wit
Page 19 and 20: • The class can optionally implem
Page 21 and 22: Method OnProcessInput(pInput As %Re
Page 23 and 24: Implementing the OnProcessInput Met
Page 25 and 26: 2.4.3 Using the SendRequestAsync Me
Page 27 and 28: Example2.6 ExampleThe following sim
Page 29 and 30: Creating a Switch in OnProcessInput
Page 31: • Changing the encoding style of
Page 34 and 35: Creating an Ensemble Web Client•
Page 36 and 37: Creating an Ensemble Web Client3.3
Page 38 and 39: Creating an Ensemble Web Client3.4
Page 40 and 41: Creating an Ensemble Web ClientFor
Page 44 and 45: Creating an Ensemble Web ClientXDat
Page 46 and 47: Creating an Ensemble Web Client•
Page 49 and 50: ACommon Tasks in the EnsembleManage
Page 51: For detailed descriptions, see the
Page 54 and 55: Customizing Startup and TeardownOnP
Page 57 and 58: CUsing the SOAP Inbound AdapterThe
Page 59 and 60: C.4 Settings of the Inbound Adapter
Page 62 and 63: EnsLib.SOAP.OutboundAdapterusing, 3
Page 64: WebServiceClientClass setting, 32We

Using SOAP and Web Services with Ensemble - InterSystems ...

Create successful ePaper yourself

Delete template?

Save as template?