ISSUE-101: <interface.java/> element not fully described in Java CAAspecification

[David Booz <booz@us.ibm.com>]

http://www.osoa.org/jira/browse/JAVA-101

Dave Booz
STSM, BPM and SCA Architecture
Co-Chair OASIS SCA-Policy TC and SCA-J TC
"Distributed objects first, then world hunger"
Poughkeepsie, NY (845)-435-6093 or 8-295-6093
e-mail:booz@us.ibm.com

Mike Edwards ---11/21/2008 05:58:25 AM---Raiser: Mike Edwards Target: Java CAA specification - sca-javacaa-1.1-spec-cd01.doc

From:	Mike Edwards <mike_edwards@uk.ibm.com>
To:	"OASIS Java" <sca-j@lists.oasis-open.org>
Date:	11/21/2008 05:58 AM
Subject:	[sca-j] [NEW ISSUE] <interface.java/> element not fully described in Java CAA specification

---

Raiser:                Mike Edwards 

Target:                Java CAA specification - sca-javacaa-1.1-spec-cd01.doc 

Description: 

Section 3.1 of the Java CAA specification is supposed to contain the normative description of the 
<interface.java/> element of SCA.  However, the description is incomplete - for example, it is 
missing a description of the @callbackInterface attribute. 

This needs fixing. 

Proposal: 

Replace the whole of section 3.1 with the following text: 

--------------------------------------- 
3.1 Java Interface element - <interface.java/> 

The Java interface element is used in SCDL files in places where an interface is declared in terms of 
a Java interface class.  The Java interface element identifies the Java interface class and optionally 
identifies a callback interface, where the first Java interface represents the forward (service) call 
interface and the second interface represents the interface used to call back from the service to the 
client. 

The following is the pseudo-schema for the interface.java element:

<interface.java interface="NCName" callbackInterface="NCName"?/>

The interface.java element has the following attributes:

• interface (1..1) - MUST be the fully qualified name of the Java interface class [JCA30001]
• callbackInterface (0..1) - MUST be the fully qualified name of a Java interface used for callbacks [JCA30002]

The following shows an example of the Java interface element:.

<interface.java interface="services.stockquote.StockQuoteService"

callbackInterface="services.stockquote.StockQuoteServiceCallback"/>

Here, the Java interface is defined in the Java class file ./services/stockquote/StockQuoteService.class, where
the root directory is defined by the contribution in which the interface exists. Similarly, the callback interface
is defined in the Java class file ./services/stockquote/StockQuoteServiceCallback.class.

Note that the Java interface class identified by the @interface attribute can contain a Java @Callback annotation
which identifies a callback interface. If this is the case, then it is not necessary to provide the @callbackInterface
attribute. However, if the Java interface class identified by the @interface attribute does contain a Java @Callback
annotation, then the Java interface class identified by the @callbackInterface attribute MUST be the same interface
class. [JCA30003]

For the Java interface type system, arguments and return values of the service methods are described using
Java classes or simple Java types. It is recommended that the Java Classes used conform to the requirements of either
JAXB [JAXB] or of Service Data Objects [SDO] because of their integration with XML technologies.
------------------------------------------



Yours, Mike.

Strategist - Emerging Technologies, SCA & SDO.
Co Chair OASIS SCA Assembly TC.
IBM Hursley Park, Mail Point 146, Winchester, SO21 2JN, Great Britain.
Phone & FAX: +44-1962-818014 Mobile: +44-7802-467431
Email: mike_edwards@uk.ibm.com

---

Unless stated otherwise above:
IBM United Kingdom Limited - Registered in England and Wales with number 741598.
Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6 3AU