org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer クラス

org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer 連携図

公開メンバ関数
String	serialize (BaseScimResource resource, String attributes, String exclusions) throws Exception
String	serialize (BaseScimResource resource) throws Exception
ObjectMapper	getListResponseMapper ()

非公開メンバ関数
Set< String >	expandAttributesPaths (String attributes, String defaultSchemaUrn, List< String > schemas, SortedSet< String > attribs)
void	buildIncludeSet (SortedSet< String > include, Class<? extends BaseScimResource > resourceClass, List< String > schemas, String attributes, String exclussions)
boolean	containsProperty (SortedSet< String > properties, String prefix, String key)
String	getNewPrefix (String prefix, String key)
Map< String, Object >	smallerMap (String prefix, Map< String, Object > value, SortedSet< String > include)
void	traverse (String prefix, Map< String, Object > map, LinkedHashMap< String, Object > destination, SortedSet< String > include)

非公開変数類
Logger	log
ExtensionService	extService
ObjectMapper	mapper =new ObjectMapper()

詳解

Created by jgomer on 2017-10-01.

関数詳解

buildIncludeSet()

void org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.buildIncludeSet ( SortedSet< String >  include, Class<? extends BaseScimResource >  resourceClass, List< String >  schemas, String  attributes, String  exclussions  )

inlineprivate

                                                                                             {

        Set<String> tempSet;
        Set<String> alwaysSet= IntrospectUtil.alwaysCoreAttrs.get(resourceClass).keySet();
        Set<String> neverSet=IntrospectUtil.neverCoreAttrs.get(resourceClass).keySet();
        Set<String> defaultSet=new HashSet<String>();

        //Here we assume all attributes part of extensions have returnability="default"...
        SortedSet<String> extendedSet=new TreeSet<String>();
        for (Extension ext : extService.getResourceExtensions(resourceClass)) {
            extendedSet.add(ext.getUrn());
            extendedSet.addAll(IntrospectUtil.getPathsInExtension(ext));
        }

        defaultSet.addAll(IntrospectUtil.defaultCoreAttrs.get(resourceClass).keySet());
        defaultSet.addAll(extendedSet);

        String defaultSchema=ScimResourceUtil.getDefaultSchemaUrn(resourceClass);

        if (attributes!=null) {
            log.info("buildIncludeSet. Processing attributes query param (excludedAttributes ignored)");

            extendedSet.addAll(IntrospectUtil.allAttrs.get(resourceClass));
            tempSet= expandAttributesPaths(attributes, defaultSchema, schemas, extendedSet);
            tempSet.removeAll(neverSet);
            include.addAll(tempSet);
        }
        else
        if (exclussions!=null){
            log.info("buildIncludeSet. Processing excludedAttributes query param");

            extendedSet.addAll(IntrospectUtil.allAttrs.get(resourceClass));
            tempSet= defaultSet;
            tempSet.removeAll(expandAttributesPaths(exclussions, defaultSchema, schemas, extendedSet));
            include.addAll(tempSet);
        }
        else{
            log.info("buildIncludeSet. No attributes neither excludedAttributes query param were passed");
            include.addAll(defaultSet);
        }
        include.addAll(alwaysSet);

    }

containsProperty()

boolean org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.containsProperty ( SortedSet< String >  properties, String  prefix, String  key  )

inlineprivate

                                                                                             {

        key = key.startsWith("$") ? key.substring(1) : key;     //makes attributes like $ref to be accepted...
        String property = (prefix.length() == 0) ? key : prefix + "." + key;
        Set<String> set=properties.tailSet(property);

        boolean flag=set.contains(property);
        if (!flag){
            for (String prop : set)
                if (prop.startsWith(property + ".")) {
                    flag=true;
                    break;
                }
        }
        return flag;

    }

expandAttributesPaths()

Set<String> org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.expandAttributesPaths ( String  attributes, String  defaultSchemaUrn, List< String >  schemas, SortedSet< String >  attribs  )

inlineprivate

                                                                                                                                           {

        Set<String> set=new HashSet<String>();

        for (String attr : attributes.split(",")) {
            String shorterName=attr.replaceAll("\\s", "");
            set.add(ScimResourceUtil.adjustNotationInPath(shorterName, defaultSchemaUrn, schemas));
        }

        Set<String> enlargedSet =new HashSet<String>();

        //attribs is already sorted
        for (String basicAttr : set){
            enlargedSet.add(basicAttr);

            for (String elem : attribs.tailSet(basicAttr + "."))
                if (elem.startsWith(basicAttr + "."))
                    enlargedSet.add(elem);
                else
                    break;
        }
        //No need for this block: containsProperty method is smart enough
        /*
        //Remove redundancies
        String attrArray[]=list.toArray(new String[]{});
        Arrays.sort(attrArray);
        list=new ArrayList<>();
        int j=0;

        for (int i=0; i<attrArray.length-1;){
            String prevAttr=attrArray[i];
            for (j=i+1;j<attrArray.length && attrArray[j].startsWith(prevAttr + ".");j++);
            i=j;
            list.add(prevAttr);
        }
           */
        return enlargedSet;
    }

getListResponseMapper()

ObjectMapper org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.getListResponseMapper ( )

inline

                                               {

        ObjectMapper mapper = new ObjectMapper();
        SimpleModule module=new SimpleModule("ListResponseModule", Version.unknownVersion());
        module.addSerializer(ListResponse.class, new ListResponseJsonSerializer(this));
        mapper.registerModule(module);

        return mapper;
    }

getNewPrefix()

String org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.getNewPrefix ( String  prefix, String  key  )

inlineprivate

                                                          {
        return prefix + (prefix.length()==0 ? "" : ".") + key;
    }

serialize() [1/2]

String org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.serialize ( BaseScimResource  resource, String  attributes, String  exclusions  ) throws Exception

inline

                                                                                                              {

        SortedSet<String> include = new TreeSet<String>();
        Class<? extends BaseScimResource> resourceClass = resource.getClass();
        buildIncludeSet(include, resourceClass, new ArrayList<String>(resource.getSchemas()), attributes, exclusions);
        log.trace("serialize. Attributes to include: {}", include);

        //Do generic serialization. This works for any POJO (not only subclasses of BaseScimResource)
        Map<String, Object> map = mapper.convertValue(resource, new TypeReference<Map<String, Object>>() { });
        //Using LinkedHashMap allows recursive routines to visit submaps in the same order as fields appear in java classes
        LinkedHashMap<String, Object> newMap = new LinkedHashMap<String, Object>();
        traverse("", map, newMap, include);

        String result = mapper.writeValueAsString(newMap);
        log.trace("serialize. Output is {}", result);

        return result;
    }

serialize() [2/2]

String org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.serialize ( BaseScimResource  resource ) throws Exception

inline

                                                                       {
        return serialize(resource, null, null);
    }

smallerMap()

Map<String, Object> org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.smallerMap ( String  prefix, Map< String, Object >  value, SortedSet< String >  include  )

inlineprivate

                                                                                                               {
        LinkedHashMap<String, Object> smallMap = new LinkedHashMap<String, Object>();
        traverse(prefix, value, smallMap, include);
        return smallMap.size()==0 ? null : smallMap;
    }

traverse()

void org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.traverse ( String  prefix, Map< String, Object >  map, LinkedHashMap< String, Object >  destination, SortedSet< String >  include  )

inlineprivate

Section 2.5 of RFC 7643: When a resource is expressed in JSON format, unassigned attributes, although they are defined in schema, MAY be omitted for compactness

引数

prefix
map
destination
include

                                                                                                                                       {

        for (String key : map.keySet()){
            Object value=map.get(key);

            if (value!=null && containsProperty(include, prefix, key)){

                if (value instanceof Map)
                    value = smallerMap(getNewPrefix(prefix, key), IntrospectUtil.strObjMap(value), include);
                else
                if (IntrospectUtil.isCollection(value.getClass())){
                    List list=new ArrayList();
                    Map<String, Object> innerMap;

                    for (Object item : (Collection) value){
                        if (item!=null)
                            if (item instanceof Map) {
                                innerMap=smallerMap(getNewPrefix(prefix, key), IntrospectUtil.strObjMap(item), include);
                                if (innerMap!=null)
                                    list.add(innerMap);
                            }
                            else {
                                list.add(item);
                            }
                    }
                    value=list;
                }
                if (value!=null)
                    destination.put(key, value);
            }
        }

    }

メンバ詳解

extService

ExtensionService org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.extService

private

log

Logger org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.log

private

mapper

ObjectMapper org.gluu.oxtrust.service.scim2.serialization.ScimResourceSerializer.mapper =new ObjectMapper()

private

---

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

• D:/AppData/OpenId/gluu/src/oxTrust/server/src/main/java/org/gluu/oxtrust/service/scim2/serialization/ScimResourceSerializer.java