Apache Wink Providers

In addition to JAX-RS standard providers (section 4.2 of the JAX-RS specification), Apache Wink provides a set of complementary providers. The purpose of these providers is to provide mapping services between various representations (for example Atom, APP, OpenSearch, CSV, JSON and HTML) and their associated Java data models.
The Apache Wink providers are pre-registered and delivered with the Apache Wink runtime along with the JAX-RS standard providers.

Scoping

The JAX-RS specification defines that by default, a singleton instance of each provider class is instantiated for each JAX-RS application. Apache Wink fully supports this requirement and in addition provides a "Prototype" lifecycle, which is an instance per-request lifecycle.
Prototype means that a new instance of a provider class is instantiated for each request. The @Scope annotation (section‎0) is used on a provider class to specify its lifecycle. The lifecycle of a provider that does not specify the @Scope annotation defaults to the singleton lifecycle.

Prototype Example

The following example shows how to define a provider with a prototype lifecycle.

@Scope(ScopeType.PROTOTYPE)
@Provider
public class MyProvider implements MessageBodyReader<String>{
    ...
}

Singleton Example 1

The following example shows how to define a provider with a singleton lifecycle.

@Scope(ScopeType.SINGELTON)
@Provider
public class MyProvider implements MessageBodyReader<String>{
    ...
}

Singleton Example 2

The following example shows that when the @Scope annotation is not used, the provider will be a singleton, as per the JAX-RS specification.

@Provider
public class MyProvider implements MessageBodyReader<String>{
    ...
}

Priority

Apache Wink provides a method for setting a priority for a provider.

Out-of-the-Box Implementations

The following section describes the Apache Wink providers that are an addition to the JAX-RS requirements.

Atom Providers

Apache Wink provides a set of entity providers that are capable of mapping Atom Feed and Atom Entry XML documents to and from an Atom data model.

Atom Providers

The following tables list these providers.

AtomFeedProvider

AtomFeedSyndFeedProvider

AtomFeedJAXBElementProvider

AtomEntryProvider

AtomEntrySyndEntryProvider

AtomEntryJAXBElementProvider

APP Providers

Apache Wink provides a set of providers that are capable of mapping APP Service Document and APP Categories data models to their xml representations. The following tables list these providers.

AppServiceProvider

AppCategoriesProvider

CategoriesProvider

OpenSearch Provider

Apache Wink provides a single provider that is capable of serializing the OpenSearch data model.

OpenSearchDescriptionProvider

Json Providers

Apache Wink provides a set providers that are capable of serializing a number of data models (JSONObject, JAXBElement, SyndEntry, SyndFeed) into JSON representations. The following tables list these providers.

JsonProvider

JsonJAXBProvider

JsonSyndEntryProvider

JsonSyndFeedProvider

Asset Provider

Apache Wink provides a special provider that is responsible for reading and writing Asset objects.