Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Apache Wink provides an Open Search data model for producing Open Search Documents. of the model classes are located under the org.apache.wink.common.model.opensearch package. OpenSearchDescription class is used by an application to build Open Search Description documents.

OpenSearch Support

TBDThe following table shows the OpenSearch data model and representation in which it can be serialized and de-serialized.

 

Supported

Media Types

Data Model

Provider registration

Read

Yes

NA

NA

NA

Write

Yes

application/
opensearchdescription+xml

org.apache.wink
.common.model
.opensearch
.OpenSearchDescription

Not required. Registered by default

Examples

...


Producing an OpenSearch Document

...

Example

The following example demonstrates the creation of an OpenSearch document.TBD

Code Block
      @GET
    @Produces(MediaTypeUtils.OPENSEARCH)
    public OpenSearchDescription getOpenSearch(@Context UriInfo info) {
        String baseUri = info.getAbsolutePath().toString();
        OpenSearchDescription openSearchDescription = new OpenSearchDescription();
        openSearchDescription.setShortName("Example search engine");
        ...
        return openSearchDescription;
}
Explanation

...