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 java.lang.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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
get(java.lang.String propName)
Gets the value of the requested propertyjava.lang.String
getDataType(java.lang.String propName)
Gets the Java type of the value of the provided property.static java.util.List
getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, Controlstatic java.util.HashSet
getSubTypes()
Gets a set of any model objects which extend this model object, Controljava.util.ArrayList
getSuperTypes()
Gets a list of any model objects which this model object, Control, is an extension of.java.lang.String
getTypeName()
Gets the name of this model object, Controlboolean
isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.boolean
isSubType(java.lang.String superTypeName)
Returns a true if the provided model object is one that this model object extends; false, otherwise.void
set(java.lang.String propName, java.lang.Object value)
Sets the value of the provided property to the provided value.java.lang.String
toString()
Returns this model object, Control, and its contents as a Stringvoid
unset(java.lang.String propName)
Sets the value of provided property to null.
-
-
-
Method Detail
-
get
public java.lang.Object get(java.lang.String propName)
Gets the value of the requested property- Parameters:
propName
- allowed object isString
- Returns:
- returned object is
Object
-
isSet
public boolean isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.- Returns:
- returned object is
boolean
-
set
public void set(java.lang.String propName, java.lang.Object value)
Sets the value of the provided property to the provided value.- Parameters:
propName
- allowed object isString
value
- allowed object isObject
-
unset
public void unset(java.lang.String propName)
Sets the value of provided property to null.- Parameters:
propName
- allowed object isString
-
getTypeName
public java.lang.String getTypeName()
Gets the name of this model object, Control- Returns:
- returned object is
String
-
getPropertyNames
public static java.util.List getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, Control- Parameters:
entityTypeName
- allowed object isString
- Returns:
- returned object is
List
-
getDataType
public java.lang.String getDataType(java.lang.String propName)
Gets the Java type of the value of the provided property. For example: String, List- Parameters:
propName
- allowed object isString
- Returns:
- returned object is
String
-
getSuperTypes
public java.util.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(java.lang.String superTypeName)
Returns a true if the provided model object is one that this model object extends; false, otherwise.- Parameters:
superTypeName
- allowed object isString
- Returns:
- returned object is
boolean
-
getSubTypes
public static java.util.HashSet getSubTypes()
Gets a set of any model objects which extend this model object, Control- Returns:
- returned object is
HashSet
-
toString
public java.lang.String toString()
Returns this model object, Control, and its contents as a String- Overrides:
toString
in classjava.lang.Object
- Returns:
- returned object is
String
-
-