Java™ Web Services Development Using Annotations: Brian Zotter

Java™ Web Services
Development Using
Annotations
Brian Zotter
Staff Engineer
BEA Systems
http://www.bea.com
TS-7964
2005 JavaOne SM Conference | Session TS-7964 1
Instant Web Services
Learn how to use Java™ technology-

based Web Services (“Java Web
Services”) Metadata to quickly develop
Enterprise Web Services.
2005 JavaOneSM Conference | Session TS-7964 | 2

Current Web Services Development
• Why is Java Web Service development

so difficult?
• Complicated APIs
• Manual creation of deployment descriptors
• Lack of tool support

Agenda
• JSR 181
• Development Models
• Processor
• Runtime
• Annotations
• Reference Implementation
• Next Steps
• Summary
• Q&A
Agenda
• JSR 181
• Processor
• Runtime
• Annotations
• Next Steps
• Summary
• Q&A
JSR 181
• Defines an annotated Java language syntax

for programming Web Service applications
• Allows the developer to concentrate on the
business logic of the service
• Defines a standard for building and deploying Web
Services without requiring knowledge
and implementation of generalized APIs and
deployment descriptors

Exposes this
Hello World class as a Web
Service
@WebService
public class HelloWorld { Exposes this
method as a Web
Service operation
@WebMethod
public String hello(){
return “Hello World!”;
}
}

Development Modes
• Start with Java technology

• Exposing a Java technology service
• Only required mode
• Start with WSDL
• Implementing a public contract
• Start with Java technology and WSDL
• Implementation must provide feedback if Java
technology source and WSDL are not in sync

JSR 181 Processor
• Produces a “runnable” Web Service

• Performs error checking
• Checks not caught by the compiler
• Processing may happen at any time
• At build time
• In a tool
• During deployment
• Left to the implementation

Processing Model
Java™ 2 Platform, Enterprise Edition (J2EE™)
Web Service generation
Java Web Service J2SE 1.5 .class file
(JWS) Compiler containing
Source File annotations
Syntax and
Type Checking
JSR-181 Processor
Semantic Checking
Deployment Artifact
Generation
J2EE .class files for

WSDL File Deployment service and related
Descriptors types
J2EE 1.4 Deployment Unit (.ear or .war)

JSR 181 Runtime
• Handles runtime behavior

• Exposes a “processed” Web Service at a URL
• Provides access to the service’s WSDL
• May be the same component as the processor

Agenda
• JSR 181
• Processor
• Runtime
• Annotations
• Next Steps
• Summary
• Q&A
Annotations
• JSR 175
• Purpose
• Java technology to WSDL Mapping
• Binding
• Processing(Handlers)
• Defines smart defaults
(Configuration by exception)

Annotations
• WebService
• OneWay
• WebParam
• WebResult
• SOAPBinding
• HandlerChain
• SoapMessageHandler(SoapMessageHandlers)

WebService
• Marks a Java class as implementing a Web Service,

or a Java technology interface as defining a
Web Service interface
• name
• Sets the name of the WSDL <portType> for this service
• serviceName
• Sets the name of the WSDL <service> generated for this service
• targetNamespace
• Sets the XML namespace used for WSDL and schema elements
defined from this service
• wsdlLocation
• The location of a pre-defined WSDL

WebMethod
• Specifies that the given method is exposed as a

Web Service operation
• operationName
• Name of the wsdl:operation matching this method
• action
• The action for this operation. For SOAP bindings, this
determines the value of the SOAPAction header

Example 1—Hello World
@WebService
public class HelloWorld {
@WebMethod
}
}

@WebService
@WebMethod (operationName=“hi”)
}
}
<wsdl:message name="hello">
name=“hi">
<wsdl:part name="parameters" element="tns:helloRequest"/>
element="tns:hiRequest"/>
</wsdl:message>
<wsdl:message name="helloResponse">
name=“hiResponse">
<wsdl:part name="return" element="tns:helloResponse"/>
element="tns:hiResponse"/>
</wsdl:message>
<wsdl:portType name="HelloWorld">
<wsdl:operation name="hello">
name=“hi">
<wsdl:input message="tns:hello"/>
message="tns:hi"/>
<wsdl:output message="tns:helloResponse"/>
message="tns:hiResponse"/>
</wsdl:operation>
</wsdl:portType>
@WebService (serviceName=“myService”)
@WebMethod
Default is class return “Hello World!”;
name + “Service” }
}
<wsdl:service name="myService">
name="HelloWorldService">
<wsdl:port name="HelloWorldServicePort“
binding="tns:HelloWorldBinding">
<soap:address location="…"/>
</wsdl:port>
</wsdl:service>

Oneway
• Indicates that the given @WebMethod has

only an input message and no output
• Typically returns the thread of control to the calling
application prior to executing the actual business
method
• The method must not have a return value or
Holder parameters, or declare any checked
exceptions

SOAPBinding
• Indicates that this Web Service’s methods are to be

mapped to the SOAP message protocol
• Default is DOCUMENT/LITERAL/WRAPPED
• style
• DOCUMENT or RPC
• use
• LITERAL or ENCODED
• parameterStyle
• W RAPPED or BARE

WebParam
• Controls the name and namespace of the return value
• name
• For RPC style this is the name of the wsdl:part
• For DOCUMENT style this is the local name of the element
• Default is the parameter name
• targetNamespace
• The XML namespace for the element
• Only used for DOCUMENT style
• Default is the target namespace of the Web Service
• mode
• IN, INOUT, or OUT
• OUT and INOUT parameters must be Holder Types
• OUT and INOUT parameters apply only to RPC style
or parameters that map to headers
• header
WebResult
• Provides fine-grained control over the name

and namespace of the return
• Binding determines behavior
• name
• For RPC style this is the name of the wsdl:part
• For DOCUMENT style this is the local name of the element
• Default is “return”
• targetNamespace
• The XML namespace for the element
• Only used for DOCUMENT style
• Default is the target namespace of the W eb Service

Example 2—RPC/ENCODED
@WebService
@SOAPBinding(
style=SOAPBinding.Style.RPC,
use=SOAPBinding.Use.ENCODED)
public class EchoService {
@WebMethod(action=“echo”)
@WebResult(name=“echoResult")
public String echo( @WebParam(name=“echoMsg") String msg){
return msg;
}
}

@WebService
@SOAPBinding(style=SOAPBinding.Style.RPC,use=SOAPBinding.Use.ENCODED)
@WebMethod(action=“echo”)
@WebResult(name=“echoResult")
public String echo( @WebParam(name=“echoMsg") String msg){
return msg;
}
}
<message name="echo">
<part name=“echoMsg" type="s0:string"/>
</message>
<message name="echoResponse">
<part name=“echoResult" type="s0:string"/>
</message>
<portType name="EchoService">
<operation name="echo" parameterOrder=“echoMsg">
<input message="s1:echo"/>
<output message="s1:echoResponse"/>
</operation>
</portType>
@WebService
@SOAPBinding(style=SOAPBinding.Style.RPC,use=SOAPBinding.Use.ENCODED)
…
}
<binding name="EchoServiceSoapBinding" type="s1:EchoService">

<s2:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
<operation name="echo">
<s2:operation soapAction=“echo" style="rpc"/>
<input>
<s2:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
namespace="http://examples/EchoService" use="encoded"/>
</input>
<output>
<s2:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
namespace="http://examples/EchoService" use="encoded"/>
</output>
</operation>
</binding>
Example 3—DOCUMENT/LITERAL/BARE
@WebService
@SOAPBinding(style=SOAPBinding.Style.DOCUMENT,
use=SOAPBinding.Use.LITERAL,
parameterStyle=SOAPBinding.ParameterStyle.BARE)
@WebMethod(action="echo")
@WebResult(targetNamespace=“http://exa.org”, name="echoResult")
public String echo(
@WebParam(targetNamespace=“http://exa.org”, name="echoMsg") String msg){
return msg;
}
}

@WebService
public String echo(
return msg;
}
}
<wsdl:message name="echo">
<wsdl:part name="parameters" element="ns0:echoMsg"/>
<wsdl:types>
</wsdl:message>
<xs:schema targetNamespace=“http://exa.org”
<wsdl:message name="echoResponse">
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<wsdl:part name="echoResult" element="ns0:echoResult"/>
<xs:element name="echoResult" type="xs:string"/>
</wsdl:message>
<xs:element name="EchoService">
<wsdl:portType name="echoMsg" type="xs:string"/>
</xs:schema>
<wsdl:operation name="echo">
<wsdl:input message="tns:echo"/>
</wsdl:types>
<wsdl:output message="tns:echoResponse"/>
</wsdl:operation>
</wsdl:portType> 2005 JavaOne SM
Conference | Session TS-7964 | 28
@WebService
public String echo(
return msg;
}
}
<wsdl:binding name="EchoServiceBinding" type="tns:EchoService">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation
<wsdl:types> name="echo">
<soap:operation soapAction="echo" style="document"/>
<xs:schema targetNamespace=“http://exa.org”
<wsdl:input name="echoInput">
<soap:body parts="parameters" use="literal" namespace="examples"/>
</wsdl:input>
<xs:element name="echoMsg" type="xs:string"/>
<wsdl:output name="echoOutput">
</xs:schema>
<soap:body parts="echoResult" use="literal" namespace="examples"/>
</wsdl:types>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
Example 4—Headers and Mode
@WebService
@SOAPBinding(style=SOAPBinding.Style.RPC,
use=SOAPBinding.Use.LITERAL)
public class EchoHeaderService {
@WebMethod
public String echo(
@WebParam(name="myHeader",
header=true,
mode=WebParam.Mode.INOUT) StringHolder header,
String msg){
String ret = header.value + + ", " + msg;
header.value = "got it";
return ret;
}
} 2005 JavaOneSM Conference | Session TS-7964 | 30
@WebMethod
public String echo(
header=true,
String msg){
String ret = header.value + ", " + msg;
return ret;
}
<wsdl:binding name="EchoHeaderServiceBinding" type="tns:EchoHeaderService">
<soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="echo">
<soap:operation soapAction="" style="rpc"/>
<wsdl:types>
<wsdl:input name="echoInput">
<xs:schema
<soap:bodytargetNamespace=“http://exa.org”
parts="msg" use="literal" namespace="examples"/>
<soap:header message="tns:echo" part="myHeader" use="literal"/>
</wsdl:input>
<xs:element
<wsdl:output name="echoMsg" type="xs:string"/>
name="echoOutput">
</xs:schema>
<soap:body parts="return" use="literal" namespace="examples"/>
</wsdl:types>
<soap:header message="tns:echo" part="myHeader" use="literal"/>
</wsdl:output>
</wsdl:operation>
2005 JavaOne Conference | Session TS-7964
SM
| 31
</wsdl:binding>
@WebMethod
public String echo(
header=true,
String msg){
String ret = header.value + ", " + msg;
return ret;
}
Request Response
<soap:Envelope xmlns:ns0="examples“ <soap:Envelope xmlns:soap="…">
xmlns:soap="…"> <soap:Header>
<soap:Header> <exam:myHeader xmlns:exam="examples">
<ns0:myHeader>Hello</ns0:myHeader> got it
</soap:Header> </exam:myHeader>
<soap:Body> </soap:Header>
<ns0:echo> <soap:Body>
<msg>How are you?</msg> <exam:echoResponse xmlns:exam="examples">
</ns0:echo> <return>Hello, How are you?</return>
</soap:Body> </exam:echoResponse>
</soap:Envelope> </soap:Body>
</soap:Envelope>
HandlerChain
• Associates the Web Service with an externally defined

handler chain
• XML—types are from the http://java.sun.com/xml/ns/j2ee
namespace defined by JSR 109
• file
• Location of the handler chain file
• name
• Name of the handler chain in the file

Example Handler Chain File
<handler-config xmlns:j2ee="http://java.sun.com/xml/ns/j2ee">
<handler-chain>
<handler-chain-name>MyHandlerChain</handler-chain-name>
<handler>
<j2ee:handler-name>myHandler</j2ee:handler-name>
<j2ee:handler-class>foo.MyHandler</j2ee:handler-class>
<j2ee:init-param>
<j2ee:param-name>offset</j2ee:param-name>
<j2ee:param-value>1</j2ee:param-value>
</j2ee:init-param>
</handler>
</handler-chain>
</handler-config>

SOAPMessageHandler
• Specifies a list of javax.xml.rpc.handler.Handlers to run
before and after the Web Service’s business method
invocation
• name
• Name of the handler
• className
• Fully Qualified name of the handler class
• InitParams
• Array of name/value pairs passed to the handler during initialization
• roles
• List of SOAP roles implemented by the handler
• headers
• List of SOAP headers processed by the handler

SOAPMessageHandlers Example
@WebService
@SOAPMessageHandlers({
@SOAPMessageHandler(
name = "myHandler",
className = "foo.myHandler",
initParams = {@InitParam(name="offset", value="1")})
})
public class MyWebService
{
}

SOAPMessageHandlers -> HandlerChain File
@WebService
@SOAPMessageHandlers({
@SOAPMessageHandler(
name = "myHandler",
className = "foo.myHandler",
initParams = {@InitParam(name="offset", value="1")})
})
public class MyWebService{…}
<handler-config xmlns:j2ee="http://java.sun.com/xml/ns/j2ee">
<handler-chain>
<handler-chain-name>MyHandlerChain</handler-chain-name>
<handler>
<j2ee:handler-name>myHandler</j2ee:handler-name>
<j2ee:handler-class>foo.MyHandler</j2ee:handler-class>
<j2ee:init-param>
<j2ee:param-name>offset</j2ee:param-name>
<j2ee:param-value>1</j2ee:param-value>
</j2ee:init-param>
</handler>
</handler-chain>
</handler-config>
Agenda
• JSR 181
• Processor
• Runtime
• Annotations
• Next Steps
• Summary
• Q&A
Reference Implementation
• Demonstrates how 181 annotations affect the Java

technology to WSDL mapping
• Start with Java technology development
mode only
• Command line build processor
• Rudimentary Runtime
• Supports http transport via a Servlet

Reference Implementation
compil
produces
JWSC deploy
e
Java Technology Source Java WSC WAR File Web Container

Java WSC—The RI compiler
• Command line tool

• Delegates to apt for annotation processing
• Javac for compiling
• Accepts javac and apt arguments
• Produces container agnostic war file

Java WSC Usage
Usage: jwsc <jwsc and javac options> <source files>
where jwsc options include:
-classpath <path> Specify where to find user class files
-cp <path> Specify where to find user class files
-d <path> Specify where to place processor and javac generated class files
-s <path> Specify where to place processor generated source files
-source <release> Provide source compatibility with specified release
-version Version information
-help Print a synopsis of standard options; use javac -help for more…
-X Print a synopsis of nonstandard options
-J<flag> Pass <flag> directly to the runtime system
-A[key[=value]] Options to pass to jwsc, [debug]
-nocompile Do not compile source files to class files
-print Print out textual representation of specified types
See javac -help for information on javac options.

Java WS—Testing
@WebService
@SOAPBinding(style=SOAPBinding.Style.RPC,
use=SOAPBinding.Use.LITERAL)
public class EchoHeaderService {
@WebMethod
public String echo(
header=true,
String msg){
String ret = header.value + + ", " + msg;
return ret;
}
}

Java WS—Testing

Agenda
• JSR 181
• Processor
• Runtime
• Annotations
• Next Steps
• Summary
• Q&A
Maintenance Release
• Align with Java APIs for XML Web Services

(JAX-WS) 2.0
• Clarify annotation inheritance scenarios
• Annotation for setting name for of element
wrappers for DOCUMENT/LITERAL/WRAPPED
• Allow SOAPBinding annotation per method

JSR 181 2.0
• WSDL 2.0
• SOAP 1.2
• Support of JSR 250 Common Annotations
• Improving the quality of service
• Buffering
• Transactional support
• Reliability
• Callbacks
• Conversations
• Policy
• Beyond J2EE platform security
Summary
• Rapid Web Service development

• Reduced maintainability (one source of truth)
• Accelerates SOA Implementation

For More Information
• JSR 181—Java Web Services Metadata
• http://www.jcp.org/en/jsr/detail?id=181
• Java Web Services Metadata Home—RI download
• http://dev2dev.bea.com/webservices/jwsm.csp
• Java Web Services Metadata in Beehive
• http://incubator.apache.org/beehive
Related Specs
• JSR 101 Java API for XML-based RPC (JAXRPC
• http://jcp.org/en/jsr/detail?id=101
• JSR 109 J2EE™ Platform Web Services
• JSR 175 Java Language Metadata
• JSR 224 JAX-WS 2.0
• http://www.jcp.org/en/jsr/detail?id=224
Submit Session Evaluations for Prizes!
Your opinions are important to Sun
• You can win a $75.00 gift certificate to the on-site Retail
Store by telling Sun what you think!
• Turn in completed forms to enter the daily drawing
• Each evaluation must be turned in the same day as
the session presentation
• Five winners will be chosen each day (Sun will send
the winners email)
• Drop-off locations: give to the room monitors or use any
of the three drop-off stations in the Northand South Halls
Note: Winners on Thursday, 6/30, will receive and can
redeem certificates via email.
Q&A

Q&A

Java™ Web Services
Development Using
Annotations
Brian Zotter
Staff Engineer
BEA Systems
http://www.bea.com
TS-7964
2005 JavaOne SM Conference | Session TS-7964 53

Java™ Web Services Development Using Annotations: Brian Zotter

Transféré par

Informations du document

Description originale:

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Java™ Web Services Development Using Annotations: Brian Zotter

Transféré par

Droits d'auteur :

Formats disponibles

Java™ Web Services

Learn how to use Java™ technology-

2005 JavaOneSM Conference | Session TS-7964 | 2

• Why is Java Web Service development

2005 JavaOneSM Conference | Session TS-7964 | 3

• Defines an annotated Java language syntax

2005 JavaOneSM Conference | Session TS-7964 | 6

2005 JavaOneSM Conference | Session TS-7964 | 7

• Start with Java technology

2005 JavaOneSM Conference | Session TS-7964 | 8

• Produces a “runnable” Web Service

2005 JavaOneSM Conference | Session TS-7964 | 9

J2EE .class files for

J2EE 1.4 Deployment Unit (.ear or .war)

2005 JavaOneSM Conference | Session TS-7964 | 10

• Handles runtime behavior

2005 JavaOneSM Conference | Session TS-7964 | 11

2005 JavaOneSM Conference | Session TS-7964 | 13

2005 JavaOneSM Conference | Session TS-7964 | 14

• Marks a Java class as implementing a Web Service,

2005 JavaOneSM Conference | Session TS-7964 | 15

• Specifies that the given method is exposed as a

2005 JavaOneSM Conference | Session TS-7964 | 16

2005 JavaOneSM Conference | Session TS-7964 | 17

2005 JavaOneSM Conference | Session TS-7964 | 19

• Indicates that the given @WebMethod has

2005 JavaOneSM Conference | Session TS-7964 | 20

• Indicates that this Web Service’s methods are to be

2005 JavaOneSM Conference | Session TS-7964 | 21

• Provides fine-grained control over the name

2005 JavaOneSM Conference | Session TS-7964 | 23

2005 JavaOneSM Conference | Session TS-7964 | 24

<binding name="EchoServiceSoapBinding" type="s1:EchoService">

2005 JavaOneSM Conference | Session TS-7964 | 27

• Associates the Web Service with an externally defined

2005 JavaOneSM Conference | Session TS-7964 | 33

2005 JavaOneSM Conference | Session TS-7964 | 34

2005 JavaOneSM Conference | Session TS-7964 | 35

2005 JavaOneSM Conference | Session TS-7964 | 36

• Demonstrates how 181 annotations affect the Java

2005 JavaOneSM Conference | Session TS-7964 | 39

Java Technology Source Java WSC WAR File Web Container

2005 JavaOneSM Conference | Session TS-7964 | 40

• Command line tool

2005 JavaOneSM Conference | Session TS-7964 | 41

2005 JavaOneSM Conference | Session TS-7964 | 42

2005 JavaOneSM Conference | Session TS-7964 | 43

2005 JavaOneSM Conference | Session TS-7964 | 44

• Align with Java APIs for XML Web Services

2005 JavaOneSM Conference | Session TS-7964 | 46

• Rapid Web Service development

2005 JavaOneSM Conference | Session TS-7964 | 48

2005 JavaOneSM Conference | Session TS-7964 | 51

2005 JavaOneSM Conference | Session TS-7964 | 52

Vous aimerez peut-être aussi