org.gluu.oxtrust.model.scim2.util.IntrospectUtil クラス

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

静的公開メンバ関数
static Field	findFieldFromPath (Class<?> initcls, String path)
static Map< String, Object >	strObjMap (Object obj)
static< T extends Annotation > T	getFieldAnnotation (String path, Class resourceClass, Class< T > annotationClass)
static List< Object >	getAttributeValues (BaseScimResource bean, final List< Method > getters)
static Method	getSetter (String fieldName, Class clazz) throws Exception
static Method	getGetter (String fieldName, Class clazz) throws Exception
static boolean	isCollection (Class clazz)
static List< String >	getPathsInExtension (Extension extension)

静的公開変数類
static Map< Class<? extends BaseScimResource >, Map< String, List< Method > > >	defaultCoreAttrs
static Map< Class<? extends BaseScimResource >, Map< String, List< Method > > >	requestCoreAttrs
static Map< Class<? extends BaseScimResource >, Map< String, List< Method > > >	alwaysCoreAttrs
static Map< Class<? extends BaseScimResource >, Map< String, List< Method > > >	neverCoreAttrs
static Map< Class<? extends BaseScimResource >, Map< String, List< Method > > >	requiredCoreAttrs
static Map< Class<? extends BaseScimResource >, Map< String, List< Method > > >	validableCoreAttrs
static Map< Class<? extends BaseScimResource >, Map< String, List< Method > > >	canonicalCoreAttrs
static Map< Class<? extends BaseScimResource >, SortedSet< String > >	allAttrs
static Map< Class<? extends BaseScimResource >, Map< String, String > >	storeRefs

静的関数
	[static initializer]

非公開メンバ関数
	IntrospectUtil ()

静的非公開メンバ関数
static Field	findField (final Class<?> cls, final String fieldName)
static Map< Class<? extends BaseScimResource >, Map< String, List< Method > > >	newEmptyMap ()
static void	resetAttrNames ()
static void	resetMaps ()
static void	freezeMaps ()
static void	traverseClassForNames (Class clazz, String prefix, List< Field > extraFields, boolean prune) throws Exception
static Map< String, List< Method > >	computeGettersMap (List< String > attrNames, Class baseClass) throws Exception

静的非公開変数類
static Logger	log = LogManager.getLogger(IntrospectUtil.class)
static List< String >	requiredAttrsNames
static List< String >	defaultAttrsNames
static List< String >	alwaysAttrsNames
static List< String >	neverAttrsNames
static List< String >	requestAttrsNames
static List< String >	validableAttrsNames
static List< String >	canonicalizedAttrsNames

詳解

Provides miscelaneous routines to query classes/objects properties using reflection mechanisms. Additionally, this class exposes some static members that contain useful information about SCIM resources that is collected upon class loading.

構築子と解体子

IntrospectUtil()

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

inlineprivate

{}

関数詳解

[static initializer]()

org.gluu.oxtrust.model.scim2.util.IntrospectUtil.[static initializer] ( )

inlinestaticpackage

computeGettersMap()

static Map<String, List<Method> > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.computeGettersMap ( List< String >  attrNames, Class  baseClass  ) throws Exception

inlinestaticprivate

                                                                                                                        {

        Map<String, List<Method>> map=new HashMap<String, List<Method>>();

        for (String attrName : attrNames) {
            List<Method> list =new ArrayList<Method>();
            Class clazz=baseClass;

            for (String prop : attrName.split("\\.")) {
                Method method=getGetter(prop, clazz);
                list.add(method);

                if (isCollection(method.getReturnType())) {  //Use class of parameter in collection
                    Field f=findField(clazz, prop);
                    Attribute attrAnnot=f.getAnnotation(Attribute.class);
                    if (attrAnnot!=null)
                        clazz=attrAnnot.multiValueClass();
                }
                else
                    clazz=method.getReturnType();
            }
            map.put(attrName, list);
        }
        return map;

    }

findField()

static Field org.gluu.oxtrust.model.scim2.util.IntrospectUtil.findField ( final Class<?>  cls, final String  fieldName  )

inlinestaticprivate

This method will find a java Field with a particular name. If needed, this method will search through super classes. The field does not need to be public. Adapted from https://github.com/pingidentity/scim2/blob/master/scim2-sdk-common/src/main/java/com/unboundid/scim2/common/utils/SchemaUtils.java

引数

cls	the java Class to search.
fieldName	the name of the field to find.

戻り値

A Field object, or null if no field was found

                                                                              {

        Class<?> currentClass = cls;

        while(currentClass != null){
            Field fields[] = currentClass.getDeclaredFields();
            for (Field field : fields){
                if(field.getName().equals(fieldName))
                    return field;
            }
            currentClass = currentClass.getSuperclass();
        }
        return null;

    }

findFieldFromPath()

static Field org.gluu.oxtrust.model.scim2.util.IntrospectUtil.findFieldFromPath ( Class<?>  initcls, String  path  )

inlinestatic

Inspects a class to search for a field that corresponds to the path passed using dot notation. Every piece of the path (separated by the a dot '.') is expected to have a field with the same name in the class inspected. When such a field is found, the remainder of the path is processed using the class associated to the field, until the path is fully consumed.

This method starts from an initial class and visits ascendingly the class hierarchy with a route determined by the components found in the path parameter.

引数

initcls	Class to start the search from
path	A string denoting a path to a target attribute. Examples of valid paths can be: displayName, name.givenName, addresses.locality

戻り値

A Field that represents the terminal portion of the path, for instance "locality" field for "addresses.locality". If no such field is found (because at some point, there was no route to go), null is returned.

                                                                        {

        Class cls=initcls;
        Field f=null;

        for (String prop : path.split("\\.")) {
            f=findField(cls, prop);

            if (f!=null) {
                cls = f.getType();
                if (isCollection(cls)) {
                    Attribute attrAnnot = f.getAnnotation(Attribute.class);
                    if (attrAnnot != null)
                        cls = attrAnnot.multiValueClass();
                }
            }
            else
                break;
        }
        return f;

    }

freezeMaps()

static void org.gluu.oxtrust.model.scim2.util.IntrospectUtil.freezeMaps ( )

inlinestaticprivate

                                    {
        requiredCoreAttrs=Collections.unmodifiableMap(requiredCoreAttrs);
        defaultCoreAttrs=Collections.unmodifiableMap(defaultCoreAttrs);
        alwaysCoreAttrs=Collections.unmodifiableMap(alwaysCoreAttrs);
        neverCoreAttrs=Collections.unmodifiableMap(neverCoreAttrs);
        requestCoreAttrs=Collections.unmodifiableMap(requestCoreAttrs);
        validableCoreAttrs=Collections.unmodifiableMap(validableCoreAttrs);
        canonicalCoreAttrs=Collections.unmodifiableMap(canonicalCoreAttrs);

        allAttrs=Collections.unmodifiableMap(allAttrs);
        storeRefs=Collections.unmodifiableMap(storeRefs);
    }

getAttributeValues()

static List<Object> org.gluu.oxtrust.model.scim2.util.IntrospectUtil.getAttributeValues ( BaseScimResource  bean, final List< Method >  getters  )

inlinestatic

Traverses the contents of a SCIM resource and applies a set of getter methods to collect a list of values. For example, if passing a UserResource object and list of getters such as [getAdresses(), getStreetAddress()], it will return a list with all "street addresses" that can be found inside user object.

引数

bean	A SCIM resource object
getters	A list of getters methods

戻り値

List of values. They are collected by scanning the getter list from beginning to end. If no values could be collected at all, an empty list is returned

                                                                                                    {

        final List<Object> results=new ArrayList<Object>();

        class traversalClass{

            void traverse(Object value, int index){

                try {
                    if (value!=null && index < getters.size()) {
                        if (IntrospectUtil.isCollection(value.getClass())) {

                            Collection collection=(Collection)value;
                            if (collection.isEmpty())
                                traverse(null, index);    //stops branching...
                            else {
                                for (Object val : collection)
                                    traverse(val, index);
                            }
                        }
                        else {
                            Object val=getters.get(index).invoke(value);
                            traverse(val, index+1);
                        }
                    }
                    //Add result only if we are at the deepest level (tree tip)
                    if (index==getters.size())
                        results.add(value);
                }
                catch (Exception e){
                    log.error(e.getMessage(), e);
                }
            }

        }

        new traversalClass().traverse(bean, 0);
        return results;

    }

getFieldAnnotation()

static <T extends Annotation> T org.gluu.oxtrust.model.scim2.util.IntrospectUtil.getFieldAnnotation ( String  path, Class  resourceClass, Class< T >  annotationClass  )

inlinestatic

Searches for a Field that corresponds to the path passed (using findFieldFromPath) and tries to find an annotation attached to such field that matches the annotationClass parameter.

引数

path	A string denoting a path to a target attribute. Examples of valid paths can be: displayName, name.givenName, addresses.locality when UserResource class is used for resourceClass.
resourceClass	Class to start the search from
annotationClass	Class annotation to be inspected for the field
<T>	Type parameter for annotationClass

戻り値

An object of type T, or null if no annotation was found or the field itself couldn't be found

                                                                                                                         {
        Field f=findFieldFromPath(resourceClass, path);
        return f==null ? null : f.getAnnotation(annotationClass);
    }

getGetter()

static Method org.gluu.oxtrust.model.scim2.util.IntrospectUtil.getGetter ( String  fieldName, Class  clazz  ) throws Exception

inlinestatic

Inspects a class that represents a Java Bean and tries to find the getter Method associated to the class field whose name is passed as parameter.

引数

fieldName	The name of the field whose getter needs to be found
clazz	The Class to introspect

戻り値

A Method object, null if the lookup is not successful

例外

Exception

Upon introspection error

                                                                                  {
        PropertyDescriptor[] props = Introspector.getBeanInfo(clazz).getPropertyDescriptors();
        for (PropertyDescriptor p : props)
            if (p.getName().equals(fieldName))
                return p.getReadMethod();
        return null;
    }

getPathsInExtension()

static List<String> org.gluu.oxtrust.model.scim2.util.IntrospectUtil.getPathsInExtension ( Extension  extension )

inlinestatic

Returns a list with the names of the attributes that belong to an extension, so that every name is prefixed with the urn of the extension, like this: urn:attribute_name

引数

extension

An Extension object

戻り値

A list of prefixed names

                                                                       {

        List<String> list=new ArrayList<String>();
        for (String attr : extension.getFields().keySet())
            list.add(extension.getUrn() + "." + attr);
        return list;

    }

getSetter()

static Method org.gluu.oxtrust.model.scim2.util.IntrospectUtil.getSetter ( String  fieldName, Class  clazz  ) throws Exception

inlinestatic

Inspects a class that represents a Java Bean and tries to find the setter Method associated to the class field whose name is passed as parameter.

引数

fieldName	The name of the field whose setter needs to be found
clazz	The Class to introspect

戻り値

A Method object, null if the lookup is not successful

例外

Exception

Upon introspection error

                                                                                  {
        PropertyDescriptor[] props = Introspector.getBeanInfo(clazz).getPropertyDescriptors();
        for (PropertyDescriptor p : props)
            if (p.getName().equals(fieldName))
                return p.getWriteMethod();
        return null;
    }

isCollection()

static boolean org.gluu.oxtrust.model.scim2.util.IntrospectUtil.isCollection ( Class  clazz )

inlinestatic

Determines if the class passed implements the Collection interface.

引数

clazz

Class to analyze

戻り値

true if the class is a Collection, false otherwise.

                                                   {
        return Collection.class.isAssignableFrom(clazz);
    }

newEmptyMap()

static Map<Class<? extends BaseScimResource>, Map<String, List<Method> > > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.newEmptyMap ( )

inlinestaticprivate

                                                                                                  {
        return new HashMap<Class<? extends BaseScimResource>, Map<String, List<Method>>>();
    }

resetAttrNames()

static void org.gluu.oxtrust.model.scim2.util.IntrospectUtil.resetAttrNames ( )

inlinestaticprivate

                                        {
        requiredAttrsNames=new ArrayList<String>();
        defaultAttrsNames=new ArrayList<String>();
        validableAttrsNames=new ArrayList<String>();
        canonicalizedAttrsNames=new ArrayList<String>();
        alwaysAttrsNames=new ArrayList<String>();
        neverAttrsNames=new ArrayList<String>();
        requestAttrsNames=new ArrayList<String>();
    }

resetMaps()

static void org.gluu.oxtrust.model.scim2.util.IntrospectUtil.resetMaps ( )

inlinestaticprivate

                                   {
        requiredCoreAttrs=newEmptyMap();
        defaultCoreAttrs=newEmptyMap();
        alwaysCoreAttrs=newEmptyMap();
        neverCoreAttrs=newEmptyMap();
        requestCoreAttrs=newEmptyMap();
        validableCoreAttrs=newEmptyMap();
        canonicalCoreAttrs=newEmptyMap();

        allAttrs=new HashMap<Class<? extends BaseScimResource>, SortedSet<String>>();
        storeRefs=new HashMap<Class<? extends BaseScimResource>, Map<String,String>>();
    }

strObjMap()

static Map<String, Object> org.gluu.oxtrust.model.scim2.util.IntrospectUtil.strObjMap ( Object  obj )

inlinestatic

Takes an opaque object and casts it to a { Map<String, Object>}. Call this only if you are sure the object being passed is actually an instance of { Map<String, Object>}.

引数

obj	Object to be cast

戻り値

A map instance

                                                           {
        return (Map<String, Object>) obj;
    }

traverseClassForNames()

static void org.gluu.oxtrust.model.scim2.util.IntrospectUtil.traverseClassForNames ( Class  clazz, String  prefix, List< Field >  extraFields, boolean  prune  ) throws Exception

inlinestaticprivate

                                                                                                                                  {

        List<Field> fields=new ArrayList<Field>();
        fields.addAll(Arrays.asList(clazz.getDeclaredFields()));
        fields.addAll(extraFields);

        for (Field f : fields){
            Attribute attrAnnot=f.getAnnotation(Attribute.class);
            if (attrAnnot!=null){

                String name=f.getName();
                if (prefix.length()>0)
                    name=prefix + "." + name;

                switch (attrAnnot.returned()){
                    case ALWAYS:
                        alwaysAttrsNames.add(name);
                        break;
                    case DEFAULT:
                        defaultAttrsNames.add(name);
                        break;
                    case NEVER:
                        neverAttrsNames.add(name);
                        break;
                    case REQUEST:
                        requestAttrsNames.add(name);
                        break;
                }

                if (attrAnnot.isRequired())
                    requiredAttrsNames.add(name);

                if (attrAnnot.canonicalValues().length>0)
                    canonicalizedAttrsNames.add(name);

                Validator vAnnot=f.getAnnotation(Validator.class);
                if (vAnnot!=null)
                    validableAttrsNames.add(name);

                if (!prune && attrAnnot.type().equals(AttributeDefinition.Type.COMPLEX)) {
                    Class cls = attrAnnot.multiValueClass();  //Use <T> parameter of Collection if present
                    if (cls.equals(NullType.class))
                        cls=f.getType();

                    if (clazz.equals(cls))  //Prevent infinite loop
                        prune=true;

                    traverseClassForNames(cls.equals(NullType.class) ? f.getType() : cls, name, new ArrayList<Field>(), prune);
                }
            }
        }
    }

メンバ詳解

allAttrs

Map<Class <? extends BaseScimResource>, SortedSet<String> > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.allAttrs

static

An unmodifiable map that stores for every possible subclass of BaseScimResource a SortedSet with the paths that lead to every single attribute/subattribute part of that resource.

As an example, a set for the UserResource includes elements such as schemas, id, name, name.givenName, emails, emails.value, emails.type, ...

alwaysAttrsNames

List<String> org.gluu.oxtrust.model.scim2.util.IntrospectUtil.alwaysAttrsNames

staticprivate

alwaysCoreAttrs

Map<Class<? extends BaseScimResource>, Map<String, List<Method> > > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.alwaysCoreAttrs

static

An unmodifiable map that provides access to the sequence of getter methods that allow to get the actual value(s) for every possible attribute (or sub-atribute) of a SCIM resource when its returnability is "always"

canonicalCoreAttrs

Map<Class<? extends BaseScimResource>, Map<String, List<Method> > > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.canonicalCoreAttrs

static

An unmodifiable map that provides access to the sequence of getter methods that allow to get the actual value(s) for every possible attribute (or sub-atribute) of a SCIM resource when the attribute has canonical values associated

canonicalizedAttrsNames

List<String> org.gluu.oxtrust.model.scim2.util.IntrospectUtil.canonicalizedAttrsNames

staticprivate

defaultAttrsNames

List<String> org.gluu.oxtrust.model.scim2.util.IntrospectUtil.defaultAttrsNames

staticprivate

defaultCoreAttrs

Map<Class<? extends BaseScimResource>, Map<String, List<Method> > > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.defaultCoreAttrs

static

An unmodifiable map that provides access to the sequence of getter methods that allow to get the actual value(s) for every possible attribute (or sub-atribute) of a SCIM resource when its returnability is "default"

log

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

staticprivate

neverAttrsNames

List<String> org.gluu.oxtrust.model.scim2.util.IntrospectUtil.neverAttrsNames

staticprivate

neverCoreAttrs

Map<Class<? extends BaseScimResource>, Map<String, List<Method> > > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.neverCoreAttrs

static

An unmodifiable map that provides access to the sequence of getter methods that allow to get the actual value(s) for every possible attribute (or sub-atribute) of a SCIM resource when its returnability is "never"

requestAttrsNames

List<String> org.gluu.oxtrust.model.scim2.util.IntrospectUtil.requestAttrsNames

staticprivate

requestCoreAttrs

Map<Class<? extends BaseScimResource>, Map<String, List<Method> > > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.requestCoreAttrs

static

An unmodifiable map that provides access to the sequence of getter methods that allow to get the actual value(s) for every possible attribute (or sub-atribute) of a SCIM resource when its returnability is "request"

requiredAttrsNames

List<String> org.gluu.oxtrust.model.scim2.util.IntrospectUtil.requiredAttrsNames

staticprivate

requiredCoreAttrs

Map<Class<? extends BaseScimResource>, Map<String, List<Method> > > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.requiredCoreAttrs

static

An unmodifiable map that provides access to the sequence of getter methods that allow to get the actual value(s) for every possible attribute (or sub-atribute) of a SCIM resource when the attribute is annotated as "required" in the resource

storeRefs

Map<Class <? extends BaseScimResource>, Map<String, String> > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.storeRefs

static

An unmodifiable map that stores for every possible subclass of BaseScimResource a Map that stores paths (as stored in allAttrs) vs. LDAP attribute names corresponding to such paths.

As an example, for UserResource this map will contain pairs like (userName, uid); (displayName, displayName); (meta.created, oxCreationTimestamp); (addresses, oxTrustAddresses); (addresses.value, oxTrustAddresses)...

validableAttrsNames

List<String> org.gluu.oxtrust.model.scim2.util.IntrospectUtil.validableAttrsNames

staticprivate

validableCoreAttrs

Map<Class<? extends BaseScimResource>, Map<String, List<Method> > > org.gluu.oxtrust.model.scim2.util.IntrospectUtil.validableCoreAttrs

static

An unmodifiable map that provides access to the sequence of getter methods that allow to get the actual value(s) for every possible attribute (or sub-atribute) of a SCIM resource when the attribute is annotated with some validation

---

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

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