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

Class CacheControl

java.lang.Object
com.ibm.wsspi.security.wim.model.Control
com.ibm.wsspi.security.wim.model.CacheControl
public class CacheControl extends Control

Java class for CacheControl complex type.

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

 <complexType name="CacheControl">
 <complexContent>
 <extension base="{http://www.ibm.com/websphere/wim}Control">
 <sequence>
 <element name="mode" type="{http://www.w3.org/2001/XMLSchema}string"/>
 </sequence>
 </extension>
 </complexContent>
 </complexType>

The CacheControl object extends the Control object and defines a single property: mode.

The CacheControl object specifies whether the repository adapter cache should be cleared before an operation is performed and the mode of clearing the cache. The CacheControl object can be passed to the get(), search(), and update() APIs. The LDAP adapter uses the CacheControl to clear its cache; the other out-of-the-box adapters ignore the CacheControl as they not have a cache. If you are using a custom adapter, you can implement its own handling for clearing cache using the CacheControl.

The mode property specifies the mode of clearing the repository adapter cache before an operation is performed. Valid values are:

  • clearEntity: clears the cache for the specified entity. This value does not have any effect on the search() API
  • clearAll: clears all of the cached information in the adapter.

The values are not case-sensitive. There is no default value for this property. If you do not specify a value, or specify a value other than clearEntity or clearAll, an error message appears.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CacheControl()
     

  • 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.
    String
    getMode()
    Gets the value of the mode property.
    static List
    getPropertyNames(String entityTypeName)
    Gets a list of all supported properties for this model object, CacheControl
    static HashSet
    getSubTypes()
    Gets a set of any model objects which extend this model object, CacheControl
    ArrayList
    getSuperTypes()
    Gets a list of any model objects which this model object, CacheControl, is an extension of.
    String
    getTypeName()
    Gets the name of this model object, CacheControl
    boolean
    isSet(String propName)
    Returns true if the requested property is set; false, otherwise.
    boolean
    isSetMode()
    Returns true if the mode 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.
    void
    setMode(String value)
    Sets the value of the mode property.
    String
    toString()
    Returns this model object, CacheControl, 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

    • CacheControl

      public CacheControl()

  • Method Details

    • getMode

      public String getMode()
      Gets the value of the mode property.
      Returns:
      returned object is String

    • setMode

      public void setMode(String value)
      Sets the value of the mode property.
      Parameters:
      value - allowed object is String

    • isSetMode

      public boolean isSetMode()
      Returns true if the mode property is set; false, otherwise.
      Returns:
      returned object is boolean

    • get

      public Object get(String propName)
      Gets the value of the requested property
      Overrides:
      get in class Control
      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.
      Overrides:
      isSet in class Control
      Returns:
      returned object is boolean

    • set

      public void set(String propName, Object value)
      Sets the value of the provided property to the provided value.
      Overrides:
      set in class Control
      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.
      Overrides:
      unset in class Control
      Parameters:
      propName - allowed object is String

    • getTypeName

      public String getTypeName()
      Gets the name of this model object, CacheControl
      Overrides:
      getTypeName in class Control
      Returns:
      returned object is String

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)
      Gets a list of all supported properties for this model object, CacheControl
      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
      Overrides:
      getDataType in class Control
      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, CacheControl, is an extension of.
      Overrides:
      getSuperTypes in class Control
      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.
      Overrides:
      isSubType in class Control
      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, CacheControl
      Returns:
      returned object is HashSet

    • toString

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