Class Context
- java.lang.Object
-
- com.ibm.wsspi.security.wim.model.Context
-
public class Context extends java.lang.Object
Java class for Context complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="Context"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element name="key" type="{http://www.w3.org/2001/XMLSchema}string"/> <element name="value" type="{http://www.w3.org/2001/XMLSchema}anySimpleType"/> b </sequence> </restriction> </complexContent> </complexType>
The Context object is used for storing contextual information.
A client may communicate contextual information to VMM. For example, when creating a Person, the client application may need to specify the realm to create the Person under. The realm itself is not a part of the Person object's data. Another example is VMM may need the client application to pass in an ip address.
The Context object is used for storing this contextual information. The Context object supports arbitrary key -> object mappings in order to support attributes that are not already pre-defined in the VMM schema
The Context object consists of key-value pair mappings of contextual information.
- key: specifies the name of a contextual property. The following are two examples of possible keys: realm, ipAddress
- value: specifies the value of a contextual property. Since value can be a String or any arbitrary object, the type of the property value is anySimpleType. This property can either be a single value or multi-valued.
-
-
Constructor Summary
Constructors Constructor Description Context()
-
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.java.lang.String
getKey()
Gets the value of the key property.static java.util.List
getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, Contextstatic java.util.HashSet
getSubTypes()
Gets a set of any model objects which extend this model object, Contextjava.util.ArrayList
getSuperTypes()
Gets a list of any model objects which this model object, Context is an extension of.java.lang.String
getTypeName()
Gets the name of this model object, Contextjava.lang.Object
getValue()
Gets the value of the value property.boolean
isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.boolean
isSetKey()
Returns true if the key property is set; false, otherwise.boolean
isSetValue()
Returns true if the value 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.void
setKey(java.lang.String value)
Sets the value of the key property.void
setValue(java.lang.Object value)
Sets the value of the value property.java.lang.String
toString()
Returns this model object, Context, and its contents as a Stringvoid
unset(java.lang.String propName)
Sets the value of provided property to null.
-
-
-
Method Detail
-
getKey
public java.lang.String getKey()
Gets the value of the key property.- Returns:
- possible object is
String
-
setKey
public void setKey(java.lang.String value)
Sets the value of the key property.- Parameters:
value
- allowed object isString
-
isSetKey
public boolean isSetKey()
Returns true if the key property is set; false, otherwise.- Returns:
- returned object is
boolean
-
getValue
public java.lang.Object getValue()
Gets the value of the value property.- Returns:
- possible object is
Object
-
setValue
public void setValue(java.lang.Object value)
Sets the value of the value property.- Parameters:
value
- allowed object isObject
-
isSetValue
public boolean isSetValue()
Returns true if the value property is set; false, otherwise.- Returns:
- returned object is
boolean
-
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, Context- 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, Context- 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, Context 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, Context- Returns:
- returned object is
HashSet
-
toString
public java.lang.String toString()
Returns this model object, Context, and its contents as a String- Overrides:
toString
in classjava.lang.Object
- Returns:
- returned object is
String
-
-