Class ChangeControl
- java.lang.Object
-
- com.ibm.wsspi.security.wim.model.Control
-
- com.ibm.wsspi.security.wim.model.PropertyControl
-
- com.ibm.wsspi.security.wim.model.SearchControl
-
- com.ibm.wsspi.security.wim.model.ChangeControl
-
public class ChangeControl extends SearchControl
Java class for ChangeControl complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="ChangeControl"> <complexContent> <extension base="{http://www.ibm.com/websphere/wim}SearchControl"> <sequence> <element name="checkPoint" type="{http://www.ibm.com/websphere/wim}CheckPointType" maxOccurs="unbounded" minOccurs="0"/> <element name="changeTypes" type="{http://www.w3.org/2001/XMLSchema}token" maxOccurs="unbounded" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>The ChangeControl object extends the SearchControl object and defines two properties: checkPoint and changeTypes.
The ChangeControl data object provides a client application with the ability to query federated repositories for changed entities, such as new, modified, and deleted entities, from a specified checkpoint onwards.
A client application can use the ChangeControl data object to synchronize its internal cache or other repositories, with the user registry, and provide a secure environment using the latest information in its cache or repositories. *
There could be one or more instances of checkPoint in a ChangeControl data object, depending on the number of repositories involved in a search.
- checkPoint: defines the checkpoint for repositories configured in VMM. It is a list that contains the repositoryId and the repositoryCheckPoint.
- changeTypes: represents the type of changes to return. It is a list of valid change types:
- add: for CHANGETYPE_ADD
- delete: for CHANGETYPE_DELETE
- modify: for CHANGETYPE_MODIFY
- rename: for CHANGETYPE_RENAME
- *: for CHANGETYPE_ALL
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.ibm.wsspi.security.wim.model.PropertyControl
PropertyControl.ContextProperties
-
-
Constructor Summary
Constructors Constructor Description ChangeControl()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Objectget(java.lang.String propName)Gets the value of the requested propertyjava.util.List<java.lang.String>getChangeTypes()Gets the value of the changeTypes property.java.util.List<CheckPointType>getCheckPoint()Gets the value of the checkPoint property.java.lang.StringgetDataType(java.lang.String propName)Gets the Java type of the value of the provided property.static java.util.ListgetPropertyNames(java.lang.String entityTypeName)Gets a list of all supported properties for this model object, ChangeControlstatic java.util.HashSetgetSubTypes()Gets a set of any model objects which extend this model object, ChangeControljava.util.ArrayListgetSuperTypes()Gets a list of any model objects which this model object, ChangeControl, is an extension of.java.lang.StringgetTypeName()Gets the name of this model object, ChangeControlbooleanisSet(java.lang.String propName)Returns true if the requested property is set; false, otherwise.booleanisSetChangeTypes()Returns true if the changeTypes property is set; false, otherwise.booleanisSetCheckPoint()Returns true if the checkPoint property is set; false, otherwise.booleanisSubType(java.lang.String superTypeName)Returns a true if the provided model object is one that this model object extends; false, otherwise.voidset(java.lang.String propName, java.lang.Object value)Sets the value of the provided property to the provided value.java.lang.StringtoString()Returns this model object, ChangeControl, and its contents as a Stringvoidunset(java.lang.String propName)Sets the value of provided property to null.voidunsetChangeTypes()Resets the changeTypes property to null.voidunsetCheckPoint()Resets the checkPoint property to null.-
Methods inherited from class com.ibm.wsspi.security.wim.model.SearchControl
getCountLimit, getExpression, getSearchBases, getSearchLimit, getTimeLimit, isReturnSubType, isSetCountLimit, isSetExpression, isSetReturnSubType, isSetSearchBases, isSetSearchLimit, isSetTimeLimit, setCountLimit, setExpression, setReturnSubType, setSearchLimit, setTimeLimit, unsetCountLimit, unsetReturnSubType, unsetSearchBases, unsetSearchLimit, unsetTimeLimit
-
Methods inherited from class com.ibm.wsspi.security.wim.model.PropertyControl
getContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
-
-
-
-
Method Detail
-
getCheckPoint
public java.util.List<CheckPointType> getCheckPoint()
Gets the value of the checkPoint 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
setmethod for the checkPoint property.For example, to add a new item, do as follows:
getCheckPoint().add(newItem);
Objects of the following type(s) are allowed in the list
CheckPointType
-
isSetCheckPoint
public boolean isSetCheckPoint()
Returns true if the checkPoint property is set; false, otherwise.- Returns:
- returned object is
boolean
-
unsetCheckPoint
public void unsetCheckPoint()
Resets the checkPoint property to null.
-
getChangeTypes
public java.util.List<java.lang.String> getChangeTypes()
Gets the value of the changeTypes 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
setmethod for the changeTypes property.For example, to add a new item, do as follows:
getChangeTypes().add(newItem);
Objects of the following type(s) are allowed in the list
String
-
isSetChangeTypes
public boolean isSetChangeTypes()
Returns true if the changeTypes property is set; false, otherwise.- Returns:
- returned object is
boolean
-
unsetChangeTypes
public void unsetChangeTypes()
Resets the changeTypes property to null.
-
get
public java.lang.Object get(java.lang.String propName)
Gets the value of the requested property- Overrides:
getin classSearchControl- 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.- Overrides:
isSetin classSearchControl- 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.- Overrides:
setin classSearchControl- Parameters:
propName- allowed object isStringvalue- allowed object isObject
-
unset
public void unset(java.lang.String propName)
Sets the value of provided property to null.- Overrides:
unsetin classSearchControl- Parameters:
propName- allowed object isString
-
getTypeName
public java.lang.String getTypeName()
Gets the name of this model object, ChangeControl- Overrides:
getTypeNamein classSearchControl- 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, ChangeControl- 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- Overrides:
getDataTypein classSearchControl- 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, ChangeControl, is an extension of.- Overrides:
getSuperTypesin classSearchControl- 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.- Overrides:
isSubTypein classSearchControl- 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, ChangeControl- Returns:
- returned object is
HashSet
-
toString
public java.lang.String toString()
Returns this model object, ChangeControl, and its contents as a String- Overrides:
toStringin classSearchControl- Returns:
- returned object is
String
-
-