com.filenet.api.admin

Interface ServerCacheConfiguration

  • All Superinterfaces:
    DependentObject, EngineObject, java.io.Serializable, SubsystemConfiguration

    public interface ServerCacheConfiguration
extends SubsystemConfiguration, DependentObject
    Defines configuration options for all server caches that do not have object store-specific characteristics. The options apply to the following caches: code module cache, GCD cache, marking set cache, metadata cache, subject cache, and user token cache. Options include a time-to-live (TTL) value for managing cache entry residency and a value that, when exceeded, triggers cache refresh activity on a least-recently-used basis. (Object store-related cache options, such as folder cache TTL and object security cache attributes, are set at the object store level.)

    The ServerCacheConfiguration object is contained in the SubsystemConfigurationList property of the server hierarchy objects (Domain, Site, Virtual Server, and ServerInstance). To access a ServerCacheConfiguration object, call get_SubsystemConfigurations to retrieve the SubsystemConfigurationList from the "host" independent object, then iterate the returned list.

    To create a new instance, call Factory.ServerCacheConfiguration.createInstance and add the new object to the SubsystemConfigurationList of the appropriate server hierarchy object. (Note: The SubsystemConfigurationList of the Domain object cannot be modified. To update its ServerCacheConfiguration object, locate the pre-existing object in the list and update it.) The created object is a dependent object and is only persisted when its parent object (the independently persistable object that references it) is persisted.

    The ServerCacheConfiguration object is associated with a Domain, Site, Virtual Server, or ServerInstance object. The values of the cache configuration properties are used while the FileNet P8 system is running and override the default values defined at installation time.

    Metadata

    Auditable: false
    AllowsInstances: true
    AllowsSubClasses: false
    ClassDefinitionName: None
    IsDependent: true
    IsHidden: false
    Searchable: false
    StorageType: Domain
    SuperclassName: SubsystemConfiguration

    • Method Detail

      • get_GCDCacheTTL

        java.lang.Integer get_GCDCacheTTL()
        Returns the value of the GCDCacheTTL property. For more information, see GCDCacheTTL Property.

      • set_GCDCacheTTL

        void set_GCDCacheTTL(java.lang.Integer value)
        Sets the value of the GCDCacheTTL property. For more information, see GCDCacheTTL Property.

      • get_CodeModuleCacheEntryTTL

        java.lang.Integer get_CodeModuleCacheEntryTTL()
        Returns the value of the CodeModuleCacheEntryTTL property. For more information, see CodeModuleCacheEntryTTL Property.

      • set_CodeModuleCacheEntryTTL

        void set_CodeModuleCacheEntryTTL(java.lang.Integer value)
        Sets the value of the CodeModuleCacheEntryTTL property. For more information, see CodeModuleCacheEntryTTL Property.

      • get_CodeModuleCacheMaxMemory

        java.lang.Integer get_CodeModuleCacheMaxMemory()
        Returns the value of the CodeModuleCacheMaxMemory property. For more information, see CodeModuleCacheMaxMemory Property.

      • set_CodeModuleCacheMaxMemory

        void set_CodeModuleCacheMaxMemory(java.lang.Integer value)
        Sets the value of the CodeModuleCacheMaxMemory property. For more information, see CodeModuleCacheMaxMemory Property.

      • get_CodeModuleCacheMaxFileSpace

        java.lang.Integer get_CodeModuleCacheMaxFileSpace()
        Returns the value of the CodeModuleCacheMaxFileSpace property. For more information, see CodeModuleCacheMaxFileSpace Property.

      • set_CodeModuleCacheMaxFileSpace

        void set_CodeModuleCacheMaxFileSpace(java.lang.Integer value)
        Sets the value of the CodeModuleCacheMaxFileSpace property. For more information, see CodeModuleCacheMaxFileSpace Property.

      • get_MarkingSetCacheMaxEntries

        java.lang.Integer get_MarkingSetCacheMaxEntries()
        Returns the value of the MarkingSetCacheMaxEntries property. For more information, see MarkingSetCacheMaxEntries Property.

      • set_MarkingSetCacheMaxEntries

        void set_MarkingSetCacheMaxEntries(java.lang.Integer value)
        Sets the value of the MarkingSetCacheMaxEntries property. For more information, see MarkingSetCacheMaxEntries Property.

      • get_MarkingSetCacheEntryTTL

        java.lang.Integer get_MarkingSetCacheEntryTTL()
        Returns the value of the MarkingSetCacheEntryTTL property. For more information, see MarkingSetCacheEntryTTL Property.

      • set_MarkingSetCacheEntryTTL

        void set_MarkingSetCacheEntryTTL(java.lang.Integer value)
        Sets the value of the MarkingSetCacheEntryTTL property. For more information, see MarkingSetCacheEntryTTL Property.

      • get_UserTokenCacheMaxEntries

        java.lang.Integer get_UserTokenCacheMaxEntries()
        Returns the value of the UserTokenCacheMaxEntries property. For more information, see UserTokenCacheMaxEntries Property.

      • set_UserTokenCacheMaxEntries

        void set_UserTokenCacheMaxEntries(java.lang.Integer value)
        Sets the value of the UserTokenCacheMaxEntries property. For more information, see UserTokenCacheMaxEntries Property.

      • get_UserTokenCacheEntryTTL

        java.lang.Integer get_UserTokenCacheEntryTTL()
        Returns the value of the UserTokenCacheEntryTTL property. For more information, see UserTokenCacheEntryTTL Property.

      • set_UserTokenCacheEntryTTL

        void set_UserTokenCacheEntryTTL(java.lang.Integer value)
        Sets the value of the UserTokenCacheEntryTTL property. For more information, see UserTokenCacheEntryTTL Property.

      • get_SubjectCacheMaxEntries

        java.lang.Integer get_SubjectCacheMaxEntries()
        Returns the value of the SubjectCacheMaxEntries property. For more information, see SubjectCacheMaxEntries Property.

      • set_SubjectCacheMaxEntries

        void set_SubjectCacheMaxEntries(java.lang.Integer value)
        Sets the value of the SubjectCacheMaxEntries property. For more information, see SubjectCacheMaxEntries Property.

      • get_SubjectCacheEntryTTL

        java.lang.Integer get_SubjectCacheEntryTTL()
        Returns the value of the SubjectCacheEntryTTL property. For more information, see SubjectCacheEntryTTL Property.

      • set_SubjectCacheEntryTTL

        void set_SubjectCacheEntryTTL(java.lang.Integer value)
        Sets the value of the SubjectCacheEntryTTL property. For more information, see SubjectCacheEntryTTL Property.

      • get_MetadataMergedScopeCacheMaxEntries

        java.lang.Integer get_MetadataMergedScopeCacheMaxEntries()
        Returns the value of the MetadataMergedScopeCacheMaxEntries property. For more information, see MetadataMergedScopeCacheMaxEntries Property.

      • set_MetadataMergedScopeCacheMaxEntries

        void set_MetadataMergedScopeCacheMaxEntries(java.lang.Integer value)
        Sets the value of the MetadataMergedScopeCacheMaxEntries property. For more information, see MetadataMergedScopeCacheMaxEntries Property.

      • get_QueryPageMaxSize

        java.lang.Integer get_QueryPageMaxSize()
        Returns the value of the QueryPageMaxSize property. For more information, see QueryPageMaxSize Property.

      • set_QueryPageMaxSize

        void set_QueryPageMaxSize(java.lang.Integer value)
        Sets the value of the QueryPageMaxSize property. For more information, see QueryPageMaxSize Property.

      • get_QueryPageDefaultSize

        java.lang.Integer get_QueryPageDefaultSize()
        Returns the value of the QueryPageDefaultSize property. For more information, see QueryPageDefaultSize Property.

      • set_QueryPageDefaultSize

        void set_QueryPageDefaultSize(java.lang.Integer value)
        Sets the value of the QueryPageDefaultSize property. For more information, see QueryPageDefaultSize Property.

      • get_NonPagedQueryMaxSize

        java.lang.Integer get_NonPagedQueryMaxSize()
        Returns the value of the NonPagedQueryMaxSize property. For more information, see NonPagedQueryMaxSize Property.

      • set_NonPagedQueryMaxSize

        void set_NonPagedQueryMaxSize(java.lang.Integer value)
        Sets the value of the NonPagedQueryMaxSize property. For more information, see NonPagedQueryMaxSize Property.

      • get_PrincipalCacheMaxEntries

        java.lang.Integer get_PrincipalCacheMaxEntries()
        Returns the value of the PrincipalCacheMaxEntries property. For more information, see PrincipalCacheMaxEntries Property.

      • set_PrincipalCacheMaxEntries

        void set_PrincipalCacheMaxEntries(java.lang.Integer value)
        Sets the value of the PrincipalCacheMaxEntries property. For more information, see PrincipalCacheMaxEntries Property.

      • get_PrincipalCacheEntryTTL

        java.lang.Integer get_PrincipalCacheEntryTTL()
        Returns the value of the PrincipalCacheEntryTTL property. For more information, see PrincipalCacheEntryTTL Property.

      • set_PrincipalCacheEntryTTL

        void set_PrincipalCacheEntryTTL(java.lang.Integer value)
        Sets the value of the PrincipalCacheEntryTTL property. For more information, see PrincipalCacheEntryTTL Property.

      • get_QueryCountMaxSize

        java.lang.Integer get_QueryCountMaxSize()
        Returns the value of the QueryCountMaxSize property. For more information, see QueryCountMaxSize Property.

      • set_QueryCountMaxSize

        void set_QueryCountMaxSize(java.lang.Integer value)
        Sets the value of the QueryCountMaxSize property. For more information, see QueryCountMaxSize Property.

      • get_QueryCountDefaultSize

        java.lang.Integer get_QueryCountDefaultSize()
        Returns the value of the QueryCountDefaultSize property. For more information, see QueryCountDefaultSize Property.

      • set_QueryCountDefaultSize

        void set_QueryCountDefaultSize(java.lang.Integer value)
        Sets the value of the QueryCountDefaultSize property. For more information, see QueryCountDefaultSize Property.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

© Copyright IBM Corporation 2006, 2013. All rights reserved.