org.gluu.oxtrust.ws.rs.scim2.UserWebService の継承関係図

org.gluu.oxtrust.ws.rs.scim2.UserWebService 連携図

公開メンバ関数
Response	createUser ( @ApiParam(value="User", required=true) UserResource user, @QueryParam(QUERY_PARAM_ATTRIBUTES) String attrsList, @QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String excludedAttrsList)

Response	getUserById ( @PathParam("id") String id, @QueryParam(QUERY_PARAM_ATTRIBUTES) String attrsList, @QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String excludedAttrsList)

Response	updateUser ( @ApiParam(value="User", required=true) UserResource user, @PathParam("id") String id, @QueryParam(QUERY_PARAM_ATTRIBUTES) String attrsList, @QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String excludedAttrsList)

Response	deleteUser (@PathParam("id") String id)

Response	searchUsers ( @QueryParam(QUERY_PARAM_FILTER) String filter, @QueryParam(QUERY_PARAM_START_INDEX) Integer startIndex, @QueryParam(QUERY_PARAM_COUNT) Integer count, @QueryParam(QUERY_PARAM_SORT_BY) String sortBy, @QueryParam(QUERY_PARAM_SORT_ORDER) String sortOrder, @QueryParam(QUERY_PARAM_ATTRIBUTES) String attrsList, @QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String excludedAttrsList)

Response	searchUsersPost (@ApiParam(value="SearchRequest", required=true) SearchRequest searchRequest)

Response	patchUser (PatchRequest request, @PathParam("id") String id, @QueryParam(QUERY_PARAM_ATTRIBUTES) String attrsList, @QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String excludedAttrsList)

void	setup ()

String	getEndpointUrl ()

Response	createUser (UserResource user, @QueryParam(QUERY_PARAM_ATTRIBUTES) String attrsList, @QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String excludedAttrsList)

Response	updateUser (UserResource user, @PathParam("id") String id, @QueryParam(QUERY_PARAM_ATTRIBUTES) String attrsList, @QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String excludedAttrsList)

Response	searchUsersPost (SearchRequest searchRequest)

静的公開メンバ関数
static Response	getErrorResponse (Response.Status status, String detail)

static Response	getErrorResponse (Response.Status status, ErrorScimType scimType, String detail)

static Response	getErrorResponse (int statusCode, ErrorScimType scimType, String detail)

静的公開変数類
static final String	SEARCH_SUFFIX = ".search"

限定公開メンバ関数
void	assignMetaInformation (BaseScimResource resource)

void	executeDefaultValidation (BaseScimResource resource) throws SCIMException

void	executeValidation (BaseScimResource resource, boolean skipRequired) throws SCIMException

Response	prepareSearchRequest (List< String > schemas, String filter, String sortBy, String sortOrder, Integer startIndex, Integer count, String attrsList, String excludedAttrsList, SearchRequest request)

Response	inspectPatchRequest (PatchRequest patch, Class<? extends BaseScimResource > cls)

関数
int	getMaxCount ()

String	getValueFromHeaders (HttpHeaders headers, String name)

String	translateSortByAttribute (Class<? extends BaseScimResource > cls, String sortBy)

String	getListResponseSerialized (int total, int startIndex, List< BaseScimResource > resources, String attrsList, String excludedAttrsList, boolean ignoreResults) throws IOException

変数
Logger	log

AppConfiguration	appConfiguration

ScimResourceSerializer	resourceSerializer

ExtensionService	extService

String	endpointUrl

非公開変数類
IPersonService	personService

Scim2UserService	scim2UserService

Scim2PatchService	scim2PatchService

詳解

Implementation of /Users endpoint. Methods here are intercepted and/or decorated. Class org.gluu.oxtrust.service.scim2.interceptor.UserWebServiceDecorator is used to apply pre-validations on data. Filter org.gluu.oxtrust.filter.AuthorizationProcessingFilter secures invocations

著者: Rahat Ali Date: 05.08.2015 Updated by jgomer on 2017-09-12.

関数詳解

◆ assignMetaInformation()

void org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.assignMetaInformation ( BaseScimResource resource )

inlineprotectedinherited

                                                                    {
 
         //Generate some meta information (this replaces the info client passed in the request)
         long now=new Date().getTime();
         String val= ISODateTimeFormat.dateTime().withZoneUTC().print(now);
 
         Meta meta=new Meta();
         meta.setResourceType(ScimResourceUtil.getType(resource.getClass()));
         meta.setCreated(val);
         meta.setLastModified(val);
         //For version attritute: Service provider support for this attribute is optional and subject to the service provider's support for versioning
         //For location attribute: this will be set after current user creation in LDAP
         resource.setMeta(meta);
 
     }

◆ createUser() [1/2]

Response org.gluu.oxtrust.ws.rs.scim2.IUserWebService.createUser	(	UserResource	user,
		@QueryParam(QUERY_PARAM_ATTRIBUTES) String	attrsList,
		@QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String	excludedAttrsList
	)

inherited

Service method that allows creating a User resource via POST (as per section 3.3 of RFC 7644).

引数

user	An object that represents the User to create
attrsList	See notes about attributes query param
excludedAttrsList	See notes about excludedAttributes query param

戻り値: An object abstracting the response obtained from the server to this request. A succesful response for this operation should contain a status code of 201 (created) and a UserResource in the entity body (the resource just created)

◆ createUser() [2/2]

Response org.gluu.oxtrust.ws.rs.scim2.UserWebService.createUser	(	@ApiParam(value="User", required=true) UserResource	user,
		@QueryParam(QUERY_PARAM_ATTRIBUTES) String	attrsList,
		@QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String	excludedAttrsList
	)

inline

                                                                              {
 
         Response response;
         try {
             log.debug("Executing web service method. createUser");
             scim2UserService.createUser(user, endpointUrl);
             String json=resourceSerializer.serialize(user, attrsList, excludedAttrsList);
             response=Response.created(new URI(user.getMeta().getLocation())).entity(json).build();
         }
         catch (Exception e){
             log.error("Failure at createUser method", e);
             response=getErrorResponse(Response.Status.INTERNAL_SERVER_ERROR, "Unexpected error: " + e.getMessage());
         }
         return response;
 
     }

◆ deleteUser()

Response org.gluu.oxtrust.ws.rs.scim2.UserWebService.deleteUser ( @PathParam("id") String id )

inline

org.gluu.oxtrust.ws.rs.scim2.IUserWebServiceを実装しています。

                                                           {
 
         Response response;
         try {
             log.debug("Executing web service method. deleteUser");
             GluuCustomPerson person=personService.getPersonByInum(id);  //person cannot be null (check associated decorator method)
             scim2UserService.deleteUser(person);
             response=Response.noContent().build();
         }
         catch (Exception e){
             log.error("Failure at deleteUser method", e);
             response=getErrorResponse(Response.Status.INTERNAL_SERVER_ERROR, "Unexpected error: " + e.getMessage());
         }
         return response;
 
     }

◆ executeDefaultValidation()

void org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.executeDefaultValidation ( BaseScimResource resource ) throws SCIMException

inlineprotectedinherited

                                                                                             {
         executeValidation(resource, false);
     }

◆ executeValidation()

void org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.executeValidation	(	BaseScimResource	resource,
		boolean	skipRequired
	)		throws SCIMException

inlineprotectedinherited

                                                                                                            {
 
         ResourceValidator rv=new ResourceValidator(resource, extService.getResourceExtensions(resource.getClass()));
         if (!skipRequired){
             rv.validateRequiredAttributes();
             rv.validateSchemasAttribute();
         }
         rv.validateValidableAttributes();
         //By section 7 of RFC 7643, we are not forced to constrain attribute values when they have a list of canonical values associated
         //rv.validateCanonicalizedAttributes();
         rv.validateExtendedAttributes();
 
     }

◆ getEndpointUrl()

String org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.getEndpointUrl ( )

inlineinherited

                                    {
         return endpointUrl;
     }

◆ getErrorResponse() [1/3]

static Response org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.getErrorResponse	(	Response.Status	status,
		String	detail
	)

inlinestaticinherited

                                                                                    {
         return getErrorResponse(status.getStatusCode(), null, detail);
     }

◆ getErrorResponse() [2/3]

static Response org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.getErrorResponse	(	Response.Status	status,
		ErrorScimType	scimType,
		String	detail
	)

inlinestaticinherited

                                                                                                            {
         return getErrorResponse(status.getStatusCode(), scimType, detail);
     }

◆ getErrorResponse() [3/3]

static Response org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.getErrorResponse	(	int	statusCode,
		ErrorScimType	scimType,
		String	detail
	)

inlinestaticinherited

                                                                                                    {
 
         ErrorResponse errorResponse = new ErrorResponse();
         errorResponse.setStatus(String.valueOf(statusCode));
         errorResponse.setScimType(scimType);
         errorResponse.setDetail(detail);
 
         return Response.status(statusCode).entity(errorResponse).build();
     }

◆ getListResponseSerialized()

String org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.getListResponseSerialized	(	int	total,
		int	startIndex,
		List< BaseScimResource >	resources,
		String	attrsList,
		String	excludedAttrsList,
		boolean	ignoreResults
	)		throws IOException

inlinepackageinherited

                                                                                                         {
 
         ListResponse listResponse = new ListResponse(startIndex, resources.size(), total);
         listResponse.setResources(resources);
 
         ObjectMapper mapper = new ObjectMapper();
         SimpleModule module = new SimpleModule("ListResponseModule", Version.unknownVersion());
         module.addSerializer(ListResponse.class, new ListResponseJsonSerializer(resourceSerializer, attrsList, excludedAttrsList, ignoreResults));
         mapper.registerModule(module);
 
         return mapper.writeValueAsString(listResponse);
 
     }

◆ getMaxCount()

int org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.getMaxCount ( )

inlinepackageinherited

                      {
         return appConfiguration.getScimProperties().getMaxCount();
     }

◆ getUserById()

Response org.gluu.oxtrust.ws.rs.scim2.UserWebService.getUserById	(	@PathParam("id") String	id,
		@QueryParam(QUERY_PARAM_ATTRIBUTES) String	attrsList,
		@QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String	excludedAttrsList
	)

inline

org.gluu.oxtrust.ws.rs.scim2.IUserWebServiceを実装しています。

                                                                               {
 
         Response response;
         try {
             log.debug("Executing web service method. getUserById");
             UserResource user=new UserResource();
             GluuCustomPerson person=personService.getPersonByInum(id);  //person is not null (check associated decorator method)
             scim2UserService.transferAttributesToUserResource(person, user, endpointUrl);
 
             String json=resourceSerializer.serialize(user, attrsList, excludedAttrsList);
             response=Response.ok(new URI(user.getMeta().getLocation())).entity(json).build();
         }
         catch (Exception e){
             log.error("Failure at getUserById method", e);
             response=getErrorResponse(Response.Status.INTERNAL_SERVER_ERROR, "Unexpected error: " + e.getMessage());
         }
         return response;
 
     }

◆ getValueFromHeaders()

String org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.getValueFromHeaders	(	HttpHeaders	headers,
		String	name
	)

inlinepackageinherited

                                                                 {
         List<String> values=headers.getRequestHeaders().get(name);
         return (values==null || values.size()==0) ? null : values.get(0);
     }

◆ inspectPatchRequest()

Response org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.inspectPatchRequest	(	PatchRequest	patch,
		Class<? extends BaseScimResource >	cls
	)

inlineprotectedinherited

                                                                                                      {
 
         Response response=null;
         List<String> schemas=patch.getSchemas();
 
         if (schemas!=null && schemas.size()==1 && schemas.get(0).equals(PATCH_REQUEST_SCHEMA_ID)) {
             List<PatchOperation> ops = patch.getOperations();
 
             if (ops != null) {
                 //Adjust paths if they came prefixed
 
                 String defSchema=ScimResourceUtil.getDefaultSchemaUrn(cls);
                 List<String> urns=extService.getUrnsOfExtensions(cls);
                 urns.add(defSchema);
 
                 for (PatchOperation op : ops){
                     if (op.getPath()!=null)
                         op.setPath(ScimResourceUtil.adjustNotationInPath(op.getPath(), defSchema, urns));
                 }
 
                 for (PatchOperation op : ops) {
 
                     if (op.getType() == null)
                         response = getErrorResponse(BAD_REQUEST, ErrorScimType.INVALID_SYNTAX, "Operation '" + op.getOperation() + "' not recognized");
                     else {
                         String path = op.getPath();
 
                         if (StringUtils.isEmpty(path) && op.getType().equals(PatchOperationType.REMOVE))
                             response = getErrorResponse(BAD_REQUEST, ErrorScimType.NO_TARGET, "Path attribute is required for remove operation");
                         else
                         if (op.getValue() == null && !op.getType().equals(PatchOperationType.REMOVE))
                             response = getErrorResponse(BAD_REQUEST, ErrorScimType.INVALID_SYNTAX, "Value attribute is required for operations other than remove");
                     }
                     if (response != null)
                         break;
                 }
             }
             else
                 response = getErrorResponse(BAD_REQUEST, ErrorScimType.INVALID_SYNTAX, "Patch request MUST contain the attribute 'Operations'");
         }
         else
             response = getErrorResponse(BAD_REQUEST, ErrorScimType.INVALID_SYNTAX, "Wrong schema(s) supplied in Search Request");
 
         log.info("inspectPatchRequest. Preprocessing of patch request {}", response==null ? "passed" : "failed");
         return response;
 
     }

◆ patchUser()

Response org.gluu.oxtrust.ws.rs.scim2.UserWebService.patchUser	(	PatchRequest	request,
		@PathParam("id") String	id,
		@QueryParam(QUERY_PARAM_ATTRIBUTES) String	attrsList,
		@QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String	excludedAttrsList
	)

inline

org.gluu.oxtrust.ws.rs.scim2.IUserWebServiceを実装しています。

                                                                              {
 
         Response response;
         try{
             log.debug("Executing web service method. patchUser");
             UserResource user=new UserResource();
             GluuCustomPerson person=personService.getPersonByInum(id);  //person is not null (check associated decorator method)
 
             //Fill user instance with all info from person
             scim2UserService.transferAttributesToUserResource(person, user, endpointUrl);
 
             //Apply patches one by one in sequence
             for (PatchOperation po : request.getOperations()) {
                 //Handle special case: https://github.com/GluuFederation/oxTrust/issues/800
                 if (po.getType().equals(REMOVE) && po.getPath().equals("pairwiseIdentitifers")){
                     //If this block weren't here, the implementation will throw error because read-only attribute cannot be altered
                     //Note the path is intentionally mistyped, see class member in UserResource
                     person.setOxPPID(null);
                     user.setPairwiseIdentitifers(null);
                     scim2UserService.removePPIDsBranch(person.getDn());
                 }
                 else
                     user = (UserResource) scim2PatchService.applyPatchOperation(user, po);
             }
 
             //Throws exception if final representation does not pass overall validation
             log.debug("patchUser. Revising final resource representation still passes validations");
             executeDefaultValidation(user);
             ScimResourceUtil.adjustPrimarySubAttributes(user);
 
             //Update timestamp
             String now=ISODateTimeFormat.dateTime().withZoneUTC().print(System.currentTimeMillis());
             user.getMeta().setLastModified(now);
 
             //Replaces the information found in person with the contents of user
             scim2UserService.replacePersonInfo(person, user, endpointUrl);
 
             String json=resourceSerializer.serialize(user, attrsList, excludedAttrsList);
             response=Response.ok(new URI(user.getMeta().getLocation())).entity(json).build();
         }
         catch (InvalidAttributeValueException e){
             log.error(e.getMessage(), e);
             response=getErrorResponse(Response.Status.BAD_REQUEST, ErrorScimType.MUTABILITY, e.getMessage());
         }
         catch (SCIMException e){
             response=getErrorResponse(Response.Status.BAD_REQUEST, ErrorScimType.INVALID_SYNTAX, e.getMessage());
         }
         catch (Exception e){
             log.error("Failure at patchUser method", e);
             response=getErrorResponse(Response.Status.INTERNAL_SERVER_ERROR, "Unexpected error: " + e.getMessage());
         }
         return response;
 
     }

◆ prepareSearchRequest()

Response org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.prepareSearchRequest	(	List< String >	schemas,
		String	filter,
		String	sortBy,
		String	sortOrder,
		Integer	startIndex,
		Integer	count,
		String	attrsList,
		String	excludedAttrsList,
		SearchRequest	request
	)

inlineprotectedinherited

                                                                                                                              {
 
         Response response=null;
 
         if (schemas!=null && schemas.size()==1 && schemas.get(0).equals(SEARCH_REQUEST_SCHEMA_ID)) {
             count = count == null ? getMaxCount() : count;
             //Per spec, a negative value SHALL be interpreted as "0" for count
             if (count<0)
                 count=0;
 
             if (count <= getMaxCount()) {
                 startIndex = (startIndex == null || startIndex < 1) ? 1 : startIndex;
 
                 if (StringUtils.isEmpty(sortOrder) || !sortOrder.equals(SortOrder.DESCENDING.getValue()))
                     sortOrder = SortOrder.ASCENDING.getValue();
 
                 request.setSchemas(schemas);
                 request.setAttributes(attrsList);
                 request.setExcludedAttributes(excludedAttrsList);
                 request.setFilter(filter);
                 request.setSortBy(sortBy);
                 request.setSortOrder(sortOrder);
                 request.setStartIndex(startIndex);
                 request.setCount(count);
             }
             else
                 response = getErrorResponse(BAD_REQUEST, ErrorScimType.TOO_MANY, "Maximum number of results per page is " + getMaxCount());
         }
         else
             response = getErrorResponse(BAD_REQUEST, ErrorScimType.INVALID_SYNTAX, "Wrong schema(s) supplied in Search Request");
 
         return response;
 
     }

◆ searchUsers()

Response org.gluu.oxtrust.ws.rs.scim2.UserWebService.searchUsers	(	@QueryParam(QUERY_PARAM_FILTER) String	filter,
		@QueryParam(QUERY_PARAM_START_INDEX) Integer	startIndex,
		@QueryParam(QUERY_PARAM_COUNT) Integer	count,
		@QueryParam(QUERY_PARAM_SORT_BY) String	sortBy,
		@QueryParam(QUERY_PARAM_SORT_ORDER) String	sortOrder,
		@QueryParam(QUERY_PARAM_ATTRIBUTES) String	attrsList,
		@QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String	excludedAttrsList
	)

inline

org.gluu.oxtrust.ws.rs.scim2.IUserWebServiceを実装しています。

                                                                              {
 
         Response response;
         try {
             log.debug("Executing web service method. searchUsers");
             sortBy=translateSortByAttribute(UserResource.class, sortBy);
             PagedResult<BaseScimResource> resources = scim2UserService.searchUsers(filter, sortBy, SortOrder.getByValue(sortOrder),
                     startIndex, count, endpointUrl, getMaxCount());
 
             String json = getListResponseSerialized(resources.getTotalEntriesCount(), startIndex, resources.getEntries(), attrsList, excludedAttrsList, count==0);
             response=Response.ok(json).location(new URI(endpointUrl)).build();
         }
         catch (SCIMException e){
             log.error(e.getMessage(), e);
             response=getErrorResponse(Response.Status.BAD_REQUEST, ErrorScimType.INVALID_FILTER, e.getMessage());
         }
         catch (Exception e){
             log.error("Failure at searchUsers method", e);
             response=getErrorResponse(Response.Status.INTERNAL_SERVER_ERROR, "Unexpected error: " + e.getMessage());
         }
         return response;
 
     }

◆ searchUsersPost() [1/2]

Response org.gluu.oxtrust.ws.rs.scim2.IUserWebService.searchUsersPost ( SearchRequest searchRequest )

inherited

Sends a search query for User resources using POST (see section 3.4.3 of RFC 7644).

引数

searchRequest An object containing the parameters for the query to execute. These are the same parameters passed in the URL for searches, for example in searchDevices

戻り値: An object abstracting the response obtained from the server to this request. A succesful response for this request should contain a status code of 200 and a ListResponse in the entity body (holding a collection of SCIM resources)

org.gluu.oxtrust.service.scim2.interceptor.UserWebServiceDecoratorで実装されています。

◆ searchUsersPost() [2/2]

Response org.gluu.oxtrust.ws.rs.scim2.UserWebService.searchUsersPost ( @ApiParam(value="SearchRequest", required=true) SearchRequest searchRequest )

inline

                                                                                                                     {
 
         log.debug("Executing web service method. searchUsersPost");
 
         //Calling searchUsers here does not provoke that method's interceptor/decorator being called (only this one's)
         URI uri=null;
         Response response = searchUsers(searchRequest.getFilter(),searchRequest.getStartIndex(), searchRequest.getCount(),
                 searchRequest.getSortBy(), searchRequest.getSortOrder(), searchRequest.getAttributesStr(), searchRequest.getExcludedAttributesStr());
 
         try {
             uri = new URI(endpointUrl + "/" + SEARCH_SUFFIX);
         }
         catch (Exception e){
             log.error(e.getMessage(), e);
         }
         return Response.fromResponse(response).location(uri).build();
 
     }

◆ setup()

void org.gluu.oxtrust.ws.rs.scim2.UserWebService.setup ( )

inline

                        {
         //Do not use getClass() here... a typical weld issue...
         endpointUrl=appConfiguration.getBaseEndpoint() + UserWebService.class.getAnnotation(Path.class).value();
     }

◆ translateSortByAttribute()

String org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.translateSortByAttribute	(	Class<? extends BaseScimResource >	cls,
		String	sortBy
	)

inlinepackageinherited

                                                                                           {
 
         String type=ScimResourceUtil.getType(cls);
         if (StringUtils.isEmpty(sortBy) || type==null)
             sortBy=null;
         else {
             if (extService.extensionOfAttribute(cls, sortBy)==null) {   //It's not a custom attribute...
 
                 sortBy=ScimResourceUtil.stripDefaultSchema(cls, sortBy);
                 Field f=IntrospectUtil.findFieldFromPath(cls, sortBy);
 
                 if (f==null){   //Not recognized!
                     log.warn("SortBy parameter value '{}' was not recognized as a SCIM attribute for resource {} - sortBy will be ignored.", sortBy, type);
                     sortBy=null;
                     //return getErrorResponse(Response.Status.BAD_REQUEST, ErrorScimType.INVALID_PATH, "sortBy parameter value not recognized");
                 }
                 else {
                     sortBy = FilterUtil.getLdapAttributeOfResourceAttribute(sortBy, cls).getFirst();
                     if (sortBy==null)
                         log.warn("There is no LDAP attribute mapping to sortBy attribute provided - sortBy will be ignored.");
                 }
             }
             else
                 sortBy = sortBy.substring(sortBy.lastIndexOf(":")+1);
         }
         return sortBy;
 
     }

◆ updateUser() [1/2]

Response org.gluu.oxtrust.ws.rs.scim2.IUserWebService.updateUser	(	UserResource	user,
		@PathParam("id") String	id,
		@QueryParam(QUERY_PARAM_ATTRIBUTES) String	attrsList,
		@QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String	excludedAttrsList
	)

inherited

Service method that allows updating a User resource via PUT (as per section 3.5.1 of RFC 7644).

This operation is not suitable to delete/remove/nullify attributes. For this purpose you can use the PATCH operation instead. PUT is intended to do replacements using the (not-null) values supplied in fidoDeviceResource parameter.

To learn more about how the update works, read the replacement rules found at ScimResourceUtil#transferToResourceReplace.

引数

user	An object that contains the data to update on a destination resource. There is no need to supply a full resource, just provide one with the attributes which are intended to be replaced in the destination
id	The "id" attribute of the resource to update (destination)
attrsList	See notes about attributes query param
excludedAttrsList	See notes about excludedAttributes query param

戻り値: An object abstracting the response obtained from the server to this request. A succesful response for this operation should contain a status code of 200 and a UserResource in the entity body (the resource after the update took place)

◆ updateUser() [2/2]

Response org.gluu.oxtrust.ws.rs.scim2.UserWebService.updateUser	(	@ApiParam(value="User", required=true) UserResource	user,
		@PathParam("id") String	id,
		@QueryParam(QUERY_PARAM_ATTRIBUTES) String	attrsList,
		@QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String	excludedAttrsList
	)

inline

This implementation differs from spec in the following aspects:

Passing a null value for an attribute, does not modify the attribute in the destination, however passing an empty array for a multivalued attribute does clear the attribute. Thus, to clear single-valued attribute, PATCH operation should be used

                                                                               {
 
         Response response;
         try {
             log.debug("Executing web service method. updateUser");
             UserResource updatedResource=scim2UserService.updateUser(id, user, endpointUrl);
             String json=resourceSerializer.serialize(updatedResource, attrsList, excludedAttrsList);
             response=Response.ok(new URI(updatedResource.getMeta().getLocation())).entity(json).build();
         }
         catch (InvalidAttributeValueException e){
             log.error(e.getMessage());
             response=getErrorResponse(Response.Status.BAD_REQUEST, ErrorScimType.MUTABILITY, e.getMessage());
         }
         catch (Exception e){
             log.error("Failure at updateUser method", e);
             response=getErrorResponse(Response.Status.INTERNAL_SERVER_ERROR, "Unexpected error: " + e.getMessage());
         }
         return response;
 
     }

メンバ詳解

◆ appConfiguration

AppConfiguration org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.appConfiguration

packageinherited

◆ endpointUrl

String org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.endpointUrl

packageinherited

◆ extService

ExtensionService org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.extService

packageinherited

◆ log

Logger org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.log

packageinherited

◆ personService

IPersonService org.gluu.oxtrust.ws.rs.scim2.UserWebService.personService

private

◆ resourceSerializer

ScimResourceSerializer org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.resourceSerializer

packageinherited

◆ scim2PatchService

Scim2PatchService org.gluu.oxtrust.ws.rs.scim2.UserWebService.scim2PatchService

private

◆ scim2UserService

Scim2UserService org.gluu.oxtrust.ws.rs.scim2.UserWebService.scim2UserService

private

◆ SEARCH_SUFFIX

final String org.gluu.oxtrust.ws.rs.scim2.BaseScimWebService.SEARCH_SUFFIX = ".search"

staticinherited

このクラス詳解は次のファイルから抽出されました:

D:/AppData/OpenId/gluu/src/oxTrust/server/src/main/java/org/gluu/oxtrust/ws/rs/scim2/UserWebService.java

公開メンバ関数

静的公開メンバ関数

静的公開変数類

限定公開メンバ関数

関数

変数

非公開変数類

詳解

関数詳解

◆ assignMetaInformation()

◆ createUser() [1/2]

◆ createUser() [2/2]

◆ deleteUser()

◆ executeDefaultValidation()

◆ executeValidation()

◆ getEndpointUrl()

◆ getErrorResponse() [1/3]

◆ getErrorResponse() [2/3]

◆ getErrorResponse() [3/3]

◆ getListResponseSerialized()

◆ getMaxCount()

◆ getUserById()

◆ getValueFromHeaders()

◆ inspectPatchRequest()

◆ patchUser()

◆ prepareSearchRequest()

◆ searchUsers()

◆ searchUsersPost() [1/2]

◆ searchUsersPost() [2/2]

◆ setup()

◆ translateSortByAttribute()

◆ updateUser() [1/2]

◆ updateUser() [2/2]

メンバ詳解

◆ appConfiguration

◆ endpointUrl

◆ extService

◆ log

◆ personService

◆ resourceSerializer

◆ scim2PatchService

◆ scim2UserService

◆ SEARCH_SUFFIX