Package org.forgerock.opendj.server.config.client

Interface SoftReferenceEntryCacheCfgClient

All Superinterfaces:
ConfigurationClient, EntryCacheCfgClient
public interface SoftReferenceEntryCacheCfgClient extends EntryCacheCfgClient
A client-side interface for reading and modifying Soft Reference Entry Cache settings.

The Soft Reference Entry Cache is a directory server entry cache implementation that uses soft references to manage objects to allow them to be freed if the JVM is running low on memory.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends SoftReferenceEntryCacheCfgClient,? extends SoftReferenceEntryCacheCfg> definition()
      Get the configuration definition associated with this Soft Reference Entry Cache.
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface EntryCacheCfgClient
      Returns:
      Returns the configuration definition associated with this Soft Reference Entry Cache.

    • getExcludeFilter

      SortedSet<ValueOrExpression<String>> getExcludeFilter()
      Gets the "exclude-filter" property.

      The set of filters that define the entries that should be excluded from the cache.

      Default value is undefined

      Returns:
      Returns the values of the "exclude-filter" property.

    • setExcludeFilter

      void setExcludeFilter(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets the "exclude-filter" property.

      The set of filters that define the entries that should be excluded from the cache.

      Parameters:
      values - The values of the "exclude-filter" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getIncludeFilter

      SortedSet<ValueOrExpression<String>> getIncludeFilter()
      Gets the "include-filter" property.

      The set of filters that define the entries that should be included in the cache.

      Default value is undefined

      Returns:
      Returns the values of the "include-filter" property.

    • setIncludeFilter

      void setIncludeFilter(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets the "include-filter" property.

      The set of filters that define the entries that should be included in the cache.

      Parameters:
      values - The values of the "include-filter" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the Soft Reference Entry Cache implementation.

      Default value: org.opends.server.extensions.SoftReferenceEntryCache

      Specified by:
      getJavaClass in interface EntryCacheCfgClient
      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the Soft Reference Entry Cache implementation.

      Specified by:
      setJavaClass in interface EntryCacheCfgClient
      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getLockTimeout

      ValueOrExpression<Long> getLockTimeout()
      Gets the "lock-timeout" property.

      Specifies the length of time in milliseconds to wait while attempting to acquire a read or write lock.

      Default value: 3000ms

      Returns:
      Returns the value of the "lock-timeout" property.

    • setLockTimeout

      void setLockTimeout(ValueOrExpression<Long> value) throws PropertyException
      Sets the "lock-timeout" property.

      Specifies the length of time in milliseconds to wait while attempting to acquire a read or write lock.

      Parameters:
      value - The value of the "lock-timeout" property.
      Throws:
      PropertyException - If the new value is invalid.