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

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

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

公開メンバ関数
Response	serve ()
Response	getSchemaById (@PathParam("schemaUrn") String urn)
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

非公開メンバ関数
SchemaResource	getSchemaInstance (Class<? extends BaseScimResource > clazz) throws Exception
SchemaResource	getSchemaInstance (Class<? extends BaseScimResource > clazz, String urn) throws Exception

非公開変数類
Map< String, Class<? extends BaseScimResource > >	resourceSchemas

詳解

Web service for the /Schemas endpoint.

著者

Val Pecaoco Re-engineered by jgomer on 2017-09-27.

関数詳解

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

    }

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

getSchemaById()

Response org.gluu.oxtrust.ws.rs.scim2.SchemaWebService.getSchemaById ( @PathParam("schemaUrn") String  urn )

inline

                                                                     {

        Response response;
        try {
            Class<? extends BaseScimResource> cls = resourceSchemas.get(urn);

            if (cls==null){
                log.info("Schema urn {} not recognized", urn);
                response=Response.status(Response.Status.NOT_FOUND).build();
            }
            else {
                String json=resourceSerializer.serialize(getSchemaInstance(cls, urn));
                URI location = new URI(endpointUrl + "/" + urn);
                response = Response.ok(json).location(location).build();
            }
        }
        catch (Exception e){
            log.error("Failure at getSchemaById method", e);
            response=getErrorResponse(Response.Status.INTERNAL_SERVER_ERROR, "Unexpected error: " + e.getMessage());
        }
        return response;
    }

getSchemaInstance() [1/2]

SchemaResource org.gluu.oxtrust.ws.rs.scim2.SchemaWebService.getSchemaInstance ( Class<? extends BaseScimResource >  clazz ) throws Exception

inlineprivate

                                                                                                      {

        SchemaResource resource;
        Class<? extends BaseScimResource> schemaCls=SchemaResource.class;
        Schema annotation=ScimResourceUtil.getSchemaAnnotation(clazz);
        if (!clazz.equals(schemaCls) && annotation!=null){

            Meta meta=new Meta();
            meta.setResourceType(ScimResourceUtil.getType(schemaCls));
            meta.setLocation(endpointUrl + "/" + annotation.id());

            resource=new SchemaResource();
            resource.setId(annotation.id());
            resource.setName(annotation.name());
            resource.setDescription(annotation.description());
            resource.setMeta(meta);

            List<SchemaAttribute> attribs=new ArrayList<SchemaAttribute>();
            //paths are, happily alphabetically sorted :)
            for (String path : IntrospectUtil.allAttrs.get(clazz)){
                SchemaAttribute schAttr=new SchemaAttribute();
                Field f=IntrospectUtil.findFieldFromPath(clazz, path);

                Attribute attrAnnot=f.getAnnotation(Attribute.class);
                if (attrAnnot!=null) {
                    JsonProperty jsonAnnot=f.getAnnotation(JsonProperty.class);

                    schAttr.setName(jsonAnnot==null ? f.getName() : jsonAnnot.value());
                    schAttr.setType(attrAnnot.type().getName());
                    schAttr.setMultiValued(!attrAnnot.multiValueClass().equals(NullType.class) || IntrospectUtil.isCollection(f.getType()));
                    schAttr.setDescription(attrAnnot.description());
                    schAttr.setRequired(attrAnnot.isRequired());

                    schAttr.setCanonicalValues(attrAnnot.canonicalValues().length==0 ? null : Arrays.asList(attrAnnot.canonicalValues()));
                    schAttr.setCaseExact(attrAnnot.isCaseExact());
                    schAttr.setMutability(attrAnnot.mutability().getName());
                    schAttr.setReturned(attrAnnot.returned().getName());
                    schAttr.setUniqueness(attrAnnot.uniqueness().getName());
                    schAttr.setReferenceTypes(attrAnnot.referenceTypes().length==0 ? null : Arrays.asList(attrAnnot.referenceTypes()));

                    if (attrAnnot.type().equals(AttributeDefinition.Type.COMPLEX))
                        schAttr.setSubAttributes(new ArrayList<SchemaAttribute>());

                    List<SchemaAttribute> list=attribs;     //root list
                    String parts[]=path.split("\\.");

                    for (int i=0;i<parts.length-1;i++) {    //skip last part (real attribute name)
                        int j = list.indexOf(new SchemaAttribute(parts[i]));
                        list = list.get(j).getSubAttributes();
                    }

                    list.add(schAttr);
                }
            }
            resource.setAttributes(attribs);
        }
        else
            resource=null;

        return resource;
    }

getSchemaInstance() [2/2]

SchemaResource org.gluu.oxtrust.ws.rs.scim2.SchemaWebService.getSchemaInstance ( Class<? extends BaseScimResource >  clazz, String  urn  ) throws Exception

inlineprivate

                                                                                                                  {

        if (ScimResourceUtil.getDefaultSchemaUrn(clazz).equals(urn))
            return getSchemaInstance(clazz);    //Process core attributes
        else{   //process extension attributes
            SchemaResource resource=null;
            Class<? extends BaseScimResource> schemaCls=SchemaResource.class;

            //Find the appropriate extension
            List<Extension> extensions=extService.getResourceExtensions(clazz);
            for (Extension extension : extensions) {
                if (extension.getUrn().equals(urn)) {

                    Meta meta = new Meta();
                    meta.setResourceType(ScimResourceUtil.getType(schemaCls));
                    meta.setLocation(endpointUrl + "/" + urn);

                    resource = new SchemaResource();
                    resource.setId(urn);
                    resource.setName(extension.getName());
                    resource.setDescription(extension.getDescription());
                    resource.setMeta(meta);

                    List<SchemaAttribute> attribs = new ArrayList<SchemaAttribute>();

                    for (ExtensionField field : extension.getFields().values()) {
                        SchemaAttribute schAttr = new SchemaAttribute();

                        schAttr.setName(field.getName());
                        schAttr.setMultiValued(field.isMultiValued());
                        schAttr.setDescription(field.getDescription());
                        schAttr.setRequired(false);

                        schAttr.setCanonicalValues(null);
                        schAttr.setCaseExact(false);
                        schAttr.setMutability(AttributeDefinition.Mutability.READ_WRITE.getName());
                        schAttr.setReturned(AttributeDefinition.Returned.DEFAULT.getName());
                        schAttr.setUniqueness(AttributeDefinition.Uniqueness.NONE.getName());
                        schAttr.setReferenceTypes(null);

                        AttributeDefinition.Type type = field.getAttributeDefinitionType();
                        schAttr.setType(type==null ? null : type.getName());
                        schAttr.setSubAttributes(null);

                        attribs.add(schAttr);
                    }

                    resource.setAttributes(attribs);
                    break;
                }
            }
            return resource;
        }
    }

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;

    }

serve()

Response org.gluu.oxtrust.ws.rs.scim2.SchemaWebService.serve ( )

inline

                           {

        Response response;
        try {
            int total = resourceSchemas.size();
            ListResponse listResponse = new ListResponse(1, total, total);

            for (String urn : resourceSchemas.keySet()){
                listResponse.addResource(getSchemaInstance(resourceSchemas.get(urn), urn));
            }
            String json=resourceSerializer.getListResponseMapper().writeValueAsString(listResponse);
            response=Response.ok(json).location(new URI(endpointUrl)).build();
        }
        catch (Exception e){
            log.error("Failure at serve method", e);
            response=getErrorResponse(Response.Status.INTERNAL_SERVER_ERROR, "Unexpected error: " + e.getMessage());
        }
        return response;
    }

setup()

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

inline

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

        List<Class<? extends BaseScimResource>> excludedResources=Arrays.asList(SchemaResource.class, ResourceType.class, ServiceProviderConfig.class);
        resourceSchemas=new HashMap<String, Class<? extends BaseScimResource>>();

        //Fill map with urn vs. resource
        for (Class<? extends BaseScimResource> cls : IntrospectUtil.allAttrs.keySet()){
            if (!excludedResources.contains(cls)) {
                resourceSchemas.put(ScimResourceUtil.getDefaultSchemaUrn(cls), cls);

                for (Extension extension : extService.getResourceExtensions(cls))
                    resourceSchemas.put(extension.getUrn(), cls);
            }
        }

    }

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

log

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

packageinherited

resourceSchemas

Map<String, Class<? extends BaseScimResource> > org.gluu.oxtrust.ws.rs.scim2.SchemaWebService.resourceSchemas

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

---

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

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