org.gluu.oxtrust.ws.rs.scim2.SearchResourcesWebService クラス

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

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

公開メンバ関数
Response	search (@ApiParam(value="SearchRequest", required=true) SearchRequest searchRequest)
void	setup ()
String	getEndpointUrl ()

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

非公開メンバ関数
Pair< Integer, Integer >	computeResults (SearchRequest searchRequest, List< JsonNode > resources) throws Exception
JsonNode	getListResponseTree (int index, SearchRequest searchRequest)

非公開変数類
UserWebService	userWS
GroupWebService	groupWS
FidoDeviceWebService	fidoWS
ObjectMapper	mapper =null
int	NUM_RESOURCE_TYPES
Class	resourceClasses []

詳解

Implementation of the /.search endpoint for the root URL of the service

Created by jgomer on 2017-10-25.

関数詳解

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

    }

computeResults()

Pair<Integer, Integer> org.gluu.oxtrust.ws.rs.scim2.SearchResourcesWebService.computeResults ( SearchRequest  searchRequest, List< JsonNode >  resources  ) throws Exception

inlineprivate

Here we reuse every single POST search found in other web services, but handle serialization differently to a more manual approach for performance reasons. In the end, this saves us 3 deserializations and 3 serializations of multiple results packs. Result set as a whole will not be sorted by sortBy param but every group of resources (by resource type) will be sorted as such

引数

searchRequest
resources

戻り値

                                                                                                                         {

        int i;
        int totalInPage=0, totalResults=0, skip=0;
        boolean resultsAvailable=false;

        Integer startIndex_=searchRequest.getStartIndex();
        JsonNode tree=null;

        //THIS ALGORITHM IS CONTRIVED, IF YOU CHANGE IT ENSURE TEST CASES STILL PASS...

        //Move forward to skip the searches that might have no results and find the first one starting at index = searchRequest.getStartIndex()
        for (i=0; i< NUM_RESOURCE_TYPES && !resultsAvailable; i++) {
            tree=getListResponseTree(i, searchRequest);

            if (tree!=null) {
                totalResults += tree.get("totalResults").asInt();

                if (totalResults>0){

                    if (totalResults>=startIndex_) {
                        resultsAvailable = tree.get("itemsPerPage") != null;    //when null, it means searchRequest.getCount() was zero or empty page

                        if (searchRequest.getStartIndex()==1)
                            skip=startIndex_ - (totalResults - tree.get("totalResults").asInt()) - 1;
                    }
                    searchRequest.setStartIndex(1);     //Adjust startindex of subsequent searches to 1
                }
            }
        }

        if (resultsAvailable){

            //Accumulate till we have searchRequest.getCount() results or exhaust data

            Iterator<JsonNode> iterator = tree.get("Resources").getElements();
            while (iterator.hasNext() && totalInPage < searchRequest.getCount()){
                if (skip==0) {
                    totalInPage++;
                    resources.add(iterator.next());
                }
                else{
                    skip--;
                    iterator.next();
                }
            }

            while (i< NUM_RESOURCE_TYPES && totalInPage < searchRequest.getCount()){

                resultsAvailable=false;
                tree = getListResponseTree(i, searchRequest);
                if (tree!=null) {
                    totalResults += tree.get("totalResults").asInt();

                    if (tree.get("totalResults").asInt() > 0)
                        resultsAvailable = tree.get("itemsPerPage")!=null;
                }

                if (resultsAvailable) {
                    for (iterator = tree.get("Resources").getElements();
                         iterator.hasNext() && totalInPage < searchRequest.getCount();
                         totalInPage++)
                        resources.add(iterator.next());
                }

                i++;
            }

            //Continue the remainder of searches to just compute final value for totalResults
            while (i< NUM_RESOURCE_TYPES){
                tree = getListResponseTree(i, searchRequest);
                if (tree!=null)
                    totalResults += tree.get("totalResults").asInt();
                i++;
            }
        }

        //Revert startIndex to original
        searchRequest.setStartIndex(startIndex_);
        return new Pair<Integer, Integer>(totalInPage, totalResults);

    }

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

    }

getListResponseTree()

JsonNode org.gluu.oxtrust.ws.rs.scim2.SearchResourcesWebService.getListResponseTree ( int  index, SearchRequest  searchRequest  )

inlineprivate

Returns a JsonNode with the response obtained from sending a POST to a search method given the SearchRequest passed

引数

index	Determines the concrete search method to be executed: (0 - user; 1 - group; 2 - fido device)
searchRequest

戻り値

                                                                                {

        try {
            log.debug("getListResponseTree. Resource type is: {}", ScimResourceUtil.getType(resourceClasses[index]));

            Response r = null;
            switch (index) {
                case 0:
                    r = userWS.searchUsersPost(searchRequest);
                    break;
                case 1:
                    r = groupWS.searchGroupsPost(searchRequest);
                    break;
                case 2:
                    r = fidoWS.searchDevicesPost(searchRequest, null);
                    break;
            }

            if (r.getStatus()!=OK.getStatusCode())
                throw new Exception("Intermediate POST search returned " + r.getStatus());

            //readEntity does not work here since data is not backed by an input stream, so we just get the raw entity
            String jsonStr = r.getEntity().toString();
            return mapper.readTree(jsonStr);
        }
        catch (Exception e){
            log.error("Error in getListResponseTree {}", e.getMessage());
            log.error(e.getMessage(), e);
            return null;
        }

    }

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;

    }

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;

    }

search()

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

inline

                                                                                                            {

        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) {
            try {
                List<JsonNode> resources = new ArrayList<JsonNode>();
                Pair<Integer, Integer> totals = computeResults(searchReq, resources);

                ListResponseJsonSerializer custSerializer = new ListResponseJsonSerializer(resourceSerializer, searchReq.getAttributesStr(),
                        searchReq.getExcludedAttributesStr(), searchReq.getCount() == 0);
                if (resources.size() > 0)
                    custSerializer.setJsonResources(resources);

                ObjectMapper objmapper = new ObjectMapper();
                SimpleModule module = new SimpleModule("ListResponseModule", Version.unknownVersion());
                module.addSerializer(ListResponse.class, custSerializer);
                objmapper.registerModule(module);

                //Provide to constructor original start index, and totals calculated in computeResults call
                ListResponse listResponse = new ListResponse(searchReq.getStartIndex(), totals.getFirst(), totals.getSecond());
                String json = objmapper.writeValueAsString(listResponse);
                response = Response.ok(json).location(new URI(endpointUrl)).build();
            }
            catch (Exception e){
                log.error("Failure at search method", e);
                response=getErrorResponse(Response.Status.INTERNAL_SERVER_ERROR, "Unexpected error: " + e.getMessage());
            }
        }
        return response;

    }

setup()

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

inline

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

        //Do not alter the order of appearance
        resourceClasses=new Class[]{UserResource.class, GroupResource.class, FidoDeviceResource.class};
        NUM_RESOURCE_TYPES =resourceClasses.length;
    }

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;

    }

メンバ詳解

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

fidoWS

FidoDeviceWebService org.gluu.oxtrust.ws.rs.scim2.SearchResourcesWebService.fidoWS

private

groupWS

GroupWebService org.gluu.oxtrust.ws.rs.scim2.SearchResourcesWebService.groupWS

private

log

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

packageinherited

mapper

ObjectMapper org.gluu.oxtrust.ws.rs.scim2.SearchResourcesWebService.mapper =null

private

NUM_RESOURCE_TYPES

int org.gluu.oxtrust.ws.rs.scim2.SearchResourcesWebService.NUM_RESOURCE_TYPES

private

resourceClasses

Class org.gluu.oxtrust.ws.rs.scim2.SearchResourcesWebService.resourceClasses[]

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

userWS

UserWebService org.gluu.oxtrust.ws.rs.scim2.SearchResourcesWebService.userWS

private

---

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

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