SCA C++, C and COBOL Bryan Aupperle David Haney 13 Dec. 2007

Specification Status n C and C++ specification development proceeding in OASIS l Based on work started in Open SOA (OSOA) l Now proceeding in the SCA-C-C++ TC n COBOL specification remains under OSOA l SCA-C-C++ TC work will influence

SCA-C-C++ TC Work n Updated conformance statements n Definition of a conformance test suite n Formal definition of C/C++ Annotations n Updated C++ -> WSDL, WSDL -> C++ Mapping n Incorporation of SCA Policy

SCDL for C++ n interface.cpp l header – C++ header file describing the interface l class – (optional) Class defining the interface l callbackHeader – (optional) C++ header describing the callback interface l callbackClass – (optional) Class defining the callback interface l remotable – (optional) Indicates whether the service can be called from a remote system n implementation.cpp l library – Shared library defining the service factory l path – (optional) Path to search for the library l header – C++ header file describing the implementation l class – (optional) Class defining the implementation l scope – (optional) Specifies the lifetime and reuse options for an implementation instance

C++ APIs n ComponentContext l Primary interface for accessing SCA defined components. l Component Meta Information n getCurrent(), getURI(), getProperties(), getDataFactory() l Service Lookup n getService(), getServices() l Service References n getServiceReference(), getServiceReferences() n getSelfReference()

C++ APIs (cont) n ServiceReference l Interface for interacting with service instances l Conversational interface n getConversationID(), setConversationID() l Asynchronous interface n getCallbackID(), setCallbackID() n getCallback(), setCallback()

C++ WSDL Mapping n Defines a translation from a C++ class interface to a WSDL n Uses comment annotations to control the conversion n Defines mapping rules for: l primitive types l C++ Standard Library types l SDO l classes, structs, arrays, enums n Defines a mapping from a WSDL to a C++ class interface l Currently defers to the OMG WSDL to C++ Mapping l Alternative mappings are being reviewed.

C++ Example n Interface SCDL n Implementation SCDL <implementation.cpp library=“loan” header=“LoanServiceImpl.h”/>

C++ Example (cont) n LoanService Interface class LoanService { public: virtual bool approveLoan( unsigned long customerNumber, unsigned long loanAmount) = 0; };

C++ Example (cont) n LoanServiceImpl Interface class LoanServiceImpl : public LoanService { public: virtual bool approveLoan( unsigned long customerNumber, unsigned long loanAmount) { // … } };

C++ Example (cont) n SCA Application int main(void) { ComponentContextPtr context = ComponentContext::getCurrent(); LoanService* service = (LoanService*) context->getService(“LoanService”); bool result = service->approveLoan(12345, 100); return 0; }

SCDL for C n Interface defined by a set of functions n interface.c l header – header file describing the interface l callbackHeader – (optional) header file describing the callback interface l remotable – (optional) Indicates whether the service can be called from a remote system n implementation.c l module – binary executable for the component implementation l library – (optional) indicates whether the service is implemented as a library or a program l location – (optional) location of the module l scope – (optional) Specifies the lifetime and reuse options for an implementation instance

C APIs n Synchronous Programming l SCALocate(), SCALocateMultiple() – get handle(s) to services l SCAInvoke() – invokes an operation of a service l SCAProperty () – get the value of a property l SCAGetFaultMessage(), SCASetFaultMessage() – get or set a fault message for a service operation n Asynchronous Programming l SCAGetCallback() – get handle of callback instance l SCACallback() – invoke a callback operation l SCASetCallback() – set a callback function for a reference l SCASetCallbackID(), SCAGetCallbackID() – get or set the callback ID for a service instance n Conversation Services l SCAGetConversationID(), SCASetConversationID() – get or set a user provided conversation ID l SCAEndConversation() – end a conversation

C Example n Interface SCDL n Implementation SCDL

C Example (cont) n LoanService Interface char approveLoan( long customerNumber, long loanAmount); n LoanService Implementation char approveLoan( long customerNumber, long loanAmount) { … }

C Example (cont) n SCA Application void clientFunction() { … SCALocate(L”customerService”, &serviceToken, &compCode, &reason); SCAInvoke(serviceToken, L“getCreditRating”, sizeof(custNum), (void *)&custNum, sizeof(rating), (void *)&rating, &compCode, &reason); }

SCDL for COBOL n interface.cobol l copybook – copybook file describing the interface l callbackCopybook – (optional) copybook file that describing the callback interface l location – (optional) location of library containing the copybook files l remotable – (optional) Indicates whether the service can be called from a remote system n implementation.cobol l program –binary executable for the component implementation l location – (optional) location of library containing the binary executable l scope – (optional) Specifies the lifetime and reuse options for an implementation instance

COBOL APIs n Same functions as in C l Synchronous Programming n SCAProperty is not typed l Program-Based Implementation Support l Asynchronous Programming l Conversation Services

Implementation as Program n Support environments where function is provided by programs n API l SCAService() – get name of invoked service l SCAOperation() – get name of invoked operation l SCAMessageIn() – get input message SCAMessageOut() – set output message

COBOL Example n LoanService Interface 01 LoanServiceInf. name="LoanApplication" * input="CustomerName" * output="LoanAmount" 03 LoanApplication. 05 CustomerName PIC X(255). 05 LoanAmount PIC 9(4).

COBOL Example (cont) n LoanService Implementation PROCEDURE DIVISION. IN-THE-BEGINNING. PERFORM GET-MY-CONTEXT. EVALUATE My-Operation WHEN ApproveLoanOperation * Get service request MOVE length of CustomerNumber of ApproveLoan To InputMessageLength CALL "SCAMessageIn" using by content SCA-COMPCODE, SCA-REASON, My-Service, My-Operation, InputMessageLength, CustomerNumber of ApproveLoan PERFORM CUSTOMER-SERVICE * Return service response CALL "SCAMessageOut" using by content SCA-COMPCODE, SCA-REASON, My-Service, My-Operation, OutputMessageLength, LoanAmount of ApproveLoan WHEN OTHER CONTINUE END-EVALUATE. * Return to SCA runtime GOBACK. GET-MY-CONTEXT. CALL "SCAService" using by content SCA-COMPCODE, SCA-REASON, My-Service. CALL "SCAOperation" using by content SCA-COMPCODE, SCA-REASON, My-Operation.

COBOL Example (cont) n SCA Application PROCEDURE DIVISION.. CALL "SCALocate" using by content SCA-COMPCODE, SCA-REASON, CustomerServiceReference, CustomerServiceToken. CALL "SCAInvoke" using by content SCA-COMPCODE, SCA-REASON, My-CustomerServiceToken, CreditRatingOperation, InputMessagelength, CustomerNumber, OutputMessageLength, Rating.

C & COBOL WSDL Mapping n Defines a translation between language structures and WSDL n Defines type mapping rules for: l Primitive types l Structs or Groups l Variable length strings and unbounded arrays n Defines mapping rules between operations and functions

Annotations n Contained in comments, processed by tools n Interface l Invocation attribute n OneWay n Remotable n Callback l EndConversation n Implementation l Scope l Lifecycle l Conversation information l Property l Reference

Open Implementations n Apache Tuscany Native l -native.html -native.html l Implements pre-1.0 C++ specification l Working towards 1.0 compliance

OASIS References n Open CSA Member Section l open.org/committees/tc_home.php?wg_abbre v=opencsa-ms open.org/committees/tc_home.php?wg_abbre v=opencsa-ms n SCA-C-C++ Technical Committee l open.org/committees/tc_home.php?wg_abbre v=sca-c-cpp open.org/committees/tc_home.php?wg_abbre v=sca-c-cpp n SCA-C-C++ Charter l cpp/charter.php cpp/charter.php

OSOA References n OSOA SCA Specifications l ce+Component+Architecture+Specifica tions ce+Component+Architecture+Specifica tions l Specifications n SCA C++ Client and Implementation n SCA C Client and Implementation n SCA COBOL Client and Implementation

Thank You Merci Grazie Gracias Obrigado Danke Japanese English French Russian GermanItalian Spanish Brazilian Portuguese Arabic Traditional Chinese Simplified Chinese Thai

Backup

C++ APIs (cont) n Supplemental APIs l RefCountingPointer n Defines a reference-counted pointer interface l SCAException n Provides a hierarchy of exception classes for use with the SCA API. SCANullPointerException ServiceRuntimeException ServiceUnavailableException NoRegisteredCallbackException ConversationEndedException MultipleServicesException

C++ Annotations n Contained in comments, processed by tools n Interface Header @OneWay n Implementation Header File

C Annotations n Contained in comments, processed by tools n Header File @Conversational n Implementation File

COBOL Annotations n Contained in comments, processed by tools n Interface File @Conversational n Implementation File