Package org.nuxeo.ecm.restapi.server.usermanager

Class AbstractUMRootObject<T>

java.lang.Object

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

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

org.nuxeo.ecm.restapi.server.PaginableObject<T>

org.nuxeo.ecm.restapi.server.usermanager.AbstractUMRootObject<T>

All Implemented Interfaces:

Resource, Adaptable

Direct Known Subclasses:

GroupRootObject, UserRootObject

public abstract class AbstractUMRootObject<T>
extends PaginableObject<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<? extends Resource>	artifactClass
protected String	query
protected UserManager	um

Fields inherited from class org.nuxeo.ecm.restapi.server.PaginableObject

currentPageIndex, maxResults, offset, pageSize

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

ctx, next, path, prev, type

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractUMRootObject()	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.14, use AbstractUMRootObject(Class) instead.
protected	AbstractUMRootObject(Class<? extends Resource> artifactClass)

Method Summary

Modifier and Type	Method	Description
protected void	checkCurrentUserCanCreateArtifact(T artifact)
protected abstract void	checkPrecondition(T artifact)	Checks the precondition to create an artifact (for instance validity, duplicate detection, guards...).
protected abstract T	createArtifact(T artifact)	Persist an artifact in the underlying persistence system.
jakarta.ws.rs.core.Response	createNew(T artifact)
protected abstract T	getArtifact(String id)	Returns the artifact given its id.
protected abstract String	getArtifactType()	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.14
Object	getArtifactWebObject(String artName)
protected Object[]	getParams()
protected void	initialize(Object... args)
List<T>	search()

Methods inherited from class org.nuxeo.ecm.restapi.server.PaginableObject

extractLongParam, getPageProviderDefinition, getPaginableEntries, getPaginableEntries, getSearchDocument

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, 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

Field Details

artifactClass

protected final Class<? extends Resource> artifactClass

query

protected String query

um

protected UserManager um

Constructor Details

AbstractUMRootObject

@Deprecated(since="2025.14",
            forRemoval=true)
public AbstractUMRootObject()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.14, use AbstractUMRootObject(Class) instead.

AbstractUMRootObject

protected AbstractUMRootObject(Class<? extends Resource> artifactClass)

Method Details

initialize

protected void initialize(Object... args)

Overrides:

initialize in class PaginableObject<T>

getArtifactWebObject

@Path("{artName:((?:(?!(/@|(/user/|/group/))).)*)}")
public Object getArtifactWebObject(@PathParam("artName")
 String artName)

createNew

@POST
public jakarta.ws.rs.core.Response createNew(T artifact)

search

@GET
@Path("search")
public List<T> search()

getParams

protected Object[] getParams()

Overrides:

getParams in class PaginableObject<T>

getArtifact

protected abstract T getArtifact(String id)

Returns the artifact given its id.

getArtifactType

@Deprecated(since="2025.14",
            forRemoval=true)
protected abstract String getArtifactType()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.14

Returns the type of the current artifact needed for AbstractResource.newObject(String, Object...).

checkPrecondition

protected abstract void checkPrecondition(T artifact)

Checks the precondition to create an artifact (for instance validity, duplicate detection, guards...).

createArtifact

protected abstract T createArtifact(T artifact)

Persist an artifact in the underlying persistence system.

checkCurrentUserCanCreateArtifact

protected void checkCurrentUserCanCreateArtifact(T artifact)