CXF User's Guide

Welcome to the CXF user's guide. We're glad that you've chosen to use or evaluate CXF for your project!

In addition to the user's guide be sure to check out the many samples in our CXF distribution--these will ensure that you're up and running with CXF very quickly.

With that said, there are bound to be gaps in our documentation and software. We would love to hear your feedback about what needs more work. The easiest way to send feedback is to signup for the mailing list. If you've found a bug, you can file an issue report via JIRA. If you would like to get involved in the community yourself, we would welcome your contributions and involvement.

Thanks and happy coding!

- The CXF Team

• Overview
  • Why CXF?
  • How do I integrate my application with CXF — A meta guide to integrating your application with CXF - including Bindings, Transports, Interceptors, etc
  • How do I develop a service? — A meta guide to your options with CXF
  • How do I develop a client? — A meta guide to your options with CXF
• How-Tos
  • Writing a service with Spring
  • A simple JAX-WS service
  • Running a service in Tomcat on zOS
  • Defining Contract first webservices with wsdl generation from java
  • Migration Guides
  • Sample Projects
• Frontends
  • Annotations
  • Dynamic Clients
  • JAX-WS
    • Developing a Consumer
    • Developing a Service
    • JAX-WS Configuration
    • JAX-WS Dispatch API
    • Provider Services
    • WebserviceContext
  • Simple
    • Simple Frontend
    • Simple Frontend Configuration
• DataBindings
  • Aegis (2.1) — For CXF 2.1 or newer
  • Aegis Databinding (2.0.x) — For CXF up to 2.0.x
  • JAXB
  • MTOM Attachments with JAXB
  • SDO
  • XMLBeans
• Transports
  • HTTP Transport
    • Asynchronous Client HTTP Transport
    • Client HTTP Transport (including SSL support)
    • HTTP/2 support
    • Jetty Configuration
    • Netty Configuration
    • Server HTTP Transport
    • Servlet Transport
    • Standalone HTTP Transport
    • Undertow Configuration
  • JMS Transport
    • CXF 2.x JMS configuration (removed in CXF 3)
    • JMS performance and pooling
    • JMS transactions
    • SOAP over JMS 1.0 support
    • Using the JMSConfigFeature
  • Local Transport
  • UDP Transport
    • SOAP over UDP
  • Custom Transport
  • Coloc Feature
  • Apache Camel Transport
  • WebSocket
  • SSE
• Configuration
  • Bus Configuration
  • FeaturesList
  • JMX Management
  • WSAConfiguration
  • WSPConfiguration
  • WSRMConfiguration
• Debugging and Logging
• Tools
  • CXF tools in Eclipse
  • IDL to WSDL
  • Java to Javascript
  • Java to WS
  • Java to WSDL
  • Maven cxf-codegen-plugin (WSDL to Java)
  • Maven Java2WSDL plugin (CXF 2.0.x only. Removed in 2.1 and replaced with Java2WS)
  • Maven Java2WS plugin
  • Using CXF with maven
  • WSDL to CORBA
  • WSDL to Java
  • WSDL to Javascript
  • WSDL to Service
  • WSDL to SOAP
  • WSDL to XML
  • WSDLValidator
  • XSD to WSDL
• RESTful Services
  • HTTP Binding
  • JAX-RS
  • JAX-RS (JSR-311)
  • REST with JAX-WS Provider and Dispatch
  • JSON Support
• WSDL Bindings
  • MTOM
  • Pure XML
  • SOAP 1.1
  • SOAP 1.2
• Service Routing
• Dynamic Languages
  • JavaScript
  • JavaScript Clients
• WS-* Support
  • WS-Addressing
  • WS-Discovery
  • WS-MetadataExchange
  • WS-Policy
  • WS-ReliableMessaging
  • WS-SecureConversation
  • WS-Security
  • WS-SecurityPolicy
  • WS-Trust
• Securing CXF Services
  • JAXRS Kerberos
  • SAML Web SSO
  • Security Configuration
• Advanced Integration
  • Features
  • Interceptors
  • Invokers
  • Multiplexed EndpointReferences
  • Server, Service, and Client FactoryBeans
• Deployment
  • Application Server Specific Configuration Guide
  • Bundling CXF into single jar with Maven shade plugin
  • Embedding CXF inside Spring
  • Using CXF and CDI 1.1/1.2 (JSR-346) in OSGi environment
  • Using CXF and CDI 1.1 (JSR-346)
  • Using CXF and Failover in OSGi environment
  • Using CXF-JCA RAR in Application Server
• Distributed Tracing
  • Using Apache HTrace
  • Using Micrometer Observation
  • Using OpenTelemetry
  • Using OpenTracing
  • Using OpenZipkin Brave
• Metrics
  • Dropwizard Metrics
  • Micrometer
• Use of Schemas and Namespaces
• JPMS (Java 9 and beyond)
• GraalVM Support
• JakartaEE TCKs
• Javadoc

Other Sources of Documentation and Information

There are several companies that provide extra documentation, examples, tutorials, etc... that users may find useful. See the Commercial CXF Offerings page for more details.

Also, many users have created excellent blog posts and other articles that may provide extra information. See the Resources and Articles page for a listing.

Developer Guide

• CXF Architecture
• Configuration for Developers
• CXF Dependency Graphs
• Documentation TODOs