org.gluu.oxtrust.model.scim2.util.ScimResourceUtil 連携図

静的公開メンバ関数
static BaseScimResource	transferToResourceReplace (BaseScimResource replacementDataSource, BaseScimResource originalDataSource, List< Extension > extensions) throws InvalidAttributeValueException

static BaseScimResource	transferToResourceAdd (BaseScimResource replacementDataSource, BaseScimResource originalDataSource, List< Extension > extensions) throws InvalidAttributeValueException

static BaseScimResource	deleteFromResource (BaseScimResource origin, String path, List< Extension > extensions) throws InvalidAttributeValueException

static Schema	getSchemaAnnotation (Class<? extends BaseScimResource > cls)

static String	getDefaultSchemaUrn (Class<? extends BaseScimResource > cls)

static String	stripDefaultSchema (Class<? extends BaseScimResource > cls, String attribute)

static String	getType (Class<? extends BaseScimResource > cls)

static String	adjustNotationInPath (String path, String defaultUrn, List< String > schemas)

static String []	splitPath (String path, List< String > urns)

static void	adjustPrimarySubAttributes (BaseScimResource resource)

非公開メンバ関数
	ScimResourceUtil ()

静的非公開メンバ関数
static void	attachExtensionInfo (Map< String, Object > source, Map< String, Object > destination, List< Extension > extensions, boolean replacing)

static void	deleteCustomAttribute (Map< String, Object > source, String path, List< Extension > extensions)

static BaseScimResource	transferToResource (BaseScimResource origin, final BaseScimResource destination, List< Extension > extensions, boolean replacing) throws InvalidAttributeValueException

静的非公開変数類
static Logger	log = LogManager.getLogger(ScimResourceUtil.class)

static ObjectMapper	mapper =new ObjectMapper()

詳解

This class contains methods to facilitate transformation, and manipulation of data inside SCIM resource objects, as well as some miscelaneous routines.

構築子と解体子

◆ ScimResourceUtil()

org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.ScimResourceUtil ( )

inlineprivate

173 {}

関数詳解

◆ adjustNotationInPath()

static String org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.adjustNotationInPath	(	String	path,
		String	defaultUrn,
		List< String >	schemas
	)

inlinestatic

                                                                                                    {
 
         for (String urn : schemas){
             if (path.startsWith(urn + ":")) {
                 if (urn.equals(defaultUrn))
                     path = path.substring(urn.length()+1);
                 else
                     path = path.substring(0, urn.length()) + "." + path.substring(urn.length()+1);
             }
         }
         return path;
 
     }

◆ adjustPrimarySubAttributes()

static void org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.adjustPrimarySubAttributes ( BaseScimResource resource )

inlinestatic

Takes a SCIM resource and "fixes" inconsistencies in "primary" subattribute: in a multivalued attribute setting, only one of the items in the collection can have "primary" : true. Thus, for every collection involved (e.g. addresses, emails... in org.gluu.oxtrust.model.scim2.user.UserResource), it switches all occurrences where "primary" is currently true to false, except for the first one found.

引数

resource SCIM resource object

                                                                             {
 
         String fragment=".primary";
         Class<? extends BaseScimResource> cls=resource.getClass();
 
         //parents will contain the parent path (and associated getter list) where there are primary subattrs, e.g. emails,
         //ims... if we are talking about users
         List<String> parents=new ArrayList<String>();
         for (String path : IntrospectUtil.allAttrs.get(cls))
             if (path.endsWith(fragment))
                 parents.add(path.substring(0, path.length() - fragment.length()));
 
         List<Map<String,List<Method>>> niceList=Arrays.asList(IntrospectUtil.defaultCoreAttrs.get(cls),
                 IntrospectUtil.neverCoreAttrs.get(cls), IntrospectUtil.alwaysCoreAttrs.get(cls));
 
         log.info("adjustPrimarySubAttributes. Revising \"primary\":true uniqueness constraints");
         for (String path : parents){
             //Searh path in the maps
             for (Map<String,List<Method>> niceMap : niceList) {
                 try {
                     if (niceMap.containsKey(path)) {
                         //Here we will get a singleton list that contains the multivalued complex objects (or an empty one at least)
                         List<Object> list = IntrospectUtil.getAttributeValues(resource, niceMap.get(path));
                         if (list.size()>0){
                             list=(List<Object>) list.get(0);
 
                             if (list!=null && list.size()>1) {  //Ensure is not empty or singleton
                                 Class clz = list.get(0).getClass();     //All items are supposed to belong to the same class
                                 //Find getter and setter of "primary" property
                                 Method setter = IntrospectUtil.getSetter(fragment.substring(1), clz);
                                 Method getter = IntrospectUtil.getGetter(fragment.substring(1), clz);
                                 int trues = 0;
 
                                 for (Object item : list) {
                                     Object primaryVal = getter.invoke(item);
                                     trues += primaryVal != null && primaryVal.toString().equals("true") ? 1 : 0;
                                     if (trues > 1) {  //Revert to false
                                         setter.invoke(item, false);
                                         log.info("adjustPrimarySubAttributes. Setting primary = false for an item (a previous one was already primary = true)");
                                     }
                                 }
                             }
                         }
                         break;  //skip the rest of nicemaps
                     }
                 }
                 catch (Exception e){
                     log.error(e.getMessage(), e);
                 }
             }
         }
 
     }

◆ attachExtensionInfo()

static void org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.attachExtensionInfo	(	Map< String, Object >	source,
		Map< String, Object >	destination,
		List< Extension >	extensions,
		boolean	replacing
	)

inlinestaticprivate

                                                                                                                                                        {
 
         log.debug("attachExtensionInfo");
 
         for (Extension extension : extensions){
             String urn=extension.getUrn();
             Object extendedAttrsObj=source.get(urn);
 
             if (extendedAttrsObj!=null){
 
                 Map<String, Object> extendedAttrs=IntrospectUtil.strObjMap(extendedAttrsObj);
                 Map<String, ExtensionField> fields=extension.getFields();
 
                 Map<String, Object> destMap = destination.get(urn)==null ? new HashMap<String, Object>() : IntrospectUtil.strObjMap(destination.get(urn));
 
                 for (String attr : fields.keySet()){
                     Object value=extendedAttrs.get(attr);
 
                     if (value!=null) {
 
                         if (IntrospectUtil.isCollection(value.getClass())) {
                             Collection col = (Collection) value;
 
                             if (!replacing){
                                 Object destValue=destMap.get(attr);
                                 if (destValue != null) {
 
                                     if (!IntrospectUtil.isCollection(destValue.getClass()))
                                         log.warn("Value {} was expected to be a collection", destValue);
                                     else
                                         col.addAll((Collection) destMap.get(attr));
                                 }
                             }
                             value = col.size()==0 ? null : col;
                         }
                         destMap.put(attr, value);
                     }
                 }
                 destination.put(urn, destMap);
             }
         }
 
     }

◆ deleteCustomAttribute()

static void org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.deleteCustomAttribute	(	Map< String, Object >	source,
		String	path,
		List< Extension >	extensions
	)

inlinestaticprivate

                                                                                                                   {
 
         //All custom attributes are non-complex so we must search for the last dot
         int i=path.lastIndexOf(".");
         if (i==-1)
             log.warn("Path not recognized {}", path);
         else {
             String key = path.substring(i+1);
             path=path.substring(0,i);
 
             for (Extension ext : extensions)
                 if (ext.getUrn().equals(path)){
                     Map<String, Object> submap=IntrospectUtil.strObjMap(source.get(path));
                     submap.remove(key);
                 }
 
         }
     }

◆ deleteFromResource()

static BaseScimResource org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.deleteFromResource	(	BaseScimResource	origin,
		String	path,
		List< Extension >	extensions
	)		throws InvalidAttributeValueException

inlinestatic

Returns a SCIM resource with the same data found in origin object, except for the attribute referenced by path being removed from the output. In other words, this method nullifies an attribute.

引数

origin	The resource having the the original data
path	An attribute path (in dot notation). Examples could be: `displayName, emails.type, addresses, meta.lastModified`.
extensions	A list of `Extension`s associated to `origin` Object

戻り値: The resulting object: data in origin without the attribute referenced by path

例外

InvalidAttributeValueException If there is an attempt to remove an attribute annotated as required or read-only

                                                   {
 
         Field f=IntrospectUtil.findFieldFromPath(origin.getClass(), path);
         if (f!=null){
             Attribute attrAnnot = f.getAnnotation(Attribute.class);
             if (attrAnnot != null && (attrAnnot.mutability().equals(READ_ONLY) || attrAnnot.isRequired()))
                 throw new InvalidAttributeValueException("Cannot remove read-only or required attribute " + path);
         }
 
         Map<String, Object> map = mapper.convertValue(origin, new TypeReference<Map<String,Object>>(){});
         traversalClass tclass=new traversalClass(origin.getClass());
 
         if (f==null)    //Extensions stuff
             deleteCustomAttribute(map, path, extensions);
         else
             tclass.traverseDelete(map, path);
 
         return mapper.convertValue(map, origin.getClass());
 
     }

◆ getDefaultSchemaUrn()

static String org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.getDefaultSchemaUrn ( Class<? extends BaseScimResource > cls )

inlinestatic

Returns the urn associated to the default schema of the SCIM resource whose class is passed as parameter.

引数

cls	A class representing a SCIM resource

戻り値: The urn (obtained by calling Schema#id() on the appropriate Schema annotation) or null if there is no such annotation in the class cls

                                                                                    {
         Schema schema=getSchemaAnnotation(cls);
         return schema==null ? null : schema.id();
     }

◆ getSchemaAnnotation()

static Schema org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.getSchemaAnnotation ( Class<? extends BaseScimResource > cls )

inlinestatic

Returns the Schema annotation found in the class passed as parameter.

引数

cls	A class representing a SCIM resource

戻り値: The annotation found or null if there is no such

                                                                                    {
         return cls.getAnnotation(Schema.class);
     }

◆ getType()

static String org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.getType ( Class<? extends BaseScimResource > cls )

inlinestatic

Returns the (human-readable) type of a SCIM resource based on its class. In practice this will be something like "User" or "Group". The type is obtained by calling Schema#name() of the respective class annotation.

引数

cls	A class that represents a SCIM resource type

戻り値: A string with the proper value, or null if there is no Schema annotation found

                                                                        {
         Schema annot=ScimResourceUtil.getSchemaAnnotation(cls);
         return annot==null ? null : annot.name();
     }

◆ splitPath()

static String [] org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.splitPath	(	String	path,
		List< String >	urns
	)

inlinestatic

                                                                     {
 
         String prefix="";
         for (String urn : urns)
             if (path.startsWith(urn)){
                 prefix=urn;
                 break;
             }
 
         if (prefix.length()>0) {
 
             List<String> pieces=new ArrayList<String>();
             pieces.add(prefix);
 
             path=path.substring(prefix.length());
 
             if (path.length()>0) {
                 String subpath=path.substring(path.startsWith(".") ? 1 : 0);
                 pieces.addAll(Arrays.asList(subpath.split("\\.")));
             }
             return pieces.toArray(new String[]{});
         }
         else
             return path.split("\\.");
 
     }

◆ stripDefaultSchema()

static String org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.stripDefaultSchema	(	Class<? extends BaseScimResource >	cls,
		String	attribute
	)

inlinestatic

Removes from an attribute path the schema urn that might prefix such path. The urn to remove will correspond to the default schema urn of a SCIM resource type whose class is passed as parameter.

引数

cls	A class that represents a SCIM resource type
attribute	An attribute path (potentially prefixed by a `urn`)

戻り値: The attribute with no prefix. As an example, attribute_name is returned if urn:attribute_name is the value of attribute parameter (as long as urn represent the default urn for this resource)

                                                                                                     {
 
         String val=attribute;
         String defaultSchema=getDefaultSchemaUrn(cls);
         if (StringUtils.isNotEmpty(attribute) && StringUtils.isNotEmpty(defaultSchema)) {
             if (attribute.startsWith(defaultSchema + ":"))
                 val = attribute.substring(defaultSchema.length() +1);
         }
         return val;
 
     }

◆ transferToResource()

static BaseScimResource org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.transferToResource	(	BaseScimResource	origin,
		final BaseScimResource	destination,
		List< Extension >	extensions,
		boolean	replacing
	)		throws InvalidAttributeValueException

inlinestaticprivate

                                                                                                                                           {
 
         log.debug("transferToResource. Processing {} operation", replacing ? "replace" : "add");
 
         Map<String, Object> fromMap = mapper.convertValue(origin, new TypeReference<Map<String,Object>>(){});
         Map<String, Object> toMap = mapper.convertValue(destination, new TypeReference<Map<String,Object>>(){});
 
         log.debug("transferToResource. Recursive traversal of resource is taking place");
         traversalClass tclass=new traversalClass(origin.getClass());
         tclass.traverse("", fromMap, toMap, replacing);
         attachExtensionInfo(fromMap, toMap, extensions, replacing);
 
         if (tclass.error==null)
             return mapper.convertValue(toMap, origin.getClass());
         else
             throw new InvalidAttributeValueException(tclass.error);
 
     }

◆ transferToResourceAdd()

static BaseScimResource org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.transferToResourceAdd	(	BaseScimResource	replacementDataSource,
		BaseScimResource	originalDataSource,
		List< Extension >	extensions
	)		throws InvalidAttributeValueException

inlinestatic

This method applies the same copying rules of transferToResourceReplace except for the following:

When a multi-valued attribute is passed in replacementDataSource, the existing data in the originalDataSource object is retained, and the items in the former object are prepended to the existing collection.

引数

replacementDataSource	Object with the information to be incorporated. Only non-null attributes of this object end up being transfered to the result
originalDataSource	Object (SCIM resource) that provides the original data
extensions	A list of `Extensions` associated to parameter `originalDataSource`. This helps to manipulate the transference of custom attributes values.

戻り値: A new object that contains the result of data transference. Neither replacementDataSource nor originalDataSource are changed after a call to this method

例外

InvalidAttributeValueException When recursive traversal of replacementDataSource fails or if the rule of immutable attribute was not fulfilled

                                                                                                                              {
         return transferToResource(replacementDataSource, originalDataSource, extensions, false);
     }

◆ transferToResourceReplace()

static BaseScimResource org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.transferToResourceReplace	(	BaseScimResource	replacementDataSource,
		BaseScimResource	originalDataSource,
		List< Extension >	extensions
	)		throws InvalidAttributeValueException

inlinestatic

Returns an object which is the result of incorporating the information found in the replacementDataSource parameter to the information existing in originalDataSource object by doing replacements. The transference of data follows these rules:

Ignores changes in readonly attributes
Ignores null values (for single-valued attributes) in replacementDataSource
Nullifies multi-valued attributes when empty array is passed in replacementDataSource
Immutable attributes must match in both input objects or else exception is thrown. However, if the value in originalDataSource is missing (null), the value coming from replacementDataSource is kept
When a multi-valued attribute is passed in replacementDataSource, no existing data in the originalDataSource is retained, that is, the replacement is not partial but thorough: it's not an item-by-item replacement

引数

replacementDataSource	Object with the information to be incorporated. Only non-null attributes of this o bject end up being transfered to the result
originalDataSource	Object (SCIM resource) that provides the original data
extensions	A list of `Extensions` associated to parameter `originalDataSource`. This helps to manipulate the transference of custom attributes values.

戻り値: A new object that contains the result of data transference. Neither replacementDataSource nor originalDataSource are changed after a call to this method

例外

InvalidAttributeValueException When recursive traversal of replacementDataSource fails or if the rule of immutable attribute was not fulfilled

                                                                                                                              {
         //This method is suitable for the replace operation via PUT, or for a PATCH with op="replace" and no "value selection" filter
         return transferToResource(replacementDataSource, originalDataSource, extensions, true);
     }

メンバ詳解

◆ log

Logger org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.log = LogManager.getLogger(ScimResourceUtil.class)

staticprivate

◆ mapper

ObjectMapper org.gluu.oxtrust.model.scim2.util.ScimResourceUtil.mapper =new ObjectMapper()

staticprivate

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

D:/AppData/OpenId/gluu/src/oxTrust/scim/src/main/java/org/gluu/oxtrust/model/scim2/util/ScimResourceUtil.java

静的公開メンバ関数

非公開メンバ関数

静的非公開メンバ関数

静的非公開変数類

詳解

構築子と解体子

◆ ScimResourceUtil()

関数詳解

◆ adjustNotationInPath()

◆ adjustPrimarySubAttributes()

◆ attachExtensionInfo()

◆ deleteCustomAttribute()

◆ deleteFromResource()

◆ getDefaultSchemaUrn()

◆ getSchemaAnnotation()

◆ getType()

◆ splitPath()

◆ stripDefaultSchema()

◆ transferToResource()

◆ transferToResourceAdd()

◆ transferToResourceReplace()

メンバ詳解

◆ log

◆ mapper