Public Properties

  Name Description
Public property AuditedDeletePrefix Specifies a prefix string to use when deleting a C-Clip using the audited delete function for an ICenteraFixedContentDevice object. If the string is blank, audited delete will not be invoked (FPClip_Delete will be used). Otherwise, the string will be used as the prefix of the delete reason passed to FPClip.AuditedDelete (the document ID GUID is appended to the prefix string to form the complete delete reason text).
Public property BlobReadAheadSize Specifies the maximum buffer size used to determine if the entire content blob should be read with a single call to FPTag_BlobRead. If the content size is less than or equal to the parameter value, the entire blob is read using a single call (a buffer of content size must be allocated), and the data is passed back via the callers data stream as requested. If the content size is greater than the parameter value, FPTag_BlobReadPartial is used to read only the data of the size requested by the caller (no buffer is created).
Public property BlobWriteCollisionsAvoidanceFlag Specifies the collision avoidance option for an ICenteraFixedContentDevice object. When creating Centera content, the provider combines this value with FP_OPTION_CLIENT_CALCID_STREAMING to form the options parameter of FPTag_BlobWrite. There are three possible values:
  • 0: Use the collision avoidance scheme of the Centera system.
  • 64: Override system setting, enable collision avoidance (FP_OPTION_ENABLE_COLLISION_AVOIDANCE).
  • 128: Override system setting, disable collision avoidance (FP_OPTION_DISABLE_COLLISION_AVOIDANCE).
Public property ConcurrentReaders Specifies the maximum number of concurrent Centera reader threads allowed in the object store service process.
Public property DefaultRetentionPassThrough Specifies whether the retention period is set to the current Centera system setting (true) or not (false). This flag only applies when a fixed storage area's retention period is configured to use the retention period of the fixed content device (that is, when the fixed storage area's RetentionPeriod property is set to -2). Normally the provider will examine the value of the FP_RETENTION pool capability and explicitly set the retention period to either zero or infinite, depending on the capability setting. When DefaultRetentionPassThrough is set to 1, the retention period is set to RETENTION_PERIOD_DEFAULT (meaning that the Clips use the current Centera system setting, which can be altered by changing the compliance mode of the system).
Public property EmbeddedDataThreshold Specifies the maximum size threshold in bytes for embedding content in the C-Clip. By default this value is zero (content is never embedded). The maximum value for this parameter is 102400 (bytes). If a greater value is supplied, it will be reduced to 102400 internally by the Centera provider. Note that this limit is per content element. The overall size of embedded data can exceed this limit if multiple content elements are embedded in a single Clip (up to the maximum size of the C-Clip).
Public property FPOpenStrategy Specifies the approach used by FPPool_Open to open connections. Possible values are:
  • 0: Specifies FP_NORMAL_OPEN where FPPool_Open attempts to open connections to all addresses in the connection string and all associated replication addresses. Consider using this strategy if your application performs numerous operations while the pool is open. This option is the default strategy and is equivalent to FP_OPTION_DEFAULT_OPTIONS.
  • 1: Specifies FP_LAZY_OPEN where FPPool_Open opens connections to addresses only as needed. Consider using this strategy if your application frequently opens and closes the pool.
Public property FPPoolBufferSize Specifies the size in bytes of the internal C-Clip buffer. The default value is 16*1024.
Public property FPPoolClusterNonAvailTime Specifies the time in seconds that a cluster is marked as not available before retrying with a probe. Other clusters in the pool will be used while the cluster is unavailable. The default value is 600 (10 minutes).
Public property FPPoolDefaultCollisionAvoidance Indicates whether collision avoidance is enabled at the pool level (true) or not (false). By default, collision avoidance is not enabled. If enabled, an additional blob discriminator for read and write operations of C-Clips and blobs will be used. (BlobWriteCollisionAvoidanceFlag is used in tag write and only applies to blobs.)
Public property FPPoolEnableMulticlusterFailover Specifies whether multi-cluster failover is enabled (true) or not (false). By default, multi-cluster failover is enabled.
Public property FPPoolMaxConnections Specifies the maximum number of sockets that will be allocated. (Sockets are used to communicate with the Centera clusters managed in each pool object.) The default value is 100.
Public property FPPoolMulticlusterDeleteStrategy Specifies the failover strategy for delete operations (FPClip_Delete and FPClip_AuditedDelete) and the deprecated purge operations (FPClip_Purge and FPTag_BlobPurge). Possible values are:
  • 0: FP_NO_STRATEGY (default)
  • 1: FP_FAILOVER_STRATEGY (not supported)
  • 2: FP_REPLICATION_STRATEGY
Public property FPPoolMulticlusterExistsStrategy Specifies the failover strategy for exists operations (FPClip_Exists and FPTag_BlobExists). Possible values are:
  • 0: FP_NO_STRATEGY
  • 1: FP_FAILOVER_STRATEGY (default)
  • 2: FP_REPLICATION_STRATEGY
Public property FPPoolMulticlusterQueryStrategy Specifies the failover strategy for query operations (FPPoolQuery_Open). Possible values are:
  • 0: FP_NO_STRATEGY
  • 1: FP_FAILOVER_STRATEGY (default)
  • 2: FP_REPLICATION_STRATEGY
Public property FPPoolMulticlusterReadStrategy Specifies the failover strategy for read operations (FPClip_Open, FPTag_BlobRead, and FPTag_BlobReadPartial). Possible values are:
  • 0: FP_NO_STRATEGY
  • 1: FP_FAILOVER_STRATEGY
  • 2: FP_REPLICATION_STRATEGY (default)
Public property FPPoolMulticlusterWriteStrategy Specifies the failover strategy for write operations (FPClip_Write and FPTag_BlobWrite). Possible values are:
  • 0: FP_NO_STRATEGY (default)
  • 1: FP_FAILOVER_STRATEGY (not supported)
  • 2: FP_REPLICATION_STRATEGY
Public property FPPoolPrefetchSize Specifies the size of the prefetch buffer. (The buffer is used to assist in determining the size of the blob.) The default size is 32 KB.
Public property FPPoolRetryCount Specifies the number of times an operation will be retried before failure is reported. The default value is 6. If the first execution of the function fails, the system will retry the function 6 more times (for a total of 7 tries).
Public property FPPoolRetrySleep Specifies the time to wait in milliseconds before a failed API function should be retried. If not specified, an exponential back-off scheme is used where the sleep time increases after each retry, starting at 1 second and then doubling after each subsequent try.
Public property FPPoolTimeout Specifies the TCP/IP Connection timeout in milliseconds. The default value is 120000 (2 minutes).
Public property MaxReaderSemaphoreWaitTime Specifies the maximum waiting time in milliseconds to get a read semaphore for a read operation before the system fails the operation.
Public property NeverDeleteClipsOrContent Indicates whether an ICenteraFixedContentDevice object prevents the deletion of Clips or Blobs on the Centera device (true) or not (false). If true, the provider never attempts to delete Clips or Blobs and all content is left completely intact on the Centera device. Note that normally this setting has no impact on enforcement of the retention period (the storage area honors the retention period and prevents deletion when appropriate).
Public property PoolAddress Specifies the Centera pool address that is passed to the FPPool class constructor as the PoolAddress parameter (which identifies the location of the Centera fixed content device). This pool address will be used when the Content Engine server is running within the site identified by the Site property of this object.
Top

See Also