java.lang.Object
- com.attivio.sdk.error.ErrorCode
- - com.attivio.sdk.error.IndexEngineError

All Implemented Interfaces:

java.io.Serializable
```
public final class IndexEngineError
extends ErrorCode
```
Contains error codes related to the index engine.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static ErrorCode`	`ACQUIRE_FAILED`	INDEX_ENGINE-30 Failed to acquire lock.
`static ErrorCode`	`ADD_FAILED`	INDEX_ENGINE-5 Indicates that an exception was encountered while adding a document to the index.
`static ErrorCode`	`AUDIT_ERROR`	INDEX_ENGINE-45 Error occurred while writing audit record.
`static ErrorCode`	`BACKUP_FAILED`	INDEX_ENGINE-24 Indicates that performing a backup failed.
`static ErrorCode`	`BULK_UPDATE_ERROR`	INDEX_ENGINE-35 Error while applying a bulk update.
`static ErrorCode`	`CHECK_FAILED`	INDEX_ENGINE-27 Failed to check an index.
`static ErrorCode`	`CLEAR_FAILED`	INDEX_ENGINE-7 Indicates that an exception was encountered while clearing the index.
`static ErrorCode`	`CLOSE_FAILED`	INDEX_ENGINE-18 Failed to close an index.
`static ErrorCode`	`COMMIT_FAILED`	INDEX_ENGINE-9 Indicates that an exception was encountered while committing the index.
`static ErrorCode`	`CORRUPT_INDEX`	INDEX_ENGINE-25 Index is corrupted.
`static ErrorCode`	`CREATING_INDEX`	INDEX_ENGINE-19 Index did not exist and is being created.
`static ErrorCode`	`DELETE_BY_QUERY_FAILED`	INDEX_ENGINE-8 Indicates that an exception was encountered while deleting documents from the index given a query.
`static ErrorCode`	`DELETE_FAILED`	INDEX_ENGINE-6 Indicates that an exception was encountered while deleting a document from the index.
`static ErrorCode`	`DELETE_UNUSED_FILES_ERROR`	INDEX_ENGINE-54 Error occurred while deleting unused files from the index.
`static ErrorCode`	`ELECTION_ERROR`	INDEX_ENGINE-38 Index error occurred registering for election.
`static ErrorCode`	`EVENT_HANDLER_ERROR`	INDEX_ENGINE-11 An error occurred initializing an event handler.
`static ErrorCode`	`EXTRACT_ERROR`	INDEX_ENGINE-16 Failed to extract data from an index.
`static ErrorCode`	`FATAL_ERROR`	INDEX_ENGINE-41 Fatal indexing error occurred.
`static ErrorCode`	`GENERATION_WARMUP_FAILED`	INDEX_ENGINE-15 Failed to warm up search generation post commit.
`static ErrorCode`	`ILLEGAL_DOCUMENT_ID`	INDEX_ENGINE-21 Indicates a document was added with an illegal document ID.
`static ErrorCode`	`INDEXING_FAILED`	INDEX_ENGINE-2 Indicates that an exception was encountered during indexing of a message list.
`static ErrorCode`	`INFO_STREAM_ERROR`	INDEX_ENGINE-31 Failed to open info stream for tracing internal indexing activity.
`static ErrorCode`	`INITIALIZE_INDEX_FAILED`	INDEX_ENGINE-20 Failed to initialize index.
`static ErrorCode`	`INVALID_FIELD_CONTENT`	INDEX_ENGINE-4 Indicates that a field contained invalid content.
`static ErrorCode`	`LEASE_EXPIRATION_ERROR`	INDEX_ENGINE-53 Failed to delete expired lease for index commit point.
`static ErrorCode`	`LOCK_ERROR`	INDEX_ENGINE-49 Failed to acquire lock for index.
`static ErrorCode`	`LOG_PROCESS_ERROR`	INDEX_ENGINE-43 Error occurred while processing a message from the transaction log.
`static ErrorCode`	`LOG_READ_ERROR`	INDEX_ENGINE-42 Error occurred while reading message from transaction log.
`static ErrorCode`	`LOG_WRITE_ERROR`	INDEX_ENGINE-44 Error occurred while writing transaction log.
`static ErrorCode`	`MERGE_ERROR`	INDEX_ENGINE-34 Index merge failed.
`static ErrorCode`	`MISSING_END_ELEMENT`	INDEX_ENGINE-51 END_ELEMENT token for scope missing.
`static ErrorCode`	`MISSING_START_ELEMENT`	INDEX_ENGINE-50 START_ELEMENT token for scope missing.
`static ErrorCode`	`NOT_OPEN`	INDEX_ENGINE-28 The index is not open for updates.
`static ErrorCode`	`NOT_RECEIVING`	INDEX_ENGINE-37 Index is not currently receiving updates.
`static ErrorCode`	`NOT_SUPPORTED`	INDEX_ENGINE-39 A feature is not supported/enabled for an index.
`static ErrorCode`	`NULL_DOC`	INDEX_ENGINE-3 Indicates that a null document was sent to the indexer.
`static ErrorCode`	`OFFLINE_ERROR`	INDEX_ENGINE-23 Index engine is offline and not processing messages.
`static ErrorCode`	`OPEN_FAILED`	INDEX_ENGINE-17 Failed to open an index.
`static ErrorCode`	`OPTIMIZE_FAILED`	INDEX_ENGINE-1 Indicates that an exception was encountered while optimizing the index.
`static ErrorCode`	`POST_COMMIT_EVENT_FAILED`	INDEX_ENGINE-12 The postCommit() method failed on an event handler.
`static ErrorCode`	`POST_OPTIMIZE_EVENT_FAILED`	INDEX_ENGINE-13 The postOptimize() method failed on an event handler.
`static ErrorCode`	`PROFILER_ERROR`	INDEX_ENGINE-52 Error profiling index engine.
`static ErrorCode`	`REPAIR_INDEX`	INDEX_ENGINE-26 Corrupted index is being repaired (may result in losing documents).
`static ErrorCode`	`RESTORE_FAILED`	INDEX_ENGINE-29 Failed to restore an index.
`static ErrorCode`	`SHUTDOWN_ERROR`	INDEX_ENGINE-14 Engine shutdown encountered an error.
`static ErrorCode`	`SHUTDOWN_HOOK_ERROR`	INDEX_ENGINE-47 Error with shutdown hook registration.
`static ErrorCode`	`SINGLE_VALUE_ERROR`	INDEX_ENGINE-36 Error indexing single value field.
`static ErrorCode`	`SNAPSHOT_ERROR`	INDEX_ENGINE-48 General index snapshot error.
`static ErrorCode`	`STORAGE_ERROR`	INDEX_ENGINE-55 Error occurred while writing data to index storage.
`static ErrorCode`	`TOKEN_TOO_LONG`	INDEX_ENGINE-33 Indicates that a field contained a token longer than the maximum token length.
`static ErrorCode`	`TOKENIZATION_WARNING`	INDEX_ENGINE-40 Non fatal error with tokenization.
`static ErrorCode`	`TOO_MANY_TOKENS`	INDEX_ENGINE-32 Indicates that a field contained more tokens than the configured maximum.
`static ErrorCode`	`UNSUPPORTED_EVENT_HANDLER`	INDEX_ENGINE-10 An event handler is unsupported by the search engine.
`static ErrorCode`	`ZONE_ROUTING_ERROR`	INDEX_ENGINE-46 Error while determining zone routing for document.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`formatError(java.util.Locale locale, java.lang.String... context)`	Format a contextual error message.

Methods inherited from class com.attivio.sdk.error.ErrorCode
equals, getCategory, getCode, getErrorCode, hashCode, readResolve, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - OPTIMIZE_FAILED
```
public static final ErrorCode OPTIMIZE_FAILED
```
    INDEX_ENGINE-1 Indicates that an exception was encountered while optimizing the index.
  - INDEXING_FAILED
```
public static final ErrorCode INDEXING_FAILED
```
    INDEX_ENGINE-2 Indicates that an exception was encountered during indexing of a message list.
  - NULL_DOC
```
public static final ErrorCode NULL_DOC
```
    INDEX_ENGINE-3 Indicates that a null document was sent to the indexer.
  - INVALID_FIELD_CONTENT
```
public static final ErrorCode INVALID_FIELD_CONTENT
```
    INDEX_ENGINE-4 Indicates that a field contained invalid content.
  - ADD_FAILED
```
public static final ErrorCode ADD_FAILED
```
    INDEX_ENGINE-5 Indicates that an exception was encountered while adding a document to the index.
  - DELETE_FAILED
```
public static final ErrorCode DELETE_FAILED
```
    INDEX_ENGINE-6 Indicates that an exception was encountered while deleting a document from the index.
  - CLEAR_FAILED
```
public static final ErrorCode CLEAR_FAILED
```
    INDEX_ENGINE-7 Indicates that an exception was encountered while clearing the index.
  - DELETE_BY_QUERY_FAILED
```
public static final ErrorCode DELETE_BY_QUERY_FAILED
```
    INDEX_ENGINE-8 Indicates that an exception was encountered while deleting documents from the index given a query.
  - COMMIT_FAILED
```
public static final ErrorCode COMMIT_FAILED
```
    INDEX_ENGINE-9 Indicates that an exception was encountered while committing the index.
  - UNSUPPORTED_EVENT_HANDLER
```
public static final ErrorCode UNSUPPORTED_EVENT_HANDLER
```
    INDEX_ENGINE-10 An event handler is unsupported by the search engine.
  - EVENT_HANDLER_ERROR
```
public static final ErrorCode EVENT_HANDLER_ERROR
```
    INDEX_ENGINE-11 An error occurred initializing an event handler.
  - POST_COMMIT_EVENT_FAILED
```
public static final ErrorCode POST_COMMIT_EVENT_FAILED
```
    INDEX_ENGINE-12 The postCommit() method failed on an event handler.
  - POST_OPTIMIZE_EVENT_FAILED
```
public static final ErrorCode POST_OPTIMIZE_EVENT_FAILED
```
    INDEX_ENGINE-13 The postOptimize() method failed on an event handler.
  - SHUTDOWN_ERROR
```
public static final ErrorCode SHUTDOWN_ERROR
```
    INDEX_ENGINE-14 Engine shutdown encountered an error.
  - GENERATION_WARMUP_FAILED
```
public static final ErrorCode GENERATION_WARMUP_FAILED
```
    INDEX_ENGINE-15 Failed to warm up search generation post commit.
  - EXTRACT_ERROR
```
public static final ErrorCode EXTRACT_ERROR
```
    INDEX_ENGINE-16 Failed to extract data from an index.
  - OPEN_FAILED
```
public static final ErrorCode OPEN_FAILED
```
    INDEX_ENGINE-17 Failed to open an index.
  - CLOSE_FAILED
```
public static final ErrorCode CLOSE_FAILED
```
    INDEX_ENGINE-18 Failed to close an index.
  - CREATING_INDEX
```
public static final ErrorCode CREATING_INDEX
```
    INDEX_ENGINE-19 Index did not exist and is being created.
  - INITIALIZE_INDEX_FAILED
```
public static final ErrorCode INITIALIZE_INDEX_FAILED
```
    INDEX_ENGINE-20 Failed to initialize index.
  - ILLEGAL_DOCUMENT_ID
```
public static final ErrorCode ILLEGAL_DOCUMENT_ID
```
    INDEX_ENGINE-21 Indicates a document was added with an illegal document ID.
  - OFFLINE_ERROR
```
public static final ErrorCode OFFLINE_ERROR
```
    INDEX_ENGINE-23 Index engine is offline and not processing messages.
  - BACKUP_FAILED
```
public static final ErrorCode BACKUP_FAILED
```
    INDEX_ENGINE-24 Indicates that performing a backup failed.
  - CORRUPT_INDEX
```
public static final ErrorCode CORRUPT_INDEX
```
    INDEX_ENGINE-25 Index is corrupted.
  - REPAIR_INDEX
```
public static final ErrorCode REPAIR_INDEX
```
    INDEX_ENGINE-26 Corrupted index is being repaired (may result in losing documents).
  - CHECK_FAILED
```
public static final ErrorCode CHECK_FAILED
```
    INDEX_ENGINE-27 Failed to check an index.
  - NOT_OPEN
```
public static final ErrorCode NOT_OPEN
```
    INDEX_ENGINE-28 The index is not open for updates.
  - RESTORE_FAILED
```
public static final ErrorCode RESTORE_FAILED
```
    INDEX_ENGINE-29 Failed to restore an index.
  - ACQUIRE_FAILED
```
public static final ErrorCode ACQUIRE_FAILED
```
    INDEX_ENGINE-30 Failed to acquire lock.
  - INFO_STREAM_ERROR
```
public static final ErrorCode INFO_STREAM_ERROR
```
    INDEX_ENGINE-31 Failed to open info stream for tracing internal indexing activity.
  - TOO_MANY_TOKENS
```
public static final ErrorCode TOO_MANY_TOKENS
```
    INDEX_ENGINE-32 Indicates that a field contained more tokens than the configured maximum.
  - TOKEN_TOO_LONG
```
public static final ErrorCode TOKEN_TOO_LONG
```
    INDEX_ENGINE-33 Indicates that a field contained a token longer than the maximum token length.
  - MERGE_ERROR
```
public static final ErrorCode MERGE_ERROR
```
    INDEX_ENGINE-34 Index merge failed.
  - BULK_UPDATE_ERROR
```
public static final ErrorCode BULK_UPDATE_ERROR
```
    INDEX_ENGINE-35 Error while applying a bulk update.
  - SINGLE_VALUE_ERROR
```
public static final ErrorCode SINGLE_VALUE_ERROR
```
    INDEX_ENGINE-36 Error indexing single value field.
  - NOT_RECEIVING
```
public static final ErrorCode NOT_RECEIVING
```
    INDEX_ENGINE-37 Index is not currently receiving updates.
  - ELECTION_ERROR
```
public static final ErrorCode ELECTION_ERROR
```
    INDEX_ENGINE-38 Index error occurred registering for election.
  - NOT_SUPPORTED
```
public static final ErrorCode NOT_SUPPORTED
```
    INDEX_ENGINE-39 A feature is not supported/enabled for an index.
  - TOKENIZATION_WARNING
```
public static final ErrorCode TOKENIZATION_WARNING
```
    INDEX_ENGINE-40 Non fatal error with tokenization.
  - FATAL_ERROR
```
public static final ErrorCode FATAL_ERROR
```
    INDEX_ENGINE-41 Fatal indexing error occurred. Index Writer shutting down.
  - LOG_READ_ERROR
```
public static final ErrorCode LOG_READ_ERROR
```
    INDEX_ENGINE-42 Error occurred while reading message from transaction log.
  - LOG_PROCESS_ERROR
```
public static final ErrorCode LOG_PROCESS_ERROR
```
    INDEX_ENGINE-43 Error occurred while processing a message from the transaction log.
  - LOG_WRITE_ERROR
```
public static final ErrorCode LOG_WRITE_ERROR
```
    INDEX_ENGINE-44 Error occurred while writing transaction log.
  - AUDIT_ERROR
```
public static final ErrorCode AUDIT_ERROR
```
    INDEX_ENGINE-45 Error occurred while writing audit record.
  - ZONE_ROUTING_ERROR
```
public static final ErrorCode ZONE_ROUTING_ERROR
```
    INDEX_ENGINE-46 Error while determining zone routing for document.
  - SHUTDOWN_HOOK_ERROR
```
public static final ErrorCode SHUTDOWN_HOOK_ERROR
```
    INDEX_ENGINE-47 Error with shutdown hook registration.
  - SNAPSHOT_ERROR
```
public static final ErrorCode SNAPSHOT_ERROR
```
    INDEX_ENGINE-48 General index snapshot error.
  - LOCK_ERROR
```
public static final ErrorCode LOCK_ERROR
```
    INDEX_ENGINE-49 Failed to acquire lock for index.
  - MISSING_START_ELEMENT
```
public static final ErrorCode MISSING_START_ELEMENT
```
    INDEX_ENGINE-50 START_ELEMENT token for scope missing.
  - MISSING_END_ELEMENT
```
public static final ErrorCode MISSING_END_ELEMENT
```
    INDEX_ENGINE-51 END_ELEMENT token for scope missing.
  - PROFILER_ERROR
```
public static final ErrorCode PROFILER_ERROR
```
    INDEX_ENGINE-52 Error profiling index engine.
  - LEASE_EXPIRATION_ERROR
```
public static final ErrorCode LEASE_EXPIRATION_ERROR
```
    INDEX_ENGINE-53 Failed to delete expired lease for index commit point.
  - DELETE_UNUSED_FILES_ERROR
```
public static final ErrorCode DELETE_UNUSED_FILES_ERROR
```
    INDEX_ENGINE-54 Error occurred while deleting unused files from the index.
  - STORAGE_ERROR
```
public static final ErrorCode STORAGE_ERROR
```
    INDEX_ENGINE-55 Error occurred while writing data to index storage.
- Method Detail
  - formatError
```
public java.lang.String formatError(java.util.Locale locale,
                                    java.lang.String... context)
```
    Description copied from class: ErrorCode
    
    Format a contextual error message.
    
    Overrides:
    
    formatError in class ErrorCode

Class IndexEngineError

Field Summary

Method Summary

Methods inherited from class com.attivio.sdk.error.ErrorCode

Methods inherited from class java.lang.Object

Field Detail

OPTIMIZE_FAILED

INDEXING_FAILED

NULL_DOC

INVALID_FIELD_CONTENT

ADD_FAILED

DELETE_FAILED

CLEAR_FAILED

DELETE_BY_QUERY_FAILED

COMMIT_FAILED

UNSUPPORTED_EVENT_HANDLER

EVENT_HANDLER_ERROR

POST_COMMIT_EVENT_FAILED

POST_OPTIMIZE_EVENT_FAILED

SHUTDOWN_ERROR

GENERATION_WARMUP_FAILED

EXTRACT_ERROR

OPEN_FAILED

CLOSE_FAILED

CREATING_INDEX

INITIALIZE_INDEX_FAILED

ILLEGAL_DOCUMENT_ID

OFFLINE_ERROR

BACKUP_FAILED

CORRUPT_INDEX

REPAIR_INDEX

CHECK_FAILED

NOT_OPEN

RESTORE_FAILED

ACQUIRE_FAILED

INFO_STREAM_ERROR

TOO_MANY_TOKENS

TOKEN_TOO_LONG

MERGE_ERROR

BULK_UPDATE_ERROR

SINGLE_VALUE_ERROR

NOT_RECEIVING

ELECTION_ERROR

NOT_SUPPORTED

TOKENIZATION_WARNING

FATAL_ERROR

LOG_READ_ERROR

LOG_PROCESS_ERROR

LOG_WRITE_ERROR

AUDIT_ERROR

ZONE_ROUTING_ERROR

SHUTDOWN_HOOK_ERROR

SNAPSHOT_ERROR

LOCK_ERROR

MISSING_START_ELEMENT

MISSING_END_ELEMENT

PROFILER_ERROR

LEASE_EXPIRATION_ERROR

DELETE_UNUSED_FILES_ERROR

STORAGE_ERROR

Method Detail

formatError