...
This document provides an architectural overview of the Apache CXF services framework.
Table of Contents
Table of Contents | ||||
---|---|---|---|---|
|
Architectural Goals and Constraints
...
This extensibility is made possible by dependency injection; the default bus implemenation implementation is based on Spring Framework, which wires the runtime components together for you.
...
META-INF/cxf/cxf.xml
(e.g., incxf-rt-core
only)META-INF/cxf/cxf-extension.xml
(e.g. incxf-rt-bindings-soap
)META-INF/cxf/cxf-property-editors.xml
(e.g. incxf-rt-transports-http
)
...
How service calls are processed
Gliffy Diagram | |||
---|---|---|---|
|
...
|
Client Side
Gliffy Diagram | |||
---|---|---|---|
|
...
|
Server Side
Front-ends
Front-ends provide a programming model to interact with CXF. JAX-WS, JAX-RS, Simple and Javascript front-end APIs are provided by CXF . Each implementation is cleanly separated from the rest of CXF, just like the bindings and the core. Front-ends provide functionality through interceptors that are added to Services and Endpoints. See also Front-ends
...
An interesting feature of the PhaseInterceptorChain
is that it is reentrant. This can be powerful and slightly dangerous. This feature is only used in CXF during the sending of an outgoing message, The SoapOutInterceptor
is the best example:
Code Block | ||||
---|---|---|---|---|
| ||||
public void handleMessage(Message m) {
writeSoapEnvelopeStart();
writeSoapBodyStart();
// invoke next interceptor, which writes the contents of the SOAP Body
m.getInterceptorChain().doIntercept(m);
writeSoapBodyEnd();
writeSoapEnvelopeEnd();
}
|
...
Data bindings implement the mapping between XML elements and Java objects. Data bindings convert data to and from XML, produce XML schema, and provide support for wsdl2java code generation. Not all data bindings support all of this functionality. At very least, a data binding must provide the data conversion. See Data Binding Architecture for details. Currently supported data bindings include JAXB 2.x (default) , Aegis, Apache XMLBeans, Service Data Objects (SDO) and JiBX (under development)and Aegis.
Protocol Bindings
Bindings provide ways to map concrete formats and protocols on top of transports. A binding contains two main parts, a BindingFactory
and a Binding
. A BindingFactory
builds a Binding
from the service model's BindingInfo
. The binding contains interceptors specific to the binding and also implements the createMessage()
method, which creates a Message
implementation specific for that binding.
...
The Soap
binding also adds a special type of interceptor called the SoapInterceptor
. The SoapInterceptor
adds two methods to the Interceptor
class:
Code Block | ||||
---|---|---|---|---|
| ||||
Set<URI> getRoles();
Set<QName> getUnderstoodHeaders();
|
...
Destinations are the basis for receiving incoming messages. A destination is created from a DestinationFactory
:
Code Block | ||||
---|---|---|---|---|
| ||||
DestinationFactoryManager dfManager = bus.getExtension(DestinationFactoryManager.class);
// Find a DestinationFactory for the SOAP HTTP transport
DestinationFactory df = dfManager.getDestinationFactory("http://schemas.xmlsoap.org/wsdl/soap/http");
// TODO: outline building of EndpointInfo
EndpointInfo endpointInfo = ...;
Destination destination = df.getDestination(endpointInfo);
|
MessageObservers can then be registered with Destinations. These listen for incoming messages:
Code Block | ||||
---|---|---|---|---|
| ||||
MessageObserver myObserver = ...;
destination.setMessageObserver(myObserver);
|
...