org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator の継承関係図

org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator 連携図

公開メンバ関数
Response	createGroup (GroupResource group, String attrsList, String excludedAttrsList)

Response	getGroupById (String id, String attrsList, String excludedAttrsList)

Response	updateGroup (GroupResource group, String id, String attrsList, String excludedAttrsList)

Response	deleteGroup (String id)

Response	searchGroups (String filter, Integer startIndex, Integer count, String sortBy, String sortOrder, String attrsList, String excludedAttrsList)

Response	searchGroupsPost (SearchRequest searchRequest)

Response	patchGroup (PatchRequest request, String id, String attrsList, String excludedAttrsList)

String	getEndpointUrl ()

Response	createGroup (GroupResource group, @QueryParam(QUERY_PARAM_ATTRIBUTES) String attrsList, @QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String excludedAttrsList)

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

Response	updateGroup (GroupResource group, @PathParam("id") String id, @QueryParam(QUERY_PARAM_ATTRIBUTES) String attrsList, @QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String excludedAttrsList)

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

Response	searchGroups ( @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	patchGroup (PatchRequest request, @PathParam("id") String id, @QueryParam(QUERY_PARAM_ATTRIBUTES) String attrsList, @QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String excludedAttrsList)

静的公開メンバ関数
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

変数
IGroupWebService	service

AppConfiguration	appConfiguration

ScimResourceSerializer	resourceSerializer

ExtensionService	extService

String	endpointUrl

非公開メンバ関数
Response	validateExistenceOfGroup (String id)

void	checkDisplayNameExistence (String displayName) throws DuplicateEntryException

void	checkDisplayNameExistence (String displayName, String id) throws DuplicateEntryException

非公開変数類
Logger	log

IGroupService	groupService

詳解

Aims at decorating SCIM group service methods. Currently applies validations via ResourceValidator class or other custom validation logic

Created by jgomer on 2017-10-18.

関数詳解

◆ 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);
 
     }

◆ checkDisplayNameExistence() [1/2]

void org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.checkDisplayNameExistence ( String displayName ) throws DuplicateEntryException

inlineprivate

                                                                                              {
 
         boolean flag=false;
         try {
             flag=groupService.getGroupByDisplayName(displayName) != null;
         }
         catch (Exception e){
             log.error(e.getMessage(), e);
         }
         if (flag)
             throw new DuplicateEntryException("Duplicate group displayName value: " + displayName);
 
     }

◆ checkDisplayNameExistence() [2/2]

void org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.checkDisplayNameExistence	(	String	displayName,
		String	id
	)		throws DuplicateEntryException

inlineprivate

                                                                                                         {
         //Validate if there is an attempt to supply a displayName already in use by a group other than current
 
         GluuGroup groupToFind = new GluuGroup();
         groupToFind.setDisplayName(displayName);
 
         List<GluuGroup> list=groupService.findGroups(groupToFind,2 );
         if (list!=null){
             for (GluuGroup g : list)
                 if (!g.getInum().equals(id))
                     throw new DuplicateEntryException("Duplicate group displayName value: " + displayName);
         }
 
     }

◆ createGroup() [1/2]

Response org.gluu.oxtrust.ws.rs.scim2.IGroupWebService.createGroup	(	GroupResource	group,
		@QueryParam(QUERY_PARAM_ATTRIBUTES) String	attrsList,
		@QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String	excludedAttrsList
	)

inherited

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

引数

group	An object that represents the Group 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 GroupResource in the entity body (the resource just created)

◆ createGroup() [2/2]

Response org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.createGroup	(	GroupResource	group,
		String	attrsList,
		String	excludedAttrsList
	)

inline

                                                                                                 {
 
         Response response;
         try {
             //empty externalId, no place to store it in LDAP
             group.setExternalId(null);
 
             executeDefaultValidation(group);
             checkDisplayNameExistence(group.getDisplayName());
             assignMetaInformation(group);
             //Proceed with actual implementation of createGroup method
             response=service.createGroup(group, attrsList, excludedAttrsList);
         }
         catch (DuplicateEntryException e){
             log.error(e.getMessage());
             response=getErrorResponse(Response.Status.CONFLICT, ErrorScimType.UNIQUENESS, e.getMessage());
         }
         catch (SCIMException e){
             log.error("Validation check at createGroup returned: {}", e.getMessage());
             response = getErrorResponse(Response.Status.BAD_REQUEST, ErrorScimType.INVALID_VALUE, e.getMessage());
         }
         return response;
 
     }

◆ deleteGroup() [1/2]

Response org.gluu.oxtrust.ws.rs.scim2.IGroupWebService.deleteGroup ( @PathParam("id") String id )

inherited

Removes a Group via DELETE HTTP method (see section 3.6 of RFC 7644).

引数

id	The "id" attribute of the resource to be removed

戻り値: An object abstracting the response obtained from the server to this request. A succesful response for this operation should contain a status code of 204 (no content)

org.gluu.oxtrust.ws.rs.scim2.GroupWebServiceで実装されています。

◆ deleteGroup() [2/2]

Response org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.deleteGroup ( String id )

inline

                                           {
 
         Response response=validateExistenceOfGroup(id);
         if (response==null)
             //Proceed with actual implementation of deleteGroup method
             response= service.deleteGroup(id);
 
         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();
     }

◆ getGroupById() [1/2]

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

inherited

Service method that retrieves a Group resource using GET (as per section 3.4.1 of RFC 7644).

引数

id	The "id" attribute of the resource to retrieve
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 GroupResource in the entity body (the resource retrieved)

org.gluu.oxtrust.ws.rs.scim2.GroupWebServiceで実装されています。

◆ getGroupById() [2/2]

Response org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.getGroupById	(	String	id,
		String	attrsList,
		String	excludedAttrsList
	)

inline

                                                                                        {
 
         Response response=validateExistenceOfGroup(id);
         if (response==null)
             //Proceed with actual implementation of getGroupById method
             response=service.getGroupById(id, attrsList, excludedAttrsList);
 
         return response;
 
     }

◆ 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();
     }

◆ 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;
 
     }

◆ patchGroup() [1/2]

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

inherited

Service method that allows to modify a Group resource via PATCH (see section 3.5.2 of RFC 7644).

Note that patching offers a fine-grained control over the attributes to modify. While PUT is more intended to replace attribute values, PATCH allows to perform localized updates, removals and additions in certain portions of the target resource.

引数

request	A `PatchRequest` that contains the operations to apply upon the resource being updated
id	The id of the resource to update
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 GroupResource in the entity body (the resource after modifications took place)

org.gluu.oxtrust.ws.rs.scim2.GroupWebServiceで実装されています。

◆ patchGroup() [2/2]

Response org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.patchGroup	(	PatchRequest	request,
		String	id,
		String	attrsList,
		String	excludedAttrsList
	)

inline

                                                                                                            {
 
         Response response=inspectPatchRequest(request, GroupResource.class);
         if (response==null) {
             response=validateExistenceOfGroup(id);
 
             if (response==null)
                 response = service.patchGroup(request, id, attrsList, excludedAttrsList);
         }
         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;
 
     }

◆ searchGroups() [1/2]

Response org.gluu.oxtrust.ws.rs.scim2.IGroupWebService.searchGroups	(	@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
	)

inherited

Sends a search query for Group resources using GET (see section 3.4.2 of RFC 7644).

引数

filter	A filter expression so that the search will return only those resources matching the expression. To learn more about SCIM filter expressions and operators, see section 3.4.2.2 of RFC 7644.
startIndex	The 1-based index of the first query result. If a negative integer or null is provided, the search is performed as if 1 was provided as value.
count	Specifies the desired maximum number of query results per page the response must include. If null is provided, the maximum supported by the server is used. If count is zero, this is interpreted as no results should be included (only the total amount is). If a negative number is supplied, the search is performed as if zero was provided as value.
sortBy	Specifies the attribute whose value will be used to order the returned resources. If sortBy is null the results will be sorted by userName attribute.
sortOrder	The order in which the `sortBy` parameter is applied. Allowed values are "ascending" or "descending", being "ascending" the default if null or an unknown value is passed.
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 ListResponse in the entity body (holding a collection of SCIM resources)

org.gluu.oxtrust.ws.rs.scim2.GroupWebServiceで実装されています。

◆ searchGroups() [2/2]

Response org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.searchGroups	(	String	filter,
		Integer	startIndex,
		Integer	count,
		String	sortBy,
		String	sortOrder,
		String	attrsList,
		String	excludedAttrsList
	)

inline

                                                                             {
 
         SearchRequest searchReq=new SearchRequest();
         Response response=prepareSearchRequest(searchReq.getSchemas(), filter, sortBy, sortOrder, startIndex, count,
                             attrsList, excludedAttrsList, searchReq);
 
         if (response==null) {
             response = service.searchGroups(searchReq.getFilter(), searchReq.getStartIndex(), searchReq.getCount(),
                         searchReq.getSortBy(), searchReq.getSortOrder(), searchReq.getAttributesStr(), searchReq.getExcludedAttributesStr());
         }
         return response;
 
     }

◆ searchGroupsPost()

Response org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.searchGroupsPost ( SearchRequest searchRequest )

inline

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

                                                                  {
 
         SearchRequest searchReq=new SearchRequest();
         Response response=prepareSearchRequest(searchRequest.getSchemas(), searchRequest.getFilter(), searchRequest.getSortBy(),
                 searchRequest.getSortOrder(), searchRequest.getStartIndex(), searchRequest.getCount(),
                 searchRequest.getAttributesStr(), searchRequest.getExcludedAttributesStr(), searchReq);
 
         if (response==null) {
             response = service.searchGroupsPost(searchReq);
         }
         return response;
 
     }

◆ 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;
 
     }

◆ updateGroup() [1/2]

Response org.gluu.oxtrust.ws.rs.scim2.IGroupWebService.updateGroup	(	GroupResource	group,
		@PathParam("id") String	id,
		@QueryParam(QUERY_PARAM_ATTRIBUTES) String	attrsList,
		@QueryParam(QUERY_PARAM_EXCLUDED_ATTRS) String	excludedAttrsList
	)

inherited

Service method that allows updating a Group 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.

引数

group	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 GroupResource in the entity body (the resource after the update took place)

◆ updateGroup() [2/2]

Response org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.updateGroup	(	GroupResource	group,
		String	id,
		String	attrsList,
		String	excludedAttrsList
	)

inline

                                                                                                            {
 
         Response response;
         try{
             //empty externalId, no place to store it in LDAP
             group.setExternalId(null);
 
             //Check if the ids match in case the group coming has one
             if (group.getId()!=null && !group.getId().equals(id))
                 throw new SCIMException("Parameter id does not match with id attribute of Group");
 
             response=validateExistenceOfGroup(id);
             if (response==null) {
 
                 executeValidation(group, true);
                 if (StringUtils.isNotEmpty(group.getDisplayName()))
                     checkDisplayNameExistence(group.getDisplayName(), id);
 
                 //Proceed with actual implementation of updateGroup method
                 response = service.updateGroup(group, id, attrsList, excludedAttrsList);
             }
         }
         catch (DuplicateEntryException e){
             log.error(e.getMessage());
             response=getErrorResponse(Response.Status.CONFLICT, ErrorScimType.UNIQUENESS, e.getMessage());
         }
         catch (SCIMException e){
             log.error("Validation check at updateGroup returned: {}", e.getMessage());
             response = getErrorResponse(Response.Status.BAD_REQUEST, ErrorScimType.INVALID_VALUE, e.getMessage());
         }
         return response;
     }

◆ validateExistenceOfGroup()

Response org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.validateExistenceOfGroup ( String id )

inlineprivate

                                                         {
 
         Response response=null;
         GluuGroup group = StringUtils.isEmpty(id) ? null : groupService.getGroupByInum(id);
 
         if (group==null) {
             log.info("Group with inum {} not found", id);
             response = getErrorResponse(Response.Status.NOT_FOUND, "Resource " + id + " not found");
         }
         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

◆ groupService

IGroupService org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.groupService

private

◆ log

Logger org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.log

private

◆ resourceSerializer

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

packageinherited

◆ SEARCH_SUFFIX

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

staticinherited

◆ service

IGroupWebService org.gluu.oxtrust.service.scim2.interceptor.GroupWebServiceDecorator.service

package

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

D:/AppData/OpenId/gluu/src/oxTrust/server/src/main/java/org/gluu/oxtrust/service/scim2/interceptor/GroupWebServiceDecorator.java

公開メンバ関数

静的公開メンバ関数

静的公開変数類

限定公開メンバ関数

関数

変数

非公開メンバ関数

非公開変数類

詳解

関数詳解

◆ assignMetaInformation()

◆ checkDisplayNameExistence() [1/2]

◆ checkDisplayNameExistence() [2/2]

◆ createGroup() [1/2]

◆ createGroup() [2/2]

◆ deleteGroup() [1/2]

◆ deleteGroup() [2/2]

◆ executeDefaultValidation()

◆ executeValidation()

◆ getEndpointUrl()

◆ getErrorResponse() [1/3]

◆ getErrorResponse() [2/3]

◆ getErrorResponse() [3/3]

◆ getGroupById() [1/2]

◆ getGroupById() [2/2]

◆ getListResponseSerialized()

◆ getMaxCount()

◆ getValueFromHeaders()

◆ inspectPatchRequest()

◆ patchGroup() [1/2]

◆ patchGroup() [2/2]

◆ prepareSearchRequest()

◆ searchGroups() [1/2]

◆ searchGroups() [2/2]

◆ searchGroupsPost()

◆ translateSortByAttribute()

◆ updateGroup() [1/2]

◆ updateGroup() [2/2]

◆ validateExistenceOfGroup()

メンバ詳解

◆ appConfiguration

◆ endpointUrl

◆ extService

◆ groupService

◆ log

◆ resourceSerializer

◆ SEARCH_SUFFIX

◆ service