ModuleRoot (Nuxeo 2021.70.4 API Documentation)

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

All Implemented Interfaces:

ModuleResource, Resource, Adaptable

Direct Known Subclasses:

APIRoot, AutomationResource, ConnectClientRoot, EasyShare, Main, Main, OAuth2Callback, RootResource, RootResource, SCIMRoot, Test, UserInvitationObject, WOPIRoot
```
public class ModuleRoot
extends DefaultObject
implements ModuleResource
```
Author:

Bogdan Stefanescu

Field Summary

Fields
Modifier and Type Field Description

protected javax.servlet.http.HttpServletRequest request

protected com.sun.jersey.server.impl.inject.ServerInjectableProviderContext sic
- Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource
  ctx, next, path, prev, type

Constructor Summary

Constructors
Constructor Description

ModuleRoot()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getLink(DocumentModel doc)`	You should override this method to resolve objects to links.
`javax.ws.rs.core.Response`	`getSkinResource(String path)`
`Object`	`handleError(Throwable t)`
`void`	`setContext(com.sun.jersey.api.core.HttpContext hc)`

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, redirect, 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, redirect, setNext, setPrevious, setRoot

- Field Detail
  - request
```
@Context
protected javax.servlet.http.HttpServletRequest request
```
  - sic
```
@Context
protected com.sun.jersey.server.impl.inject.ServerInjectableProviderContext sic
```
- Constructor Detail
  - ModuleRoot
```
public ModuleRoot()
```
- Method Detail
  - setContext
```
@Context
public void setContext(com.sun.jersey.api.core.HttpContext hc)
```
  - getSkinResource
```
public javax.ws.rs.core.Response getSkinResource(String path)
```
  - getLink
```
public String getLink(DocumentModel doc)
```
    You should override this method to resolve objects to links. This method is usually called by a search view to generate links for object that are listed
    
    Specified by:
    
    getLink in interface ModuleResource
    
    Parameters:
    
    doc - the document
    
    Returns:
    
    the link corresponding to that object
  - handleError
```
public Object handleError(Throwable t)
```
    Specified by:
    
    handleError in interface ModuleResource