There's a number of ways to tell to the JAXB provider how objects can be serialized. The simplest way is to mark a given type with @XmlRootElement annotation.

For example:

@@ -428,7 +428,7 @@ public JsonObject getBook(@PathParam(&qu
 public Response addBook(@Context final UriInfo uriInfo, JsonObject obj) {
     // Implementation here
 }]]>
-

The JsrJsonpProvider provider could be used on server side or on a client side. By default, the provider uses JSR-353 Java API for JSON Processing reference implementation to read/write message bodies.

JSON With Padding (JSONP)

One option for supporting "JSON With Padding" (JSONP) is to extend the default JSONProvider and override its writeTo method as follows:

+

The JsrJsonpProvider provider could be used on server side or on a client side. By default, the provider uses JSR-353 Java API for JSON Processing reference implementation to read/write message bodies.

Simple JsonMapObject support

org.apache.cxf.jaxrs.provider.json.JsonMapObjectProvider is available starting from CXF 3.0.3 and CXF 3.1.0. This provider can read or write JSON into/from org.apache.cxf.jaxrs.provider.json.JsonMapObject which is a simple Map wrapper.

JsonMapObject can detect duplicate JSON sibling properties which can be useful in certain applications.

JSON With Padding (JSONP)

One option for supporting "JSON With Padding" (JSONP< /a>) is to extend the default JSONProvider and override its writeTo method as follows:

-

Second, only when using FIQL, a count extension can be used. For example, one may want to find 'all the books written by at least two authors or all the books with no reviews'.
If a collection entity such as BookReview has a non primitive type, then typing "reviews==0" is all what is needed, otherwise a count extension needs to be used, for example: "count(authors)=ge=2"

Lucene

Mapping of FIQL/OData expressions to Lucene (4.0.0-BETA) Query is supported starting from CXF 2.7.1.

org.apache.cxf.jaxrs.ext.search.lucene.LuceneQueryVisitor can be used to support the default (content) field or specific custom field queries.
Queries for specific terms and phrases are supported.

Example, "find the documents containing a 'text' term":

+

Second, only when using FIQL, a count extension can be used. For example, one may want to find 'all the books written by at least two authors or all the books with no reviews'.
If a collection entity such as BookReview has a non primitive type, then typing "reviews==0" is all what is needed, otherwise a count extension needs to be used, for example: "count(authors)=ge=2"

Lucene

Mapping of FIQL/OData expressions to Lucene (4.0.0-BETA) Query is supported starting from CXF 2.7.1. Please notice that starting from CXF 3.0.2, the Lucene version has been upgraded to 4.9.0 in order to benefit from query builders and other improvements.

org.apache.cxf.jaxrs.ext.search.lucene.LuceneQueryVisitor can be used to support the default (content) field or specific custom field queries.
Queries for specific terms and phrases are supported.

Example, "find the documents conta ining a 'text' term":

-

In this example, the visitor is requested to create Lucene org.apache.lucene.search.PhraseQuery against the specified contents field ("contents"). The visitor can also accept a contentsFieldMap map property when different phrases may need to be checked against different contents fields.

The current limitation is that no typed Date queries are supported yet (except for the equality match), for example, "find all the documents issued before a given date", to be supported shortly.

LDAP

Mapping of FIQL/OData expressions to LDAP queries as defined by RFC-4515 is supported starting from CXF 2.7.1 with the help of org.apache.cxf.jaxrs.ext.search.ldap.LdapQueryVisitor. Use this visitor when working with LDAP or OSGI.

Here is a summary of LDAP filter operators:

Operator

Description
"="	Equal
"!"	Not Equal
"<="	Less Or Equal
">="	Greater or Equal
"&"	AND
"\|"	OR

FIQL "=le=" and "=lt=" will both map to "<=", while "=ge=" and "=gt=" to ">=".

For example:

FIQL	LDAP
"name==bar*"	"(name=bar*)"
"name!=bar"	"(!name=bar)"
"name!=bar;id=gt=10"	"(&(!name=bar)(id>=10))"
"name!=bar;(id=gt=10,id=lt=5)"	"(&(!name =bar)(\|(id>=10)(id<=5)))"

The converter is created like all other converters:

+

In this example, the visitor is requested to create Lucene org.apache.lucene.search.PhraseQuery against the specified contents field ("contents"). The visitor can also accept a contentsFieldMap map property when different phrases may need to be checked against different contents fields.

Starting from CXF 3.0.2, the typed Date range queries are supported by LuceneQueryVisitor. However, this feature should be used together with 'primitiveFieldTypeMap' in order to hint the visitor which fields are temporal and should be treated as such in the filter expressions. For example:

+
+

LuceneQueryVisitor supports wide range of date formats, still providing the option to customize it using 'search.date-format' property. This property accepts the date/time pattern expression in the SimpleDateFormat format. Also, since CXF 3.0.2, the LuceneQueryVisitor could be configured to use the Lucene analyzer. The reason to use analyzer is that during Lucene query construction the visitor can use the per-field filters and tokenizers, taking into account stemming, stop-worlds, lower-casing, etc., as such properly processing the filter expression. For example:

+
+

LDAP

Mapping of FIQL/OData expressions to LDAP queries as defined by RFC-4515 is supported starting from CXF 2.7.1 with the help of org.apache.cxf.jaxrs.ext.search.ldap.LdapQueryVisitor. Use this visitor when working with LDAP or OSGI.

Here is a summary of LDAP filter operators:

Operator	Description
"="	Equal
"!"	Not Equal
"<="	Less Or Equal
">="	Greater or Equal
"&"	AND
"\|"	OR

FIQL "=le=" and "=lt=" will both map to "<=", while "=ge=" and "=gt=" to ">=".

For example:

FIQL	LDAP
"name==bar*"	"(name=ba r*)"
"name!=bar"	"(!name=bar)"
"name!=bar;id=gt=10"	"(&(!name=bar)(id>=10))"
"name!=bar;(id=gt=10,id=lt=5)"	"(&(!name=bar)(\|(id>=10)(id<=5)))"

The converter is created like all other converters:

-

Alternative query languages

Custom org.apache.cxf.jaxrs.ext.search.SearchConditionParser implementations can be registered as a "search.parser" contextual property starting from CXF 3.0.0-milestone2.

+

Attribute	Default	Description
`keyManagers`	JVM default Key Managers	Key Managers to hold X509 certificates.
`trustManagers`	JVM default Trust Managers	TrustManagers to validate peer X509 certificates.
`jsseProvider`	JVM default provider associated with protocol	JSSE provider name.
`cipherSuites`	JVM default cipher suites	CipherSuites that will be supported.
`cipherSuitesFilter`		filters of the supported CipherSuites that will be supported and used if available.
`certConstraints`		Certificate Constrain ts specification.
`secureRandomParameters`	JVM default Secure Random	SecureRandom specification.
`secureSocketProtocol`	"TLS"	Protocol Name. Most common example are "SSL", "TLS" or "TLSv1".
`certAlias`		Cert alias to use. Useful when keystore has multiple certs.

Attribute	Default	Description
`disableCNCheck`	`false`	Indicates whether that the hostname given in the HTTPS URL will be checked against the service's Common Name (CN) given in its certificate during requests, and failing if there is a mismatch. If set to `true` (not recommended for production use), such checks will be bypassed. That will allow you, for example, to use a URL such as `localhost` during development.
`sslSocketFactory`		A SSLSocketFactory to use. All other bean properties are ignored if this is set.
`sslCacheTimeout`	86400 seconds (24 hours)	SSL Cache Timeout in seconds.
`useHttpsURLConnectionDefaultSslSocketFactory`	`false`	This attribute specifies if HttpsURLConnection. getDefaultSSLSocketFactory() should be used to create https connections. If '`true`', '`jsseProvider`', '`secureSocketProtocol`', '`trustManagers`', '`keyManagers`', '`secureRandom`', '`cipherSuites`' and '`cipherSuitesFilter`' configuration parameters are ignored.
`useHttpsURLConnectionDefaultHostnameVerifier`	`false`	This attribute specifies if HttpsURLConnection.getDefaultHostnameVerifier() should be used to create https connections. If '`true`', '`disableCNCheck`' configuration parameter is ignored.

JAXB support

JSON With Padding (JSONP)

Simple JsonMapObject support

JSON With Padding (JSONP)

Lucene

Lucene

LDAP

LDAP

Alternative query languages

Alternative query languages

Content Extraction

Using TikaContentExtractor

Using TikaLuceneContentExtractor

TLS Parameters common to both Clients and Servers

Key Managers

Trust Managers

CipherSuites Filter

Cert Constraints

Client TLS Parameters

Disable CN Check

Server TLS Parameters

Client Authentication