com.ibm.wsspi.security.wim.model

Class Root

  • java.lang.Object
    • com.ibm.wsspi.security.wim.model.Root


  • public class Root
    extends java.lang.Object

    Java class for Root complex type.

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

     <complexType name="Root">
     <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
     <sequence>
     <element name="contexts" type="{http://www.ibm.com/websphere/wim}Context" maxOccurs="unbounded" minOccurs="0"/>
     <element name="entities" type="{http://www.ibm.com/websphere/wim}Entity" maxOccurs="unbounded" minOccurs="0"/>
     <element name="controls" type="{http://www.ibm.com/websphere/wim}Control" maxOccurs="unbounded" minOccurs="0"/>
     </sequence>
     <attribute name="validated" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
     </complexContent>
     </complexType>
     

    Root is an object and does not have any meaning other than its use as a container. It has several objects: contexts, entities, and controls, each of which are represented themselves by objects. The Root object can contain an unlimited number of each of these objects.

    • contexts: contains 0 to n Context objects. The Context object specifies the contextual information for the registry or repository call. Examples of such information include the realm or ip address to be used for the call.
    • entities: contains 0 to n Entity objects. Each entity object represents a VMM entity like Person or Group entity. It contains the actual data associated with the entity, like unique name, "uid" and "cn" attributes. Allowing for multiple entities to be specified in the Root object provides the capability of returning multiple Person or Group entries on a single get() API call, for example.
    • controls:: contains 0 to n Controls objects. The Control object is used for specifying the request information and response information for the call. For example, the property names to be returned for a get() API call can be specified in the PropertyControl object.
    • Constructor Detail

      • Root

        public Root()
    • Method Detail

      • getContexts

        public java.util.List<Context> getContexts()
        Gets the value of the contexts property.

        This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the contexts property.

        For example, to add a new item, do as follows:

         getContexts().add(newItem);
         

        Objects of the following type(s) are allowed in the list Context

      • isSetContexts

        public boolean isSetContexts()
      • unsetContexts

        public void unsetContexts()
      • getEntities

        public java.util.List<Entity> getEntities()
        Gets the value of the entities property.

        This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the entities property.

        For example, to add a new item, do as follows:

         getEntities().add(newItem);
         

        Objects of the following type(s) are allowed in the list Entity

      • isSetEntities

        public boolean isSetEntities()
      • unsetEntities

        public void unsetEntities()
      • getControls

        public java.util.List<Control> getControls()
        Gets the value of the controls property.

        This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the controls property.

        For example, to add a new item, do as follows:

         getControls().add(newItem);
         

        Objects of the following type(s) are allowed in the list Control

      • isSetControls

        public boolean isSetControls()
      • unsetControls

        public void unsetControls()
      • isValidated

        public boolean isValidated()
        Gets the value of the validated property.
        Returns:
        possible object is Boolean
      • setValidated

        public void setValidated(boolean value)
        Sets the value of the validated property.
        Parameters:
        value - allowed object is Boolean
      • isSetValidated

        public boolean isSetValidated()
      • unsetValidated

        public void unsetValidated()
      • get

        public java.lang.Object get(java.lang.String propName)
      • isSet

        public boolean isSet(java.lang.String propName)
      • set

        public void set(java.lang.String propName,
               java.lang.Object value)
      • unset

        public void unset(java.lang.String propName)
      • getTypeName

        public java.lang.String getTypeName()
      • getPropertyNames

        public static java.util.List getPropertyNames(java.lang.String entityTypeName)
      • getDataType

        public java.lang.String getDataType(java.lang.String propName)
      • getSuperTypes

        public java.util.ArrayList getSuperTypes()
      • isSubType

        public boolean isSubType(java.lang.String superTypeName)
      • getSubTypes

        public static java.util.HashSet getSubTypes()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object