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

Class UserRootObject

java.lang.Object

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

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

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

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

org.nuxeo.ecm.restapi.server.usermanager.UserRootObject

All Implemented Interfaces:

Resource, Adaptable

@Produces("application/json")
public class UserRootObject
extends AbstractUMRootObject<NuxeoPrincipal>

Since:

5.7.3

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_EMPTY_PASSWORD_PROP
static final String	PAGE_PROVIDER_NAME

Fields inherited from class org.nuxeo.ecm.restapi.server.usermanager.AbstractUMRootObject

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

Constructor	Description
UserRootObject()

Method Summary

Modifier and Type	Method	Description
protected void	checkPrecondition(NuxeoPrincipal principal)	Checks the precondition to create an artifact (for instance validity, duplicate detection, guards...).
protected NuxeoPrincipal	createArtifact(NuxeoPrincipal principal)	Persist an artifact in the underlying persistence system.
protected NuxeoPrincipal	getArtifact(String id)	Returns the artifact given its id.
protected String	getArtifactType()	Returns the type of the current artifact needed for AbstractResource.newObject(String, Object...).
protected PageProviderDefinition	getPageProviderDefinition()
protected Object[]	getParams()

Methods inherited from class org.nuxeo.ecm.restapi.server.usermanager.AbstractUMRootObject

checkCurrentUserCanCreateArtifact, createNew, getArtifactWebObject, initialize, search

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

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

Methods inherited from class java.lang.Object

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

Field Details

PAGE_PROVIDER_NAME

public static final String PAGE_PROVIDER_NAME

See Also:

• Constant Field Values

ALLOW_EMPTY_PASSWORD_PROP

public static final String ALLOW_EMPTY_PASSWORD_PROP

Since:

2025.1

See Also:

• Constant Field Values

Constructor Details

UserRootObject

public UserRootObject()

Method Details

getArtifact

protected NuxeoPrincipal getArtifact(String id)

Description copied from class: AbstractUMRootObject

Returns the artifact given its id.

Specified by:

getArtifact in class AbstractUMRootObject<NuxeoPrincipal>

getArtifactType

protected String getArtifactType()

Description copied from class: AbstractUMRootObject

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

Specified by:

getArtifactType in class AbstractUMRootObject<NuxeoPrincipal>

checkPrecondition

protected void checkPrecondition(NuxeoPrincipal principal)

Description copied from class: AbstractUMRootObject

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

Specified by:

checkPrecondition in class AbstractUMRootObject<NuxeoPrincipal>

createArtifact

protected NuxeoPrincipal createArtifact(NuxeoPrincipal principal)

Description copied from class: AbstractUMRootObject

Persist an artifact in the underlying persistence system.

Specified by:

createArtifact in class AbstractUMRootObject<NuxeoPrincipal>

getPageProviderDefinition

protected PageProviderDefinition getPageProviderDefinition()

Specified by:

getPageProviderDefinition in class PaginableObject<NuxeoPrincipal>

getParams

protected Object[] getParams()

Overrides:

getParams in class AbstractUMRootObject<NuxeoPrincipal>