Package org.nuxeo.ecm.restapi.server

Class APIRoot

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.webengine.model.impl.DefaultObject

org.nuxeo.ecm.webengine.model.impl.ModuleRoot

org.nuxeo.ecm.restapi.server.APIRoot

All Implemented Interfaces:

ModuleResource, Resource, Adaptable

@Path("/api/v1{repo : (/repo/[^/]+?)?}")
@Produces("text/html;charset=UTF-8")
public class APIRoot
extends ModuleRoot

The root entry for the WebEngine module.

Since:

5.7.2

Field Summary

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor	Description
APIRoot()

Method Summary

Modifier and Type	Method	Description
BulkActionFrameworkObject	bulk()
CapabilitiesObject	capabilities()
ConfigEndPoint	doGetConfig()
ConversionRootObject	doGetConversion()
DirectoryRootObject	doGetDirectory()
GroupRootObject	doGetGroup()
RepositoryObject	doGetRepository(String repositoryParam)
UserRootObject	doGetUser()
QueryObject	doQuery()
AutomationResource	getAutomationEndPoint()
Object	route(String otherPath)

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.ModuleRoot

getLink, getSkinResource, handleError, setContext

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultObject

disptachAdapter, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, initialize, isInstanceOf, isRoot, newAdapter, newObject, newObject, redirect, retrieveWebObjectType, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Adaptable

getAdapter

Methods inherited from interface org.nuxeo.ecm.webengine.model.Resource

checkGuard, dispose, getActiveAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isAdapter, isInstanceOf, isRoot, newAdapter, newObject, newObject, redirect, setNext, setPrevious, setRoot

Constructor Details

APIRoot

public APIRoot()

Method Details

doGetRepository

@Path("/")
public RepositoryObject doGetRepository(@PathParam("repo")
 String repositoryParam)
                                 throws DocumentNotFoundException

Throws:

DocumentNotFoundException

doGetUser

@Path("/user")
public UserRootObject doGetUser()

doGetGroup

@Path("/group")
public GroupRootObject doGetGroup()

getAutomationEndPoint

@Path("/automation")
public AutomationResource getAutomationEndPoint()

doGetDirectory

@Path("/directory")
public DirectoryRootObject doGetDirectory()

doQuery

@Path("/query")
public QueryObject doQuery()

doGetConfig

@Path("/config")
public ConfigEndPoint doGetConfig()

doGetConversion

@Path("/conversion")
public ConversionRootObject doGetConversion()

bulk

@Path("/bulk")
public BulkActionFrameworkObject bulk()

Since:

10.3

capabilities

@Path("/capabilities")
public CapabilitiesObject capabilities()

Since:

11.5

route

@Path("/ext/{otherPath}")
public Object route(@PathParam("otherPath")
 String otherPath)

Since:

7.2