CXF JAXRS (since 2.3.0) lets users do the advanced search queries based on the Feed Item Query Language(FIQL). FIQL lets users express complex search expressions using an intuitive and URI friendly language.

Note that either '_search' or '_s' query has to be used to pass the FIQL expression.

Dependencies and Configuration

+   <dependency>
+      <groupId>org.apache.cxf</groupId>
+      <artifactId>cxf-rt-rs-extension-search</artifactId>
+      <version>2.5.0</version>
+   </dependency>
+

Additionally, in CXF 2.6.0, SearchContextProvider needs to be registered as jaxrs:provider.

Consuming FIQL queries

To work with FIQL queries, a SearchContext needs be injected into an application code and used to retrieve a SearchCondition representing the current FIQL query. This SearchCondition can be used in a number of ways for finding the matching data.

Resource class

Note that Providers and ContextResolver are likely to be of interest to message body providers rather than to the actual application code. You can also inject all the context types into @Resource annotated fields.

Custom Contexts

Registering a custom ContextProvider implementation such as SearchContextProvider lets attach Context annotations to arbitrary classes which can be helpful when some of the information representing the current request needs to be optimized or specialized, example:

+package resources;
+import org.apache.cxf.jaxrs.ext.search.SearchContext;
+@Path("/")
+public class RootResource {
+    @Context
+    private  SearchContext sc;
+    // the rest of the code
+}
+

+<jaxrs:server>
+  <serviceBeans>
+    <bean class="resources.RootResource"/>
+  </serviceBeans>
+  <jaxrs:providers>
+    <bean class="org.apache.cxf.jaxrs.ext.search.SearchContextProvider"/>
+  </jaxrs:providers>
+</jaxrs:server>
+

Note registering SearchContextProvider is a temporarily requirement, it will be auto-discovered in future CXF versions.

URI calculation using UriInfo and UriBuilder

Mapping of a particular URI to a service that returns some resource is straightforward using the @Path annotation. However RESTful services are often connected: one service returns data that is used as the key in another service. Listing entities and accessing a particular entity is a typical example:

Introduction

CXF supports JAX-RS (JSR-311), the Java API for RESTful Web Services. JAX-RS standardizes the way RESTful services can be developed in Java.

CXF 2.5.x, 2.4.x and 2.3.x supports JSR-311 API 1.1 and is JAX-RS TCK 1.1 compliant.
+

CXF 2.6.x, 2.5.x, 2.4.x and 2.3.x supports JSR-311 API 1.1 and is JAX-RS TCK 1.1 compliant.
The JAX-RS 1.1 specification may be found here

CXF 2.2.x supports JSR-311 API 1.0 and is JAX-RS TCK 1.0. compliant.
@@ -151,16 +151,16 @@ The JAX-RS 1.0 specification may be foun

Migration

Existing JAX-RS 1.0 applications should run in CXF 2.4.x without any problems.
+

Existing JAX-RS 1.0 applications should run in CXF starting from 2.3.x without any problems.
There have been just a few minor modifications at the JAX-RS API level:

Maven dependencies

CXF 2.3.x - CXF 2.5.x

@@ -213,6 +213,46 @@ There have been just a few minor modific
 
 Please check the pom.xml for the list of cxf components used by the JAX-RS implementation. Snapshots are available from http://repository.apache.org/snapshots/org/apache/cxf/apache-cxf/.
 
+CXF 2.6.x
+
+Please check the CXF 2.6 Migration Guide for the information about all the changes affecting the JAX-RS users. Typically the frontend dependency should be enough:
+
+
++   <dependency>
+      <groupId>org.apache.cxf</groupId>
+      <artifactId>cxf-rt-frontend-jaxrs</artifactId>
+      <version>2.5.0</version>
+   </dependency>
+
+
+
+Optional providers (including the default JSONProvider) are located in this module:
+
+
++   <dependency>
+      <groupId>org.apache.cxf</groupId>
+      <artifactId>cxf-rt-rs-extension-providers</artifactId>
+      <version>2.5.0</version>
+   </dependency>
+
+
+
+The Search extension is now located in
+
+
++   <dependency>
+      <groupId>org.apache.cxf</groupId>
+      <artifactId>cxf-rt-rs-extension-search</artifactId>
+      <version>2.5.0</version>
+   </dependency>
+
+
+
+
+
 Setting up the classpath
 
 If Maven is not used then the following JARs will need to be available at the runtime classpath.

JMS Support

FIQL search queries

Introduction

Dependencies and Configuration

Consuming FIQL queries

Resource class

Custom Contexts

URI calculation using UriInfo and UriBuilder

Introduction

Migration

Maven dependencies

CXF 2.3.x - CXF 2.5.x

CXF 2.6.x

Setting up the classpath