Package com.ibm.wsspi.security.wim.model

Class IdentifierType

java.lang.Object
com.ibm.wsspi.security.wim.model.IdentifierType
public class IdentifierType extends Object

Java class for IdentifierType complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="IdentifierType">
 <complexContent>
 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 <attribute name="uniqueId" type="{http://www.w3.org/2001/XMLSchema}token" />
 <attribute name="uniqueName" type="{http://www.w3.org/2001/XMLSchema}token" />
 <attribute name="externalId" type="{http://www.w3.org/2001/XMLSchema}token" />
 <attribute name="externalName" type="{http://www.w3.org/2001/XMLSchema}token" />
 <attribute name="repositoryId" type="{http://www.w3.org/2001/XMLSchema}token" />
 </restriction>
 </complexContent>
 </complexType>

The IdentifierType object provides the capability of adding certain properties on an Entity type to distinguish the object. The properties uniqueName and uniqueId are used to uniquely identify an Entity in VMM. Entities that are supported in VMM include the Person and Group.

  • uniqueId: is machine-friendly. i.e., it is not readily recognizable or readily generated by a human. It should be a globally unique identifier generated either by VMM or by the underlying repositories. The client should not interpret the content of uniqueId. The uniqueId property should never change and should not be reused. If an entity is renamed or moved, its uniqueId must remain the same.
  • uniqueName: is human-friendly. It is in the form of an LDAP distinguished name. A distinguished name is a string that includes the location of the entity in the VMM hierarchy, and is formed by concatenating the relative distinguished name of the entity and each of its ancestors all the way to the root. For example, the distinguished name of the person in the container "cn=user,dc=mycompany,dc=com" would be "uid=myUser,cn=users,dc=mycompany,dc=com".
  • externalId: defines the external identifier generated by the underlying repository. Each repository defines it's own unique externalId.

By default, VMM requires the caller to identify an entity by either the uniqueId or uniqueName. If the property externalName is specified, the externalName to used to identify the entity.

  • repositoryId: defines the underlying repository in which this entity exists.

    • Constructor Details

      • IdentifierType

        public IdentifierType()

    • Method Details

      • getUniqueId

        public String getUniqueId()
        Gets the value of the uniqueId property.
        Returns:
        possible object is String

      • setUniqueId

        public void setUniqueId(String value)
        Sets the value of the uniqueId property.
        Parameters:
        value - allowed object is String

      • isSetUniqueId

        public boolean isSetUniqueId()
        Returns true if the uniqueId property is set; false, otherwise.
        Returns:
        returned object is boolean

      • getUniqueName

        public String getUniqueName()
        Gets the value of the uniqueName property.
        Returns:
        possible object is String

      • setUniqueName

        public void setUniqueName(String value)
        Sets the value of the uniqueName property.
        Parameters:
        value - allowed object is String

      • isSetUniqueName

        public boolean isSetUniqueName()
        Returns true if the uniqueName property is set; false, otherwise.
        Returns:
        returned object is boolean

      • getExternalId

        public String getExternalId()
        Gets the value of the externalId property.
        Returns:
        possible object is String

      • setExternalId

        public void setExternalId(String value)
        Sets the value of the externalId property.
        Parameters:
        value - allowed object is String

      • isSetExternalId

        public boolean isSetExternalId()
        Returns true if the externalId property is set; false, otherwise.
        Returns:
        returned object is boolean

      • getExternalName

        public String getExternalName()
        Gets the value of the externalName property.
        Returns:
        possible object is String

      • setExternalName

        public void setExternalName(String value)
        Sets the value of the externalName property.
        Parameters:
        value - allowed object is String

      • isSetExternalName

        public boolean isSetExternalName()
        Returns true if the externalName property is set; false, otherwise.
        Returns:
        returned object is boolean

      • getRepositoryId

        public String getRepositoryId()
        Gets the value of the repositoryId property.
        Returns:
        possible object is String

      • setRepositoryId

        public void setRepositoryId(String value)
        Sets the value of the repositoryId property.
        Parameters:
        value - allowed object is String

      • isSetRepositoryId

        public boolean isSetRepositoryId()
        Returns true if the repositoryId property is set; false, otherwise.
        Returns:
        returned object is boolean

      • get

        public Object get(String propName)
        Gets the value of the requested property
        Parameters:
        propName - allowed object is String
        Returns:
        returned object is Object

      • isSet

        public boolean isSet(String propName)
        Returns true if the requested property is set; false, otherwise.
        Returns:
        returned object is boolean

      • set

        public void set(String propName, Object value)
        Sets the value of the provided property to the provided value.
        Parameters:
        propName - allowed object is String
        value - allowed object is Object

      • unset

        public void unset(String propName)
        Sets the value of provided property to null.
        Parameters:
        propName - allowed object is String

      • getTypeName

        public String getTypeName()
        Gets the name of this model object, IdentifierType
        Returns:
        returned object is String

      • getPropertyNames

        public static List getPropertyNames(String entityTypeName)
        Gets a list of all supported properties for this model object, IdentifierType
        Parameters:
        entityTypeName - allowed object is String
        Returns:
        returned object is List

      • getDataType

        public String getDataType(String propName)
        Gets the Java type of the value of the provided property. For example: String, List
        Parameters:
        propName - allowed object is String
        Returns:
        returned object is String

      • getSuperTypes

        public ArrayList getSuperTypes()
        Gets a list of any model objects which this model object, IdentifierType, is an extension of.
        Returns:
        returned object is ArrayList

      • isSubType

        public boolean isSubType(String superTypeName)
        Returns a true if the provided model object is one that this model object extends; false, otherwise.
        Parameters:
        superTypeName - allowed object is String
        Returns:
        returned object is boolean

      • getSubTypes

        public static HashSet getSubTypes()
        Gets a set of any model objects which extend this model object, IdentifierType
        Returns:
        returned object is HashSet

      • toString

        public String toString()
        Returns this model object, IdentifierType, and its contents as a String
        Overrides:
        toString in class Object
        Returns:
        returned object is String