com.filenet.api.admin

Interface ContentConfiguration

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

    public interface ContentConfiguration
extends SubsystemConfiguration, DependentObject
    Configures the Content Management Subsystem. The Content Management Subsystem is the part of the Content Engine Object Store Service that is responsible for adding and retrieving document content to and from managed storage areas in response to client requests. The ContentConfiguration interface allows the operation of the Content Management Subsystem to be tuned for the local environment in which it is executing.

    Just as it must do for all other client requests involving the creation, update, or deletion of data in an object store, the Object Store Service must also guarantee transactional integrity with respect to adding content. Guaranteeing the transactional integrity of content upload and storage is one of the primary functions of the Content Management Subsystem.

    In order to make this guarantee, the process of adding content is divided into two stages: stage one involves copying content into a temporary location on the server, and stage two is primarily concerned with copying the content to its permanent location.

    Stage one occurs within the context of a client initiated transaction involving content upload; for example, checking in a document. In this stage, the content associated with the object or objects participating in the transaction is copied from the client to a temporary location that is associated with the designated storage area in which the content will ultimately be stored. This temporary location may be a specially designated file system directory, sometimes referred to as the "inbound directory", or it might be a table in the database. The type of temporary storage depends on the destination storage area type. Any metadata changes associated with the participating objects are also carried out during this stage.

    At the conclusion of the first stage of the operation, the transaction must be committed in order to make the changes durable. Committing the transaction includes adding a message to the ContentQueue, when processed, that will result in the second stage of the operation to be executed. The fact that the transaction has been committed after stage one necessarily implies that the server guarantees that the second stage will be carried out -- even in the event of server disruptions, power failures, etc.

    It is important to note that after a transaction involving content upload has been committed, that is, after stage one has completed, the new content has functionally been added to the storage area; a user can retrieve (or perform any other legal operation) on the new content just like any other content in the storage area, despite the fact that it may actually still reside in the temporary storage location.

    At the conclusion of stage one of the operation or at anytime during its execution, the transaction can also be aborted and, therefore, must be rolled back. Rolling back a transaction means guaranteeing that any intermediate changes that occurred during the execution of the transaction will be undone so that the system is restored to the state that it was in prior to the transaction. It also guarantees that none of these changes will be visible to any other transaction while they are being cleaned up.

    With respect to content upload, there are two categories of changes that need to be undone: metadata and content that has been copied to the temporary storage area. The cleanup of the former is handled by the normal transaction processing mechanisms provided by the Object Store Service, but the latter is a special case and is managed by the Content Management Subsystem. The way it works is temporary content is flagged as abandoned. While it is in this state, it is invisible to clients and is effectively not there from the client's point of view. The Content Management Subsystem then periodically sweeps the temporary storage areas and deletes all abandoned content.

    Many of the functions of the Content Management Subsystem described above are parameterized such that their behavior can be modified. This is the purpose of the ContentConfiguration interface: to expose those aspects of content operations that can be adjusted in order to optimize the performance of the Object Store Service within a given operational environment.

    Metadata

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

    • Method Detail

      • get_DispatcherWaitInterval

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

      • set_DispatcherWaitInterval

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

      • get_ContentQueueMaxWorkerThreads

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

      • set_ContentQueueMaxWorkerThreads

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

      • get_DatabaseContentUploadBufferSize

        java.lang.Integer get_DatabaseContentUploadBufferSize()
        Deprecated. As of release 5.1.0.
        Returns the value of the DatabaseContentUploadBufferSize property. For more information, see DatabaseContentUploadBufferSize Property.

      • set_DatabaseContentUploadBufferSize

        void set_DatabaseContentUploadBufferSize(java.lang.Integer value)
        Deprecated. As of release 5.1.0.
        Sets the value of the DatabaseContentUploadBufferSize property. For more information, see DatabaseContentUploadBufferSize Property.

      • get_InlineContentRetrievalLimit

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

      • set_InlineContentRetrievalLimit

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

      • get_ContentTempDirectoryRoot

        java.lang.String get_ContentTempDirectoryRoot()
        Returns the value of the ContentTempDirectoryRoot property. For more information, see ContentTempDirectoryRoot Property.

      • set_ContentTempDirectoryRoot

        void set_ContentTempDirectoryRoot(java.lang.String value)
        Sets the value of the ContentTempDirectoryRoot property. For more information, see ContentTempDirectoryRoot Property.

      • get_LeaseDuration

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

      • set_LeaseDuration

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

      • get_ExpiredBatchSelectionSize

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

      • set_ExpiredBatchSelectionSize

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

      • get_MaxInMemoryQueueItems

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

      • set_MaxInMemoryQueueItems

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

      • get_RollFwdBatchRetryAttempts

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

      • set_RollFwdBatchRetryAttempts

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

      • get_MaxResolutionBatchSize

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

      • set_MaxResolutionBatchSize

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

      • get_PartialResolutionChunkSize

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

      • set_PartialResolutionChunkSize

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

      • get_RetrievalRetryAttempts

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

      • set_RetrievalRetryAttempts

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

      • get_RenameFileRetryAttempts

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

      • set_RenameFileRetryAttempts

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

      • get_InboundFileNameCacheMaxEntries

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

      • set_InboundFileNameCacheMaxEntries

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

      • get_AbandonedContentCleanupInterval

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

      • set_AbandonedContentCleanupInterval

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

      • get_TempFileLifetime

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

      • set_TempFileLifetime

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

      • get_AbandonedDBContentCleanupInterval

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

      • set_AbandonedDBContentCleanupInterval

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

      • get_TempDBContentLifetime

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

      • set_TempDBContentLifetime

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

      • get_CompressionBlockSize

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

      • set_CompressionBlockSize

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

      • get_ThumbnailGenerationBatchSize

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

      • set_ThumbnailGenerationBatchSize

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

      • get_MaxThumbnailGenerationProcesses

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

      • set_MaxThumbnailGenerationProcesses

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

      • get_ThumbnailGenerationProcessTimeOut

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

      • set_ThumbnailGenerationProcessTimeOut

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

      • get_ThumbnailGenerationTempDir

        java.lang.String get_ThumbnailGenerationTempDir()
        Returns the value of the ThumbnailGenerationTempDir property. For more information, see ThumbnailGenerationTempDir Property.

      • set_ThumbnailGenerationTempDir

        void set_ThumbnailGenerationTempDir(java.lang.String value)
        Sets the value of the ThumbnailGenerationTempDir property. For more information, see ThumbnailGenerationTempDir Property.

      • get_AbandonedThumbnailCleanupInterval

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

      • set_AbandonedThumbnailCleanupInterval

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

      • get_ThumbnailTempFileLifeTime

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

      • set_ThumbnailTempFileLifeTime

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

      • get_ThumbnailGenerationDelay

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

      • set_ThumbnailGenerationDelay

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

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