Content Engine Java API: ContentIntegrityOption

java.lang.Object
- com.filenet.api.constants.ContentIntegrityOption

All Implemented Interfaces:

java.io.Serializable
```
public final class ContentIntegrityOption
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that specify how content validation is performed on a storage area. The constants are set as a bitmask on the CmContentIntegrityOptions property of StorageArea.
Content integrity options apply only to an advanced storage area.

See Also:
Advanced storage areas, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ContentIntegrityOption`	`AUTO_REPAIR_ON_RETRIEVAL` Advanced storage area only: If `VALIDATE_ON_RETRIEVAL` is enabled and content retrieval detects invalid content (missing, invalid size, invalid signature), initiate auto repair of the content with the replication sweep.
`static int`	`AUTO_REPAIR_ON_RETRIEVAL_AS_INT` An `int` value associated with the AUTO_REPAIR_ON_RETRIEVAL instance of this class.
`static ContentIntegrityOption`	`AUTO_REPAIR_ON_VALIDATE_CONTENT` Advanced storage area only: If the validateContent API on `StorageArea` detects invalid content (missing, invalid size, invalid signature), initiate auto repair of the content with the replication sweep.
`static int`	`AUTO_REPAIR_ON_VALIDATE_CONTENT_AS_INT` An `int` value associated with the AUTO_REPAIR_ON_VALIDATE_CONTENT instance of this class.
`static ContentIntegrityOption`	`COMPUTE_CONTENT_SIGNATURE` If specified, the content signature is always computed during content upload.
`static int`	`COMPUTE_CONTENT_SIGNATURE_AS_INT` An `int` value associated with the COMPUTE_CONTENT_SIGNATURE instance of this class.
`static ContentIntegrityOption`	`VALIDATE_ON_CREATION` Validates existence and size after content upload.
`static int`	`VALIDATE_ON_CREATION_AS_INT` An `int` value associated with the VALIDATE_ON_CREATION instance of this class.
`static ContentIntegrityOption`	`VALIDATE_ON_RETRIEVAL` Validates existence and size at the beginning of content retrieval (prior to returning content to the end user).
`static int`	`VALIDATE_ON_RETRIEVAL_AS_INT` An `int` value associated with the VALIDATE_ON_RETRIEVAL instance of this class.
`static ContentIntegrityOption`	`VERIFY_SIGNATURE_ON_CREATION` If `VALIDATE_ON_CREATION` is specified and the content signature has been computed, verifies the signature after content upload.
`static int`	`VERIFY_SIGNATURE_ON_CREATION_AS_INT` An `int` value associated with the VERIFY_SIGNATURE_ON_CREATION instance of this class.
`static ContentIntegrityOption`	`VERIFY_SIGNATURE_ON_RETRIEVAL` If `VALIDATE_ON_RETRIEVAL` is specified and the content signature has been computed, verifies the signature prior to returning content to the end user.
`static int`	`VERIFY_SIGNATURE_ON_RETRIEVAL_AS_INT` An `int` value associated with the VERIFY_SIGNATURE_ON_RETRIEVAL instance of this class.
`static ContentIntegrityOption`	`VERIFY_SIGNATURE_ON_VALIDATE_CONTENT` If the content signature has been computed, verifies the signature within the validateContent API on `StorageArea`.
`static int`	`VERIFY_SIGNATURE_ON_VALIDATE_CONTENT_AS_INT` An `int` value associated with the VERIFY_SIGNATURE_ON_VALIDATE_CONTENT instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static ContentIntegrityOption`	`getInstanceFromInt(int value)` Returns an instance of this class using its associated integer value.
`int`	`getValue()` Returns the internal integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this enumeration instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - VALIDATE_ON_RETRIEVAL_AS_INT
```
public static final int VALIDATE_ON_RETRIEVAL_AS_INT
```
    An int value associated with the VALIDATE_ON_RETRIEVAL instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - VALIDATE_ON_RETRIEVAL
```
public static final ContentIntegrityOption VALIDATE_ON_RETRIEVAL
```
    Validates existence and size at the beginning of content retrieval (prior to returning content to the end user). Advanced storage area only: Attempts to retrieve from another replica if the content is determined to be invalid.
  - AUTO_REPAIR_ON_VALIDATE_CONTENT_AS_INT
```
public static final int AUTO_REPAIR_ON_VALIDATE_CONTENT_AS_INT
```
    An int value associated with the AUTO_REPAIR_ON_VALIDATE_CONTENT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - AUTO_REPAIR_ON_VALIDATE_CONTENT
```
public static final ContentIntegrityOption AUTO_REPAIR_ON_VALIDATE_CONTENT
```
    Advanced storage area only: If the validateContent API on StorageArea detects invalid content (missing, invalid size, invalid signature), initiate auto repair of the content with the replication sweep. Note that signature validation is only applied if the signature has been computed and the VERIFY_SIGNATURE_ON_VALIDATE_CONTENT option is specified.
  - VALIDATE_ON_CREATION_AS_INT
```
public static final int VALIDATE_ON_CREATION_AS_INT
```
    An int value associated with the VALIDATE_ON_CREATION instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - VALIDATE_ON_CREATION
```
public static final ContentIntegrityOption VALIDATE_ON_CREATION
```
    Validates existence and size after content upload. Advanced storage area only: Validates existence and size after content replication (target replica).
  - COMPUTE_CONTENT_SIGNATURE_AS_INT
```
public static final int COMPUTE_CONTENT_SIGNATURE_AS_INT
```
    An int value associated with the COMPUTE_CONTENT_SIGNATURE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - COMPUTE_CONTENT_SIGNATURE
```
public static final ContentIntegrityOption COMPUTE_CONTENT_SIGNATURE
```
    If specified, the content signature is always computed during content upload.
  - VERIFY_SIGNATURE_ON_RETRIEVAL_AS_INT
```
public static final int VERIFY_SIGNATURE_ON_RETRIEVAL_AS_INT
```
    An int value associated with the VERIFY_SIGNATURE_ON_RETRIEVAL instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - VERIFY_SIGNATURE_ON_RETRIEVAL
```
public static final ContentIntegrityOption VERIFY_SIGNATURE_ON_RETRIEVAL
```
    If VALIDATE_ON_RETRIEVAL is specified and the content signature has been computed, verifies the signature prior to returning content to the end user. The content signature is computed if either content de-duplication is enabled on StorageArea, or if the COMPUTE_CONTENT_SIGNATURE option is enabled. Advanced storage area only: Attempts to retrieve from another replica if the content is determined to be invalid.
  - VERIFY_SIGNATURE_ON_VALIDATE_CONTENT_AS_INT
```
public static final int VERIFY_SIGNATURE_ON_VALIDATE_CONTENT_AS_INT
```
    An int value associated with the VERIFY_SIGNATURE_ON_VALIDATE_CONTENT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - VERIFY_SIGNATURE_ON_VALIDATE_CONTENT
```
public static final ContentIntegrityOption VERIFY_SIGNATURE_ON_VALIDATE_CONTENT
```
    If the content signature has been computed, verifies the signature within the validateContent API on StorageArea. The content signature is computed if either content de-duplication is enabled on StorageArea, or if the COMPUTE_CONTENT_SIGNATURE option is enabled.
  - AUTO_REPAIR_ON_RETRIEVAL_AS_INT
```
public static final int AUTO_REPAIR_ON_RETRIEVAL_AS_INT
```
    An int value associated with the AUTO_REPAIR_ON_RETRIEVAL instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - AUTO_REPAIR_ON_RETRIEVAL
```
public static final ContentIntegrityOption AUTO_REPAIR_ON_RETRIEVAL
```
    Advanced storage area only: If VALIDATE_ON_RETRIEVAL is enabled and content retrieval detects invalid content (missing, invalid size, invalid signature), initiate auto repair of the content with the replication sweep. Note that signature validation is only applied if the signature has been computed and the VERIFY_SIGNATURE_ON_VALIDATE_CONTENT option is specified.
  - VERIFY_SIGNATURE_ON_CREATION_AS_INT
```
public static final int VERIFY_SIGNATURE_ON_CREATION_AS_INT
```
    An int value associated with the VERIFY_SIGNATURE_ON_CREATION instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - VERIFY_SIGNATURE_ON_CREATION
```
public static final ContentIntegrityOption VERIFY_SIGNATURE_ON_CREATION
```
    If VALIDATE_ON_CREATION is specified and the content signature has been computed, verifies the signature after content upload. The content signature is computed if either content de-duplication is enabled on StorageArea, or if the COMPUTE_CONTENT_SIGNATURE option is enabled. Advanced storage area only: Applies the same logic to content replication.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns the internal integer value associated with a specific instance of this class.
    
    Returns:
    The enumeration instance's ordinal value.
    See Also:
    getInstanceFromInt(int)
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The enumeration instance's description.
  - getInstanceFromInt
```
public static ContentIntegrityOption getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated integer value.
    
    Parameters:
    value - The integer value. (See the *_AS_INT fields.)
    
    Returns:
    The enumeration instance with the given ordinal value.
    
    Throws:
    
    EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
    See Also:
    getValue()

Methods inherited from class java.lang.Object

VALIDATE_ON_RETRIEVAL_AS_INT

VALIDATE_ON_RETRIEVAL

AUTO_REPAIR_ON_VALIDATE_CONTENT_AS_INT

AUTO_REPAIR_ON_VALIDATE_CONTENT

VALIDATE_ON_CREATION_AS_INT

VALIDATE_ON_CREATION

COMPUTE_CONTENT_SIGNATURE_AS_INT

COMPUTE_CONTENT_SIGNATURE

VERIFY_SIGNATURE_ON_RETRIEVAL_AS_INT

VERIFY_SIGNATURE_ON_RETRIEVAL

VERIFY_SIGNATURE_ON_VALIDATE_CONTENT_AS_INT

VERIFY_SIGNATURE_ON_VALIDATE_CONTENT

AUTO_REPAIR_ON_RETRIEVAL_AS_INT

AUTO_REPAIR_ON_RETRIEVAL

VERIFY_SIGNATURE_ON_CREATION_AS_INT

VERIFY_SIGNATURE_ON_CREATION

getValue

toString

getInstanceFromInt