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

Class Control

java.lang.Object
com.ibm.wsspi.security.wim.model.Control
Direct Known Subclasses:
CacheControl, CheckGroupMembershipControl, DeleteControl, ExternalNameControl, PageControl, PageResponseControl, PropertyControl, SearchResponseControl, SortControl
public abstract class Control extends Object

Java class for Control complex type.

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

 <complexType name="Control">
 <complexContent>
 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 <sequence>
 </sequence>
 </restriction>
 </complexContent>
 </complexType>

The Control object is used for specifying control information in calls to VMM. It can be divided into two categories: request control and response control.

The Request control is sent from client to server within the input Root object. It is used for specifying requesting information. For example, PropertyControl is used for specifying the name of properties needing to be returned for the entity. GroupMembershipControl is used for requesting the groups the entity belongs to.

The Response control is sent from server to client within the output Root object. Response control is used for sending back control information. For example, PageResponseControl is used for sending back the cookie to the client so that the client can send back the cookie to request next page.

The Control object is at the top level of control hierarchy. All other controls are extended from it. The Control object itself is abstract and is not directly used.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Control()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    get(String propName)
    Gets the value of the requested property
    String
    getDataType(String propName)
    Gets the Java type of the value of the provided property.
    static List
    getPropertyNames(String entityTypeName)
    Gets a list of all supported properties for this model object, Control
    static HashSet
    getSubTypes()
    Gets a set of any model objects which extend this model object, Control
    ArrayList
    getSuperTypes()
    Gets a list of any model objects which this model object, Control, is an extension of.
    String
    getTypeName()
    Gets the name of this model object, Control
    boolean
    isSet(String propName)
    Returns true if the requested property is set; false, otherwise.
    boolean
    isSubType(String superTypeName)
    Returns a true if the provided model object is one that this model object extends; false, otherwise.
    void
    set(String propName, Object value)
    Sets the value of the provided property to the provided value.
    String
    toString()
    Returns this model object, Control, and its contents as a String
    void
    unset(String propName)
    Sets the value of provided property to null.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Control

      public Control()

  • Method Details

    • 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, Control
      Returns:
      returned object is String

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)
      Gets a list of all supported properties for this model object, Control
      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, Control, 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, Control
      Returns:
      returned object is HashSet

    • toString

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