com.ibm.itim.dataservices.model

Class ModelSchema

  • java.lang.Object
    • com.ibm.itim.dataservices.model.ModelSchema

  • public class ModelSchema
extends java.lang.Object
    Class that provides an interface for retrieving schema information about entities within the data model. This schema information will not be raw schema characteristics from the data store directly, but will instead be altered to make semantic sense with respect to the data model. Internal system attributes will not be returned as part of the returned schema classes.

    • Constructor Summary

      Constructors 
      Constructor and Description
      ModelSchema() 

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      java.util.Collection getClassSchemaAttributes(java.lang.String className)
      Deprecated. 
      use LDAPSchema.getClassSchemaAttributes(). Since 4.6
      java.util.Collection getClassSchemaAttributes(java.lang.String className, java.lang.String propKey)
      Deprecated. 
      use LDAPSchema.getClassSchemaAttributes(). Since 4.6
      java.lang.String getModelClass(java.lang.String category)
      Returns the name of the class that defines the semantic schema for objects in the specified category.
      com.ibm.itim.dataservices.schema.DirectoryObjectSchema getObjectProfileSchema(DistinguishedName tenantDN, java.lang.String objProfileName)
      Returns the schema information of a specific object profile.
      java.util.Collection<SchemaAttribute> getObjectSchemaAttributes(DistinguishedName tenantDN, java.lang.String objProfileName)
      Returns all schema attribute definitions for a specific object profile.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ModelSchema

        public ModelSchema()

    • Method Detail

      • getObjectSchemaAttributes

        public java.util.Collection<SchemaAttribute> getObjectSchemaAttributes(DistinguishedName tenantDN,
                                                                       java.lang.String objProfileName)
                                                                throws com.ibm.itim.dataservices.schema.SchemaException
        Returns all schema attribute definitions for a specific object profile.
        Parameters:
        tenantDN - tenant DN
        objProfileName - name of an object profile
        Returns:
        A list of (SchemaAttribute class) objects that represents the schema definition of an attribute.
        Throws:
        com.ibm.itim.dataservices.schema.SchemaException - if unable to retrieve schema information for a given class.
        See Also:
        SchemaAttribute

      • getObjectProfileSchema

        public com.ibm.itim.dataservices.schema.DirectoryObjectSchema getObjectProfileSchema(DistinguishedName tenantDN,
                                                                                     java.lang.String objProfileName)
                                                                              throws com.ibm.itim.dataservices.schema.SchemaException
        Returns the schema information of a specific object profile.
        Parameters:
        tenantDN - tenant DN
        objProfileName - name of an object profile
        Returns:
        a DirectoryObjectSchema object
        Throws:
        com.ibm.itim.dataservices.schema.SchemaException - if unable to retrieve schema information for a given class.

      • getClassSchemaAttributes

        public java.util.Collection getClassSchemaAttributes(java.lang.String className)
                                              throws com.ibm.itim.dataservices.schema.SchemaException
        Deprecated. use LDAPSchema.getClassSchemaAttributes(). Since 4.6
        Returns all attributes for a specific class excluding hidden attributes.
        Parameters:
        className - name of a LDAP class
        Returns:
        Collection of attributes as String objects
        Throws:
        com.ibm.itim.dataservices.schema.SchemaException - if unable to retrieve schema information for a given class.

      • getClassSchemaAttributes

        public java.util.Collection getClassSchemaAttributes(java.lang.String className,
                                                     java.lang.String propKey)
                                              throws com.ibm.itim.dataservices.schema.SchemaException
        Deprecated. use LDAPSchema.getClassSchemaAttributes(). Since 4.6
        Returns all attributes for a specific class excluding all attributes in a properties file.
        Parameters:
        className - name of a LDAP class
        propKey - key to a name of a properties file
        Returns:
        Collection of attributes as String objects
        Throws:
        com.ibm.itim.dataservices.schema.SchemaException - if unable to retrieve schema information for a given class.

      • getModelClass

        public java.lang.String getModelClass(java.lang.String category)
        Returns the name of the class that defines the semantic schema for objects in the specified category.
        Parameters:
        category - Category of object the schema is defined for. Please use the constant defined for each category in ObjectProfileCategory.
        Returns:
        Class name that defines the semantic attributes required for objects of the given category in the data model.
        See Also:
        ObjectProfileCategory
Skip navigation links