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

公開メンバ関数
	ResourceValidator (BaseScimResource resource, List< Extension > extensions)

void	validateRequiredAttributes () throws SCIMException

void	validateValidableAttributes () throws SCIMException

void	validateCanonicalizedAttributes () throws SCIMException

void	validateSchemasAttribute () throws SCIMException

void	validateExtendedAttributes () throws SCIMException

非公開メンバ関数
void	validateDataTypeExtendedAttr (Extension extension, String attribute, Object value) throws SCIMException

非公開変数類
Logger	log = LogManager.getLogger(getClass())

BaseScimResource	resource

Class<? extends BaseScimResource >	resourceClass

List< Extension >	extensions

静的非公開変数類
static final String	REQUIRED_ATTR_NOTFOUND ="Required attribute %s not found"

static final String	WRONG_SCHEMAS_ATTR ="Wrong value of schemas attribute"

static final String	UNKNOWN_EXTENSION ="Extension %s not recognized"

static final String	ATTR_NOT_RECOGNIZED ="Attribute %s not part of schema %s"

static final String	ERROR_PARSING_EXTENDED ="Error parsing extended attributes"

static final String	ATTR_VALIDATION_FAILED ="Unexpected value for attribute %s"

詳解

This class provides static methods to validate whether a (SCIM) resource instance fulfills certain characteristics - regarded to formatting, mutability, uniqueness, etc. This allows to adhere more closely to SCIM spec

構築子と解体子

◆ ResourceValidator()

org.gluu.oxtrust.model.scim2.util.ResourceValidator.ResourceValidator	(	BaseScimResource	resource,
		List< Extension >	extensions
	)

inline

Construct a instance of this class

引数

resource	A SCIM resource object (the target of validation)
extensions	List of extensions associated to this resource

                                                                                    {
         this.resource=resource;
         resourceClass=resource.getClass();
         this.extensions=extensions;
     }

関数詳解

◆ validateCanonicalizedAttributes()

void org.gluu.oxtrust.model.scim2.util.ResourceValidator.validateCanonicalizedAttributes ( ) throws SCIMException

inline

Inspects the resource passed in the constructor and for every attribute annotated with a non-empty collection of canonical values, it checks whether the attribute value matches any of the canonical values supplied.

This method should be called after a successful call to validateRequiredAttributes().

例外

SCIMException When a validation does not pass (there is no match for any of the attributes inspected)

                                                                       {
 
         Map<String, List<Method>> map=IntrospectUtil.canonicalCoreAttrs.get(resourceClass);
 
         for (String attributePath : map.keySet()) {
 
             Attribute attrAnnot=IntrospectUtil.getFieldAnnotation(attributePath, resourceClass, Attribute.class);
             List<String> canonicalVals=Arrays.asList(attrAnnot.canonicalValues());
             log.debug("Validating values of canonical attribute '{}'", attributePath);
 
             for (Object val : IntrospectUtil.getAttributeValues(resource, map.get(attributePath))) {
                 if (!canonicalVals.contains(val.toString())) {
                     log.error("Error validating canonical attribute '{}', wrong value supplied: '{}'", attributePath, val.toString());
                     throw new SCIMException(String.format(ATTR_VALIDATION_FAILED, attributePath));
                 }
             }
         }
     }

◆ validateDataTypeExtendedAttr()

void org.gluu.oxtrust.model.scim2.util.ResourceValidator.validateDataTypeExtendedAttr	(	Extension	extension,
		String	attribute,
		Object	value
	)		throws SCIMException

inlineprivate

Validates if an attribute part of an extension is consistent with an arbitrary value passed.

引数

extension	Extension where the attribute exists
attribute	The name of the attribute inside the extension
value	The value to be checked (never null)

例外

SCIMException When the value is inconsistent, or the attribute does not belong to the extension. As an example, consider an attribute whose type is "NUMERIC": if the value passed was "Hi", this is clearly an error.

                                                                                                                        {
 
         ExtensionField field=extension.getFields().get(attribute);
         if (field==null)
             throw new SCIMException(String.format(ATTR_NOT_RECOGNIZED, attribute, extension.getUrn()));
         else{
             log.debug("validateDataTypeExtendedAttr. Checking attribute '{}' for type '{}' with value '{}'", attribute, field.getType().toString(), value.toString());
 
             //look up if the field in this extension is consistent with the value passed
             if (ExtensionField.valueOf(field, value)==null)
                 throw new SCIMException(String.format(ATTR_VALIDATION_FAILED, attribute));
         }
 
     }

◆ validateExtendedAttributes()

void org.gluu.oxtrust.model.scim2.util.ResourceValidator.validateExtendedAttributes ( ) throws SCIMException

inline

Inspects the resource passed in the constructor and for every extended attribute (see BaseScimResource#getCustomAttributes(), the attribute's value is checked to see if it complies with the data type it is supposed to belong to. This information is obtained from the list of Extensions passed in the constructor (every ExtensionField has an associated type.

When an attribute is multi-valued, every single item inside the collection is validated.

例外

SCIMException When any of the validations do not pass or an attribute seems not to be part of a known schema.

                                                                  {
 
         //Note: throughout this method, we always ignore presence of nulls
 
         //Gets all extended attributes (see the @JsonAnySetter annotation in BaseScimResource)
         Map<String, Object> extendedAttributes=resource.getCustomAttributes();
 
         //Iterate over every extension of the resource object (in practice it will be just one at most)
         for (String schema : extendedAttributes.keySet()) {
             //Validate if the schema referenced in the extended attributes is contained in the valid set of extension
 
             Extension extension=null;
             for (Extension ext : extensions)
                 if (ext.getUrn().equals(schema)) {
                     extension = ext;
                     break;
                 }
 
             if (extension!=null) {
                 log.debug("validateExtendedAttributes. Revising attributes under schema {}", schema);
 
                 try {
                     //Obtains a generic map consisting of all name/value(s) pairs associated to this schema
                     Map<String, Object> attrsMap = IntrospectUtil.strObjMap(extendedAttributes.get(schema));
 
                     for (String attr : attrsMap.keySet()) {
                         Object value = attrsMap.get(attr);
                         if (value != null) {
                             /*
                              Gets the class associated to the value of current attribute. For extended attributes, we
                              should only see coming: String, Integer, Double, boolean, and Collection.
                              Different things will be rejected
                              */
                             Class cls = value.getClass();
                             boolean isCollection=IntrospectUtil.isCollection(cls);
 
                             //If the attribute coming is unknown, NPE will be thrown and we are covered
                             log.debug("validateExtendedAttributes. Got value(s) for attribute '{}'", attr);
                             //Check if the multivalued custom attribute is consistent with the nature of the value itself
                             if (isCollection == extension.getFields().get(attr).isMultiValued()){
                                 if (isCollection) {
                                     for (Object elem : (Collection) value)
                                         if (elem!=null)
                                             validateDataTypeExtendedAttr(extension, attr, elem);
                                 }
                                 else
                                     validateDataTypeExtendedAttr(extension, attr, value);
                             }
                             else
                                 throw new SCIMException(ERROR_PARSING_EXTENDED);
                         }
                     }
                 }
                 catch (Exception e) {
                     log.error(e.getMessage(), e);
                     throw new SCIMException(ERROR_PARSING_EXTENDED);
                 }
             }
             else
                 throw new SCIMException(String.format(UNKNOWN_EXTENSION, schema));
         }
 
     }

◆ validateRequiredAttributes()

void org.gluu.oxtrust.model.scim2.util.ResourceValidator.validateRequiredAttributes ( ) throws SCIMException

inline

Inspects the resource passed in the constructor and determines if the attributes annotated as required in the Class of the resource were all provided (not null).

If an attribute was marked as "required" and is part of a multi-valued complex attribute, no validation takes place if the involved list is null or empty.

例外

SCIMException When a validation does not pass (there is a missing value in a required attribute)

                                                                   {
 
         Map<String, List<Method>> map=IntrospectUtil.requiredCoreAttrs.get(resourceClass);
 
         for (String attributePath : map.keySet()){
             log.debug("Validating existence of required attribute '{}'", attributePath);
 
             for (Object val : IntrospectUtil.getAttributeValues(resource, map.get(attributePath)))
                 if (val == null) {
                     log.error("Error getting value of required attribute '{}'", attributePath);
                     throw new SCIMException(String.format(REQUIRED_ATTR_NOTFOUND, attributePath));
                 }
         }
 
     }

◆ validateSchemasAttribute()

void org.gluu.oxtrust.model.scim2.util.ResourceValidator.validateSchemasAttribute ( ) throws SCIMException

inline

Inspects the schemas attribute of the resource passed in the constructor and checks the default schema urn associated to the resource type is present in the list. If some of the urns part of the Extensions passed in the constructor are contained in the list, the validation is also successful.

This method should be called after a successful call to validateRequiredAttributes().

例外

SCIMException If there is no schemas in this resource or if some of the urns there are not known.

                                                                 {
 
         Set<String> schemaList = new HashSet<String>(resource.getSchemas());
         if (schemaList.size()==0)
             throw new SCIMException(WRONG_SCHEMAS_ATTR);
 
         Set<String> allSchemas=new HashSet<String>();
         allSchemas.add(ScimResourceUtil.getDefaultSchemaUrn(resourceClass));
         for (Extension ext : extensions)
             allSchemas.add(ext.getUrn());
 
         schemaList.removeAll(allSchemas);
 
         if (schemaList.size()>0)    //means that some wrong extension urn is there
             throw new SCIMException(WRONG_SCHEMAS_ATTR);
 
     }

◆ validateValidableAttributes()

void org.gluu.oxtrust.model.scim2.util.ResourceValidator.validateValidableAttributes ( ) throws SCIMException

inline

Inspects the resource passed in the constructor and applies validations for every attribute annotated with Validator. Validations are of different nature as seenhere.

例外

SCIMException When a validation does not pass (the apply method returns false)

                                                                   {
 
         Map<String, List<Method>> map=IntrospectUtil.validableCoreAttrs.get(resourceClass);
 
         for (String attributePath : map.keySet()) {
 
             Field f=IntrospectUtil.findFieldFromPath(resourceClass, attributePath);
             Validations valToApply=f.getAnnotation(Validator.class).value();
             log.debug("Validating value(s) of attribute '{}'", attributePath);
 
             for (Object val : IntrospectUtil.getAttributeValues(resource, map.get(attributePath))) {
                 if (val!=null && !Validations.apply(valToApply, val)) {
                     log.error("Error validating attribute '{}', wrong value supplied: '{}'", attributePath, val.toString());
                     throw new SCIMException(String.format(ATTR_VALIDATION_FAILED, attributePath));
                 }
             }
         }
 
     }

staticprivate

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

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

公開メンバ関数

非公開メンバ関数

非公開変数類

静的非公開変数類

詳解

構築子と解体子

◆ ResourceValidator()

関数詳解

◆ validateCanonicalizedAttributes()

◆ validateDataTypeExtendedAttr()

◆ validateExtendedAttributes()

◆ validateRequiredAttributes()

◆ validateSchemasAttribute()

◆ validateValidableAttributes()

メンバ詳解

◆ ATTR_NOT_RECOGNIZED

◆ ATTR_VALIDATION_FAILED

◆ ERROR_PARSING_EXTENDED

◆ extensions

◆ log

◆ REQUIRED_ATTR_NOTFOUND

◆ resource

◆ resourceClass

◆ UNKNOWN_EXTENSION

◆ WRONG_SCHEMAS_ATTR