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

Class BaseNuxeoRestlet

java.lang.Object

org.restlet.Uniform

org.restlet.Restlet

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

Direct Known Subclasses:

BaseStatelessNuxeoRestlet, ContentDiffRestlet, CreateDocumentRestlet, CreationContainerListRestlet, DirectoryCacheRestlet, DownloadFileRestlet, OpenSearchRestlet, PluginUploadRestlet, TargetPlatformsRestlet, UploadFileRestlet, UploadRestlet

public class BaseNuxeoRestlet
extends org.restlet.Restlet

Base class for Nuxeo Restlet.

Provides utility methods:

• error handling
• authentication
• http request/response retrieval

Author:

tiry

Constructor Summary

Constructors

Constructor and Description
BaseNuxeoRestlet()

Method Summary

Modifier and Type	Method and Description
protected static javax.servlet.http.HttpServletRequest	getHttpRequest(org.restlet.data.Request req)
protected static javax.servlet.http.HttpServletResponse	getHttpResponse(org.restlet.data.Response res)
protected static String	getQueryParamValue(org.restlet.data.Request req, String paramName, String defaultValue)
protected static String	getRestletFullUrl(org.restlet.data.Request request)
protected static Principal	getUserPrincipal(org.restlet.data.Request req)
protected static void	handleError(org.dom4j.dom.DOMDocument result, org.restlet.data.Response res, Exception e)
protected static void	handleError(org.dom4j.dom.DOMDocument result, org.restlet.data.Response res, String message)
protected static void	handleError(org.restlet.data.Response res, Exception e)
protected static void	handleError(org.restlet.data.Response res, String message)
void	setEntityToBlobOutput(Blob blob, DownloadService.ByteRange byteRange, org.restlet.data.Response res) Sets the response entity to a representation that will write the blob.

Methods inherited from class org.restlet.Restlet

getContext, getLogger, handle, init, isStarted, isStopped, setContext, start, stop

Methods inherited from class org.restlet.Uniform

delete, delete, get, get, handle, head, head, options, options, post, post, put, put

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseNuxeoRestlet

public BaseNuxeoRestlet()

Method Detail

handleError

protected static void handleError(org.restlet.data.Response res,
                                  String message)

handleError

protected static void handleError(org.restlet.data.Response res,
                                  Exception e)

handleError

protected static void handleError(org.dom4j.dom.DOMDocument result,
                                  org.restlet.data.Response res,
                                  Exception e)

handleError

protected static void handleError(org.dom4j.dom.DOMDocument result,
                                  org.restlet.data.Response res,
                                  String message)

getHttpRequest

protected static javax.servlet.http.HttpServletRequest getHttpRequest(org.restlet.data.Request req)

getHttpResponse

protected static javax.servlet.http.HttpServletResponse getHttpResponse(org.restlet.data.Response res)

getUserPrincipal

protected static Principal getUserPrincipal(org.restlet.data.Request req)

getRestletFullUrl

protected static String getRestletFullUrl(org.restlet.data.Request request)

getQueryParamValue

protected static String getQueryParamValue(org.restlet.data.Request req,
                                           String paramName,
                                           String defaultValue)

setEntityToBlobOutput

public void setEntityToBlobOutput(Blob blob,
                                  DownloadService.ByteRange byteRange,
                                  org.restlet.data.Response res)

Sets the response entity to a representation that will write the blob.

Parameters:

blob - the blob

byteRange - the byte range

res - the response

Since:

7.10