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

Class GroupRootObject

java.lang.Object

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

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

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

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

org.nuxeo.ecm.restapi.server.usermanager.GroupRootObject

All Implemented Interfaces:

Resource, Adaptable

public class GroupRootObject
extends AbstractUMRootObject<NuxeoGroup>

Since:

5.7.3

Field Summary

Fields

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

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
GroupRootObject()

Method Summary

Modifier and Type	Method	Description
protected boolean	canCurrentUserReadGroupMembers(NuxeoGroup group)
protected void	checkGroupDoesNotAlreadyExists(NuxeoGroup group, UserManager um)
protected void	checkGroupHasAName(NuxeoGroup group)
protected void	checkPrecondition(NuxeoGroup group)	Checks the precondition to create an artifact (for instance validity, duplicate detection, guards...).
protected static Set<String>	computeAllGroups(UserManager um, NuxeoGroup group)
protected NuxeoGroup	createArtifact(NuxeoGroup group)	Persist an artifact in the underlying persistence system.
protected NuxeoGroup	emptyGroupReferences(NuxeoGroup group)
protected NuxeoGroup	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()

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

checkCurrentUserCanCreateArtifact, createNew, getArtifactWebObject, getParams, 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

RESTRICT_ADMINISTRATORS_MEMBERS_PROP

public static final String RESTRICT_ADMINISTRATORS_MEMBERS_PROP

Since:

2025.1

See Also:

• Constant Field Values

Constructor Details

GroupRootObject

public GroupRootObject()

Method Details

getArtifact

protected NuxeoGroup getArtifact(String id)

Description copied from class: AbstractUMRootObject

Returns the artifact given its id.

Specified by:

getArtifact in class AbstractUMRootObject<NuxeoGroup>

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

checkPrecondition

protected void checkPrecondition(NuxeoGroup group)

Description copied from class: AbstractUMRootObject

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

Specified by:

checkPrecondition in class AbstractUMRootObject<NuxeoGroup>

createArtifact

protected NuxeoGroup createArtifact(NuxeoGroup group)

Description copied from class: AbstractUMRootObject

Persist an artifact in the underlying persistence system.

Specified by:

createArtifact in class AbstractUMRootObject<NuxeoGroup>

checkGroupDoesNotAlreadyExists

protected void checkGroupDoesNotAlreadyExists(NuxeoGroup group,
 UserManager um)

checkGroupHasAName

protected void checkGroupHasAName(NuxeoGroup group)

canCurrentUserReadGroupMembers

protected boolean canCurrentUserReadGroupMembers(NuxeoGroup group)

emptyGroupReferences

protected NuxeoGroup emptyGroupReferences(NuxeoGroup group)

computeAllGroups

protected static Set<String> computeAllGroups(UserManager um,
 NuxeoGroup group)

getPageProviderDefinition

protected PageProviderDefinition getPageProviderDefinition()

Specified by:

getPageProviderDefinition in class PaginableObject<NuxeoGroup>