rpafi/jl open source Apache Axis2 Web Services 2nd Edition using Apache Axis2 Deepal Jayasinghe Create secure, reliable, and easy-to-use web services

Apache

Axis2

Web

Services

2nd Edition

Create

_secure,

reliable,

and

_easy-to-use

_{web services}

using Apache

Axis2

Deepal

Jayasinghe

Afkham Azeez

rpAfi/jl

open

source

I

I

I

I

_{community experience}distilled

v.?

w

PUBLISHING

Table

of

_Contents

Preface ₁

Chapter

1:

_Apache

Web Services and Axis2 7

Service Oriented Architecture _{(SOA) 8}

Web service overview ₁₀ How do _{organizations} move into webservices? 11 Web services model ₁₂

Web services standards 13

XML-RPC ₁₄

SOAP ₁₄

Web Services_Addressing

_{(WS-Addressing)}

₁₅ Service _{description 15} Web Services

_Description

_{Language (WSDL)} 16

Web services

_lifecycle

₁₆

Apache

Web Service stack ₁₈

WhyAxis2?

19

Downloading and

_{installing Apache}

Axis2 21 Binarydistribution 22 WAR distribution ₂₃ Source distribution ₂₅ Document distribution ₂₅ JARdistribution ₂₅ Summary 26

Chapter

2:

_Looking

inside Axis2 27

Axis2 architecture 27

Core modules ₂₈

XML _processing model 30

SOAP

_processing

model 30

Table_ofContents

Deployment

model 33 ClientAPI 34 Transports 36 Other modules 36 Code

_generation

37 Data

_binding

37

Extensible nature of Axis2 38

Service extension orthe module 38 Custom

_deployers

39

Message

receivers 39

Summary

39

Chapter

3: Axis 2 XML Model

_(AXIOM)

41

Overview of AXIOM and its features 41

What is pull parsing? 42

Architecture 43

Working

with AXIOM 43

Creating

Axiom 44

CreatingAxiom from an

input

stream 44

CreatingAxiom_using astring 45

CreatingAxiom_{programmatically} 46

Adding

child nodes and attributes 47

Working

with OM namespaces 48

Working

with attribute 48

TraversingtheAxiomtree 48

Serialization 49

Advanced _operations with Axiom 51

Xpath navigation 51

Accessingthepullparser 52

Axiom and SOAP 52

Summary

54

Chapter

4: Execution Chain 55

Handler 56

Writing a _simple handler 57

Phase 58

Types

of

_phases

60

Global_phases 60

Operation phases 62

Phase rules 62

Characterizing a _phase rule 62

Phasename 63

phaseFirst 63

before ₆₃

after ₆₄

after and before ₆₄

Invalid_phase rules 64

Flow ₆₅

Module _engagementand

_dynamic

execution chain 66

Special

handlers in the chain ₆₇

Transportreceiver 67

Dispatchers 67

Messagereceiver ₆₈

Transportsender 69

Summary

69

Chapter

5:

Deployment

Model

_7±

What is new in Axis2 _{deployment? 72}

Hot

_deployment

andhot _{update 74}

Hot

_deployment

74

Hot

_update

75

Repository

75

Change in the way ofdeploying handlers

_(modules)

76 Deployment

descriptors

77

Global

_descriptor

or axis2.xml 78

Service

_{descriptor (services.xml)}

78

Module

_descriptor

ormodule.xml 79

Available

_deployment

_{options 79}

Archive-based

_deployment

₈₀

Directory-based deployment

80

Deploying

a service

programmatically

80

POJO

_deployment

81

Deploying

and _running a service in one line 83

Summary 84

Chapter

6: Information Model 85

Axis2staticdata ₈₆

AxisConfiguration

88

Parameters 89

MessageReceiver 90 MessageFormatters and _{MessageBuilders} 91 TransportReceiverand _{TransportSender} 91

Flows and

_phaseOrder

92

AxisModule 93

Service _description

_hierarchy

94

Table_ofContents AxisService 95 AxisOperation 95

AxisMessage

96 Axis2contexts 96 ConfigurationContext 97 ServiceGroupContext 98 ServiceContext 98

OperationContext

98

MessageContext

99 Summary 99

Chapter 7:

Writing

an Axis2 Service 101

Creating aweb service 102 The code first_approach 104

Single

class POJO _approach 104

POJOs with

_packages

106

Deploying services

_using

a service 108

Writingthe services.xml file 108

Serviceimplementationclass 109

Specifyingthe message receiver 109

Creating a service archive file 110

Different ways of _{specifying message receivers} 110

Service group and

single

service 113

Adding

third-party

resources 114

Service WSDL and schemas 114

Contract first_approach-starting from the WSDL 116

Generating code 116

Filling

in theservice skeleton 117

Running

the antbuild file 117

Summary 117

Chapter

8:

_Writing

anAxis2 Module 119

Brief _history of the Axis2 module 120

Module _concept 120

Module structure 121 Module_{configuration}file_(module.xml) 122 Handlers andphaserules 123 Module_{implementation}class 125

Writing

the module.xml file 128

Deployingand_engagingthe module 129

Advanced module.xml 132

WS-Policy 132

Endpoints 133

Summary

134

Chapter

9: The Client API ₁₃₅

Webservice client ₁₃₆

Blocking

and _non-blockinginvocation ₁₃₆

Looking

into Axis2 clientAPI ₁₃₇

ServiceClientAPI ₁₃₇ ServiceClient with working samples 140

Working

with the _{OperationClient 147}

Summary

150

Chapter

10: Session Management 151

Stateless natureof Axis2 ₁₅₂ Theavailable _type of sessions in Axis2 153

Session

_initializing

and session

_invalidating

₁₅₅

Java reflection ₁₅₅ Usingthe _optional interface ₁₅₆ Accessing

MessageContext

156 Requestsession scope 157

SOAP_{session scope 158}

Transport

session scope 162

Option

1: _Usingthe browser ₁₆₂

Option

2: _Usingthe service client 163

Application scope 163 Managing sessions

_using

ServiceClient 164

Summary

164

Chapter

11:

_Developing

JAX-WS Web Services 165

Writing

asimpleJAX-WS web service ₁₆₆

JAX-WS annotations ₁₆₆ JSR 181

_(Web

Service

_Metadata)

annotations ₁₆₇

javax.jws.WebService 167 javax.jws.WebMethod 169 javax.jws.OneWay 170 javax.jws.WebParam 171 name ₁₇₁ targetNamespace 172 mode ₁₇₂ header 172 partName 172 javax.jws.WebResult 172 javax.jws.soap.SOAPBinding 174

TableofContents

JSR 224

_(JAX-WS)

annotations 175

javax.xml.ws.BindingType 175

javax.xml.ws.RequestWrapperand_{javax.xml.ws.ResponseWrapper} 176

javax.xml.ws.ServiceMode 177 javax.xml.ws.WebEndpoint 177 javax.xml.ws.WebFault 178 javax.xml.ws.WebServiceClient 178 javax.xml.ws.WebServiceProvider 179 javax.xml.ws.WebServiceRef 180 JSR 222 _(JAXB) annotations 180 javax.xml.bind.annotation.XmlRootElement 181 namespace 181 name 181 javax.xml.bind.annotation.XmlAccessorType 182 javax.xml.bind.annotation.XmlElement 182 name 183 namespace 183 JSR 250_{(Common Annotations)} 183 javax.annotation.Resource 183 javax.annotation. PostConstruct 184

javax.annotation.PreDestroy

184

Code first service developmentwith JAX-WS 185

Contract first

_development

with JAX-WS 188

Client-sideJAX-WS 193

TheDispatchclient 194

The_DynamicProxy client 196

MTOM with JAX-WS Services 196

Asynchronous invocation ofJAX-WS services 198

Pollingmodel 198

Callback model 198

Summary 200

Chapter 12; Axis2

_Clustering

201

Setting up a

simple

Axis2 cluster 202

Writing

a

_highly

available clusterable

web service 203

Stateless Axis2 Web Services 204 Setting up afailover cluster 204 Increasing horizontal

_scalability

205 Setting up and

configuring

Axis2 clusters in _production 206

Clustering

agent 206

Clustering

agent parameters 206

Avoidlnitiation 207

membershipScheme 207

of synchronizeAII 208 maxRetries ₂₀₈ mcastAddress ₂₀₈ mcastPort ₂₀₈ mcastFrequency 208 memberDropTime 208 mcastBindAddress ₂₀₉ localMemberHost 209 localMemberPort ₂₀₉ preserveMessageOrder 209 atmostOnceMessageSemantics 209 properties 210 State _{management 210} Node _{management 211}

Group

management 211 Static members 212 Full

_{configuration}

₂₁₂

Membership

schemes ₂₁₄ Static _{membership 214} Dynamic

membership

216 Hybrid

membership

216 Cluster _{management 218}

Highly

available load

_balancing

₂₂₀

TheAxis2 _{clustering management}API 220

org.apache.axis2.clustering.ClusteringAgent

221

org.apache.axis2.clustering.state.StateManager

222

org.apache.axis2.clustering.management.NodeManager

223

org.apache.axis2.clustering.management.GroupManagementAgent

223

Summary

223

Chapter

13: Enterprise

Integration

Patterns 225

Apache Synapse 226

WS02 ESB ₂₂₇

OpenESB 230

Protocol _{bridging 230}

External authentication and authorization 231 Dynamic

routing

combined with _auditing 233 Event DrivenArchitecture _(EDA)withMaster Data

_Management

_(MDM) for

Integrating Legacy

Systems 234

Event DrivenArchitecture (EDA) 234

Master Data

_{Management (MDM)}

₂₃₅

Adaptor layer 236

Integration server ₂₃₆

Table_ofContents

Registry

237

Push and _{pull 237}

Fault tolerant

_autoscaling

with _dynamic load _balancing 239

References 240

Summary

240

Chapter

14: Axis2Advanced Features and

_Usage

243

RepresentationalState Transfer

_(REST)

244 Features ofREST 244

REST services in Axis2 ₂₄₄

RESTweb service with GET and POST 245

Message

Transmission _Optimization Mechanism

_(MTOM)

247

By

value 247

By reference ₂₄₇

MTOM on the client side ₂₄₉

MTOM on the service side ₂₅₀

Axis2

_configurator

251

Deploying

Axis2 in various _application servers 252

Asynchronous

webservices with Axis2 254

Client side

_asynchronous

₂₅₄ Application-level asynchronous support 257

Transports-level

asynchronous

support

258

Summary

259

Chapter

15: _Building a Secure Reliable Web Service 261

Reliableweb services 262

Sampleservice ₂₆₃

One wayinvocation ₂₆₄

Request-replyinvocation 266

Managing

sequences 268

Creatinga_{sequence withoutsending}a _message 269

Terminatea_{sequence 269}

Secure webservices ₂₆₉

Sampleservice ₂₇₀

Writingthe_passwordcallback ₂₇₀

Creating

the _policyelement ₂₇₁

Generatingclient stubs ₂₇₃

Invokingtheservicewithout_{security 273}

Invokingthe service with_{security 273}

Summary

274