org.nuxeo.ecm.platform.ui.web.restAPI

Class OpenSearchRestlet

java.lang.Object

org.restlet.Restlet

org.nuxeo.ecm.platform.ui.web.restAPI.BaseNuxeoRestlet

org.nuxeo.ecm.platform.ui.web.restAPI.OpenSearchRestlet

All Implemented Interfaces:

org.restlet.Uniform

public class OpenSearchRestlet
extends BaseNuxeoRestlet

Basic OpenSearch REST fulltext search implementation using the RSS 2.0 results format.

TODO: make it possible to change the page size and navigate to next results pages using additional query parameters. See http://opensearch.org for official specifications.

TODO: use a OPENSEARCH stateless query model to be able to override the currently hardcoded request pattern.

TODO: add OpenSearch XML description snippet in the default theme so that Firefox can autodetect the service URL.

Author:

Olivier Grisel

Field Summary

Fields

Modifier and Type	Field and Description
static org.dom4j.Namespace	ATOM_NS
static String	CHANNEL_TAG
static String	DESCRIPTION_TAG
static String	ITEM_TAG
static String	LINK_TAG
static int	MAX
static org.dom4j.Namespace	OPENSEARCH_NS
static String	QUERY
static String	RSS_TAG
static String	TITLE_TAG

Fields inherited from class org.nuxeo.ecm.platform.ui.web.restAPI.BaseNuxeoRestlet

DEPRECATION_DONE

Constructor Summary

Constructors

Constructor and Description
OpenSearchRestlet()

Method Summary

Modifier and Type	Method and Description
void	handle(org.restlet.Request req, org.restlet.Response res)

Methods inherited from class org.nuxeo.ecm.platform.ui.web.restAPI.BaseNuxeoRestlet

getHttpRequest, getHttpResponse, getQueryParamValue, getRestletFullUrl, handleError, handleError, handleError, handleError, logDeprecation, setEntityToBlobOutput

Methods inherited from class org.restlet.Restlet

createFinder, finalize, getApplication, getAuthor, getContext, getDescription, getFinderClass, getLogger, getName, getOwner, handle, handle, handle, isStarted, isStopped, setAuthor, setContext, setDescription, setFinderClass, setName, setOwner, start, stop

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RSS_TAG

public static final String RSS_TAG

See Also:

Constant Field Values

CHANNEL_TAG

public static final String CHANNEL_TAG

See Also:

Constant Field Values

TITLE_TAG

public static final String TITLE_TAG

See Also:

Constant Field Values

DESCRIPTION_TAG

public static final String DESCRIPTION_TAG

See Also:

Constant Field Values

LINK_TAG

public static final String LINK_TAG

See Also:

Constant Field Values

ITEM_TAG

public static final String ITEM_TAG

See Also:

Constant Field Values

QUERY

public static final String QUERY

See Also:

Constant Field Values

MAX

public static final int MAX

See Also:

Constant Field Values

OPENSEARCH_NS

public static final org.dom4j.Namespace OPENSEARCH_NS

ATOM_NS

public static final org.dom4j.Namespace ATOM_NS

Constructor Detail

OpenSearchRestlet

public OpenSearchRestlet()

Method Detail

handle

public void handle(org.restlet.Request req,
                   org.restlet.Response res)

Specified by:

handle in interface org.restlet.Uniform

Overrides:

handle in class org.restlet.Restlet