Package org.silverpeas.core.webapi.admin.scim

Class ScimV2UserResource

java.lang.Object

edu.psu.swe.scim.server.rest.BaseResourceTypeResourceImpl<edu.psu.swe.scim.spec.resources.ScimUser>

edu.psu.swe.scim.server.rest.UserResourceImpl

org.silverpeas.core.webapi.admin.scim.ScimV2UserResource

All Implemented Interfaces:

edu.psu.swe.scim.spec.protocol.BaseResourceTypeResource<edu.psu.swe.scim.spec.resources.ScimUser>, edu.psu.swe.scim.spec.protocol.UserResource, ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource, ScimProtectedWebResource

@WebService
@Path("/domains/{domainId}/scim/Users")
@Authorized
@Alternative
@Priority(2010)
public class ScimV2UserResource
extends edu.psu.swe.scim.server.rest.UserResourceImpl
implements ScimProtectedWebResource

References :

• https://tools.ietf.org/html/rfc7643
• https://tools.ietf.org/html/rfc7644

Implementation of a user provisioning server using SCIM 2.0 protocol.

Author:

silveryocha

Field Summary

Fields inherited from interface org.silverpeas.core.web.SilverpeasWebResource

BASE_PATH

Constructor Summary

Constructors

Constructor	Description
ScimV2UserResource()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	create(edu.psu.swe.scim.spec.resources.ScimUser resource, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes)
javax.ws.rs.core.Response	delete(String id)
javax.ws.rs.core.Response	find(edu.psu.swe.scim.spec.protocol.data.SearchRequest request)
javax.ws.rs.core.Response	getById(String id, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes)
org.silverpeas.core.webapi.admin.scim.ScimRequestContext	getSilverpeasContext()	Gets the context of Silverpeas linked to the current request.
protected void	initContext()
javax.ws.rs.core.Response	patch(edu.psu.swe.scim.spec.protocol.data.PatchRequest patchRequest, String id, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes)
javax.ws.rs.core.Response	patch(String id, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes)
javax.ws.rs.core.Response	query(edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes, edu.psu.swe.scim.spec.adapter.FilterWrapper filter, edu.psu.swe.scim.spec.protocol.attribute.AttributeReference sortBy, edu.psu.swe.scim.spec.protocol.search.SortOrder sortOrder, Integer startIndex, Integer count)
javax.ws.rs.core.Response	update(edu.psu.swe.scim.spec.resources.ScimUser resource, String id, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes, edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes)

Methods inherited from class edu.psu.swe.scim.server.rest.UserResourceImpl

getProvider

Methods inherited from class edu.psu.swe.scim.server.rest.BaseResourceTypeResourceImpl

createGenericExceptionResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.silverpeas.core.webapi.admin.scim.ScimProtectedWebResource

getAdminController, getComponentId, getHttpRequest, getUri, validateUserAuthorization

Methods inherited from interface org.silverpeas.core.web.rs.WebAuthenticationValidation

validateUserAuthentication

Constructor Detail

ScimV2UserResource

public ScimV2UserResource()

Method Detail

initContext

@PostConstruct
protected void initContext()

getById

@GET
@Path("{id}")
@Produces("application/scim+json")
public javax.ws.rs.core.Response getById(@PathParam("id")
                                         String id,
                                         @QueryParam("attributes")
                                         edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes,
                                         @QueryParam("excludedAttributes")
                                         edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes)

Specified by:

getById in interface edu.psu.swe.scim.spec.protocol.BaseResourceTypeResource<edu.psu.swe.scim.spec.resources.ScimUser>

Overrides:

getById in class edu.psu.swe.scim.server.rest.BaseResourceTypeResourceImpl<edu.psu.swe.scim.spec.resources.ScimUser>

See Also:

Scim spec, retrieving known resources

query

@GET
@Produces("application/scim+json")
public javax.ws.rs.core.Response query(@QueryParam("attributes")
                                       edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes,
                                       @QueryParam("excludedAttributes")
                                       edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes,
                                       @QueryParam("filter")
                                       edu.psu.swe.scim.spec.adapter.FilterWrapper filter,
                                       @QueryParam("sortBy")
                                       edu.psu.swe.scim.spec.protocol.attribute.AttributeReference sortBy,
                                       @QueryParam("sortOrder")
                                       edu.psu.swe.scim.spec.protocol.search.SortOrder sortOrder,
                                       @QueryParam("startIndex")
                                       Integer startIndex,
                                       @QueryParam("count")
                                       Integer count)

Specified by:

query in interface edu.psu.swe.scim.spec.protocol.BaseResourceTypeResource<edu.psu.swe.scim.spec.resources.ScimUser>

Overrides:

query in class edu.psu.swe.scim.server.rest.BaseResourceTypeResourceImpl<edu.psu.swe.scim.spec.resources.ScimUser>

See Also:

Scim spec, query resources

create

@POST
@Consumes("application/scim+json")
@Produces("application/scim+json")
public javax.ws.rs.core.Response create(edu.psu.swe.scim.spec.resources.ScimUser resource,
                                        @QueryParam("attributes")
                                        edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes,
                                        @QueryParam("excludedAttributes")
                                        edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes)

Specified by:

create in interface edu.psu.swe.scim.spec.protocol.BaseResourceTypeResource<edu.psu.swe.scim.spec.resources.ScimUser>

Overrides:

create in class edu.psu.swe.scim.server.rest.BaseResourceTypeResourceImpl<edu.psu.swe.scim.spec.resources.ScimUser>

See Also:

Scim spec, query resources

find

@POST
@Path("/.search")
@Produces("application/scim+json")
public javax.ws.rs.core.Response find(edu.psu.swe.scim.spec.protocol.data.SearchRequest request)

Specified by:

find in interface edu.psu.swe.scim.spec.protocol.BaseResourceTypeResource<edu.psu.swe.scim.spec.resources.ScimUser>

Overrides:

find in class edu.psu.swe.scim.server.rest.BaseResourceTypeResourceImpl<edu.psu.swe.scim.spec.resources.ScimUser>

See Also:

Scim spec, query with post

update

@PUT
@Path("{id}")
@Consumes("application/scim+json")
@Produces("application/scim+json")
public javax.ws.rs.core.Response update(edu.psu.swe.scim.spec.resources.ScimUser resource,
                                        @PathParam("id")
                                        String id,
                                        @QueryParam("attributes")
                                        edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes,
                                        @QueryParam("excludedAttributes")
                                        edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes)

Specified by:

update in interface edu.psu.swe.scim.spec.protocol.BaseResourceTypeResource<edu.psu.swe.scim.spec.resources.ScimUser>

Overrides:

update in class edu.psu.swe.scim.server.rest.BaseResourceTypeResourceImpl<edu.psu.swe.scim.spec.resources.ScimUser>

See Also:

Scim spec, update

patch

@PATCH
@Path("{id}")
@Consumes("application/scim+json")
@Produces("application/scim+json")
public javax.ws.rs.core.Response patch(@PathParam("id")
                                       String id,
                                       @QueryParam("attributes")
                                       edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes,
                                       @QueryParam("excludedAttributes")
                                       edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes)
                                throws IOException

Throws:

IOException

patch

@PATCH
@Path("{id}")
@Consumes("text/plain")
@Produces("text/plain")
public javax.ws.rs.core.Response patch(edu.psu.swe.scim.spec.protocol.data.PatchRequest patchRequest,
                                       String id,
                                       edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper attributes,
                                       edu.psu.swe.scim.spec.protocol.attribute.AttributeReferenceListWrapper excludedAttributes)

Specified by:

patch in interface edu.psu.swe.scim.spec.protocol.BaseResourceTypeResource<edu.psu.swe.scim.spec.resources.ScimUser>

Overrides:

patch in class edu.psu.swe.scim.server.rest.BaseResourceTypeResourceImpl<edu.psu.swe.scim.spec.resources.ScimUser>

delete

@DELETE
@Path("{id}")
public javax.ws.rs.core.Response delete(@PathParam("id")
                                        String id)

Specified by:

delete in interface edu.psu.swe.scim.spec.protocol.BaseResourceTypeResource<edu.psu.swe.scim.spec.resources.ScimUser>

Overrides:

delete in class edu.psu.swe.scim.server.rest.BaseResourceTypeResourceImpl<edu.psu.swe.scim.spec.resources.ScimUser>

getSilverpeasContext

public org.silverpeas.core.webapi.admin.scim.ScimRequestContext getSilverpeasContext()

Description copied from interface: WebAuthenticationValidation

Gets the context of Silverpeas linked to the current request. This context must be initialized before the functional request processing.

Specified by:

getSilverpeasContext in interface ScimProtectedWebResource

Specified by:

getSilverpeasContext in interface WebAuthenticationValidation

Specified by:

getSilverpeasContext in interface WebAuthorizationValidation

Returns:

SilverpeasRequestContext instance.