Package org.nuxeo.scim.v2.rest.usermanager

Class ScimV2GroupObject

java.lang.Object

org.nuxeo.scim.v2.rest.usermanager.ScimV2BaseUMObject

org.nuxeo.scim.v2.rest.usermanager.ScimV2GroupObject

@Produces({"application/scim+json","application/json"})
@Path("/Groups")
public class ScimV2GroupObject
extends ScimV2BaseUMObject

SCIM 2.0 Group object.

Since:

2023.14

Field Summary

Fields

Modifier and Type	Field	Description
protected static final com.unboundid.scim2.server.utils.ResourceTypeDefinition	RESOURCE_TYPE_DEFINITION

Fields inherited from class org.nuxeo.scim.v2.rest.usermanager.ScimV2BaseUMObject

baseURL, mappingService, um, webContext

Constructor Summary

Constructors

Constructor	Description
ScimV2GroupObject(WebContext webContext)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	createGroup(com.unboundid.scim2.common.types.GroupResource group)
jakarta.ws.rs.core.Response	deleteGroupResource(String uid)
protected com.unboundid.scim2.common.types.GroupResource	doCreateGroup(com.unboundid.scim2.common.types.GroupResource group)
protected jakarta.ws.rs.core.Response	doDeleteGroup(String uid)
protected com.unboundid.scim2.common.types.GroupResource	doPatchGroup(String uid, com.unboundid.scim2.common.messages.PatchRequest patch)
protected com.unboundid.scim2.common.messages.ListResponse<com.unboundid.scim2.common.ScimResource>	doSearch(ScimV2QueryContext queryCtx)
protected com.unboundid.scim2.common.types.GroupResource	doUpdateGroup(String uid, com.unboundid.scim2.common.types.GroupResource group)
com.unboundid.scim2.common.ScimResource	getGroupResource(String uid)
protected boolean	isFetchMembers()
protected com.unboundid.scim2.server.utils.ResourcePreparer<com.unboundid.scim2.common.ScimResource>	newResourcePreparer()
com.unboundid.scim2.common.ScimResource	patchGroup(String uid, com.unboundid.scim2.common.messages.PatchRequest patch)
protected com.unboundid.scim2.common.types.GroupResource	resolveGroupResource(String uid)
com.unboundid.scim2.common.ScimResource	updateGroup(String uid, com.unboundid.scim2.common.types.GroupResource group)

Methods inherited from class org.nuxeo.scim.v2.rest.usermanager.ScimV2BaseUMObject

checkUpdateGuardPreconditions, getResources, isAPowerUserEditableArtifact

Methods inherited from class java.lang.Object

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

Field Details

RESOURCE_TYPE_DEFINITION

protected static final com.unboundid.scim2.server.utils.ResourceTypeDefinition RESOURCE_TYPE_DEFINITION

Constructor Details

ScimV2GroupObject

public ScimV2GroupObject(@Context
 WebContext webContext)

Method Details

createGroup

@POST
public jakarta.ws.rs.core.Response createGroup(com.unboundid.scim2.common.types.GroupResource group)
                                        throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

getGroupResource

@GET
@Path("{uid}")
public com.unboundid.scim2.common.ScimResource getGroupResource(@PathParam("uid")
 String uid)
                                                         throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

updateGroup

@PUT
@Path("{uid}")
public com.unboundid.scim2.common.ScimResource updateGroup(@PathParam("uid")
 String uid,
 com.unboundid.scim2.common.types.GroupResource group)
                                                    throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

patchGroup

@Path("{uid}")
public com.unboundid.scim2.common.ScimResource patchGroup(@PathParam("uid")
 String uid,
 com.unboundid.scim2.common.messages.PatchRequest patch)
                                                   throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

deleteGroupResource

@DELETE
@Path("{uid}")
public jakarta.ws.rs.core.Response deleteGroupResource(@PathParam("uid")
 String uid)
                                                throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

doCreateGroup

protected com.unboundid.scim2.common.types.GroupResource doCreateGroup(com.unboundid.scim2.common.types.GroupResource group)
                                                                throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

resolveGroupResource

protected com.unboundid.scim2.common.types.GroupResource resolveGroupResource(String uid)
                                                                       throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

doUpdateGroup

protected com.unboundid.scim2.common.types.GroupResource doUpdateGroup(String uid,
 com.unboundid.scim2.common.types.GroupResource group)
                                                                throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

doPatchGroup

protected com.unboundid.scim2.common.types.GroupResource doPatchGroup(String uid,
 com.unboundid.scim2.common.messages.PatchRequest patch)
                                                               throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

doDeleteGroup

protected jakarta.ws.rs.core.Response doDeleteGroup(String uid)
                                             throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

doSearch

protected com.unboundid.scim2.common.messages.ListResponse<com.unboundid.scim2.common.ScimResource> doSearch(ScimV2QueryContext queryCtx)
                                                                                                      throws com.unboundid.scim2.common.exceptions.ScimException

Specified by:

doSearch in class ScimV2BaseUMObject

Throws:

com.unboundid.scim2.common.exceptions.ScimException

newResourcePreparer

protected com.unboundid.scim2.server.utils.ResourcePreparer<com.unboundid.scim2.common.ScimResource> newResourcePreparer()
                                                                                                                  throws com.unboundid.scim2.common.exceptions.BadRequestException

Throws:

com.unboundid.scim2.common.exceptions.BadRequestException

isFetchMembers

protected boolean isFetchMembers()