Package be.uclouvain.orthanc

Enum ErrorCode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ErrorCode>
    public enum ErrorCode
extends java.lang.Enum<ErrorCode>
    The various error codes that can be returned by the Orthanc core.

    • Enum Constant Detail

      • INTERNAL_ERROR

        public static final ErrorCode INTERNAL_ERROR
        Internal error

      • SUCCESS

        public static final ErrorCode SUCCESS
        Success

      • PLUGIN

        public static final ErrorCode PLUGIN
        Error encountered within the plugin engine

      • NOT_IMPLEMENTED

        public static final ErrorCode NOT_IMPLEMENTED
        Not implemented yet

      • PARAMETER_OUT_OF_RANGE

        public static final ErrorCode PARAMETER_OUT_OF_RANGE
        Parameter out of range

      • NOT_ENOUGH_MEMORY

        public static final ErrorCode NOT_ENOUGH_MEMORY
        The server hosting Orthanc is running out of memory

      • BAD_PARAMETER_TYPE

        public static final ErrorCode BAD_PARAMETER_TYPE
        Bad type for a parameter

      • BAD_SEQUENCE_OF_CALLS

        public static final ErrorCode BAD_SEQUENCE_OF_CALLS
        Bad sequence of calls

      • INEXISTENT_ITEM

        public static final ErrorCode INEXISTENT_ITEM
        Accessing an inexistent item

      • BAD_REQUEST

        public static final ErrorCode BAD_REQUEST
        Bad request

      • NETWORK_PROTOCOL

        public static final ErrorCode NETWORK_PROTOCOL
        Error in the network protocol

      • SYSTEM_COMMAND

        public static final ErrorCode SYSTEM_COMMAND
        Error while calling a system command

      • DATABASE

        public static final ErrorCode DATABASE
        Error with the database engine

      • URI_SYNTAX

        public static final ErrorCode URI_SYNTAX
        Badly formatted URI

      • INEXISTENT_FILE

        public static final ErrorCode INEXISTENT_FILE
        Inexistent file

      • CANNOT_WRITE_FILE

        public static final ErrorCode CANNOT_WRITE_FILE
        Cannot write to file

      • BAD_FILE_FORMAT

        public static final ErrorCode BAD_FILE_FORMAT
        Bad file format

      • TIMEOUT

        public static final ErrorCode TIMEOUT
        Timeout

      • UNKNOWN_RESOURCE

        public static final ErrorCode UNKNOWN_RESOURCE
        Unknown resource

      • INCOMPATIBLE_DATABASE_VERSION

        public static final ErrorCode INCOMPATIBLE_DATABASE_VERSION
        Incompatible version of the database

      • FULL_STORAGE

        public static final ErrorCode FULL_STORAGE
        The file storage is full

      • CORRUPTED_FILE

        public static final ErrorCode CORRUPTED_FILE
        Corrupted file (e.g. inconsistent MD5 hash)

      • INEXISTENT_TAG

        public static final ErrorCode INEXISTENT_TAG
        Inexistent tag

      • READ_ONLY

        public static final ErrorCode READ_ONLY
        Cannot modify a read-only data structure

      • INCOMPATIBLE_IMAGE_FORMAT

        public static final ErrorCode INCOMPATIBLE_IMAGE_FORMAT
        Incompatible format of the images

      • INCOMPATIBLE_IMAGE_SIZE

        public static final ErrorCode INCOMPATIBLE_IMAGE_SIZE
        Incompatible size of the images

      • SHARED_LIBRARY

        public static final ErrorCode SHARED_LIBRARY
        Error while using a shared library (plugin)

      • UNKNOWN_PLUGIN_SERVICE

        public static final ErrorCode UNKNOWN_PLUGIN_SERVICE
        Plugin invoking an unknown service

      • UNKNOWN_DICOM_TAG

        public static final ErrorCode UNKNOWN_DICOM_TAG
        Unknown DICOM tag

      • BAD_JSON

        public static final ErrorCode BAD_JSON
        Cannot parse a JSON document

      • UNAUTHORIZED

        public static final ErrorCode UNAUTHORIZED
        Bad credentials were provided to an HTTP request

      • BAD_FONT

        public static final ErrorCode BAD_FONT
        Badly formatted font file

      • DATABASE_PLUGIN

        public static final ErrorCode DATABASE_PLUGIN
        The plugin implementing a custom database back-end does not fulfill the proper interface

      • STORAGE_AREA_PLUGIN

        public static final ErrorCode STORAGE_AREA_PLUGIN
        Error in the plugin implementing a custom storage area

      • EMPTY_REQUEST

        public static final ErrorCode EMPTY_REQUEST
        The request is empty

      • NOT_ACCEPTABLE

        public static final ErrorCode NOT_ACCEPTABLE
        Cannot send a response which is acceptable according to the Accept HTTP header

      • NULL_POINTER

        public static final ErrorCode NULL_POINTER
        Cannot handle a NULL pointer

      • DATABASE_UNAVAILABLE

        public static final ErrorCode DATABASE_UNAVAILABLE
        The database is currently not available (probably a transient situation)

      • CANCELED_JOB

        public static final ErrorCode CANCELED_JOB
        This job was canceled

      • BAD_GEOMETRY

        public static final ErrorCode BAD_GEOMETRY
        Geometry error encountered in Stone

      • SSL_INITIALIZATION

        public static final ErrorCode SSL_INITIALIZATION
        Cannot initialize SSL encryption, check out your certificates

      • DISCONTINUED_ABI

        public static final ErrorCode DISCONTINUED_ABI
        Calling a function that has been removed from the Orthanc Framework

      • BAD_RANGE

        public static final ErrorCode BAD_RANGE
        Incorrect range request

      • DATABASE_CANNOT_SERIALIZE

        public static final ErrorCode DATABASE_CANNOT_SERIALIZE
        Database could not serialize access due to concurrent update, the transaction should be retried

      • REVISION

        public static final ErrorCode REVISION
        A bad revision number was provided, which might indicate conflict between multiple writers

      • SQLITE_NOT_OPENED

        public static final ErrorCode SQLITE_NOT_OPENED
        SQLite: The database is not opened

      • SQLITE_ALREADY_OPENED

        public static final ErrorCode SQLITE_ALREADY_OPENED
        SQLite: Connection is already open

      • SQLITE_CANNOT_OPEN

        public static final ErrorCode SQLITE_CANNOT_OPEN
        SQLite: Unable to open the database

      • SQLITE_STATEMENT_ALREADY_USED

        public static final ErrorCode SQLITE_STATEMENT_ALREADY_USED
        SQLite: This cached statement is already being referred to

      • SQLITE_EXECUTE

        public static final ErrorCode SQLITE_EXECUTE
        SQLite: Cannot execute a command

      • SQLITE_ROLLBACK_WITHOUT_TRANSACTION

        public static final ErrorCode SQLITE_ROLLBACK_WITHOUT_TRANSACTION
        SQLite: Rolling back a nonexistent transaction (have you called Begin()?)

      • SQLITE_COMMIT_WITHOUT_TRANSACTION

        public static final ErrorCode SQLITE_COMMIT_WITHOUT_TRANSACTION
        SQLite: Committing a nonexistent transaction

      • SQLITE_REGISTER_FUNCTION

        public static final ErrorCode SQLITE_REGISTER_FUNCTION
        SQLite: Unable to register a function

      • SQLITE_FLUSH

        public static final ErrorCode SQLITE_FLUSH
        SQLite: Unable to flush the database

      • SQLITE_CANNOT_RUN

        public static final ErrorCode SQLITE_CANNOT_RUN
        SQLite: Cannot run a cached statement

      • SQLITE_CANNOT_STEP

        public static final ErrorCode SQLITE_CANNOT_STEP
        SQLite: Cannot step over a cached statement

      • SQLITE_BIND_OUT_OF_RANGE

        public static final ErrorCode SQLITE_BIND_OUT_OF_RANGE
        SQLite: Bing a value while out of range (serious error)

      • SQLITE_PREPARE_STATEMENT

        public static final ErrorCode SQLITE_PREPARE_STATEMENT
        SQLite: Cannot prepare a cached statement

      • SQLITE_TRANSACTION_ALREADY_STARTED

        public static final ErrorCode SQLITE_TRANSACTION_ALREADY_STARTED
        SQLite: Beginning the same transaction twice

      • SQLITE_TRANSACTION_COMMIT

        public static final ErrorCode SQLITE_TRANSACTION_COMMIT
        SQLite: Failure when committing the transaction

      • SQLITE_TRANSACTION_BEGIN

        public static final ErrorCode SQLITE_TRANSACTION_BEGIN
        SQLite: Cannot start a transaction

      • DIRECTORY_OVER_FILE

        public static final ErrorCode DIRECTORY_OVER_FILE
        The directory to be created is already occupied by a regular file

      • FILE_STORAGE_CANNOT_WRITE

        public static final ErrorCode FILE_STORAGE_CANNOT_WRITE
        Unable to create a subdirectory or a file in the file storage

      • DIRECTORY_EXPECTED

        public static final ErrorCode DIRECTORY_EXPECTED
        The specified path does not point to a directory

      • HTTP_PORT_IN_USE

        public static final ErrorCode HTTP_PORT_IN_USE
        The TCP port of the HTTP server is privileged or already in use

      • DICOM_PORT_IN_USE

        public static final ErrorCode DICOM_PORT_IN_USE
        The TCP port of the DICOM server is privileged or already in use

      • BAD_HTTP_STATUS_IN_REST

        public static final ErrorCode BAD_HTTP_STATUS_IN_REST
        This HTTP status is not allowed in a REST API

      • REGULAR_FILE_EXPECTED

        public static final ErrorCode REGULAR_FILE_EXPECTED
        The specified path does not point to a regular file

      • PATH_TO_EXECUTABLE

        public static final ErrorCode PATH_TO_EXECUTABLE
        Unable to get the path to the executable

      • MAKE_DIRECTORY

        public static final ErrorCode MAKE_DIRECTORY
        Cannot create a directory

      • BAD_APPLICATION_ENTITY_TITLE

        public static final ErrorCode BAD_APPLICATION_ENTITY_TITLE
        An application entity title (AET) cannot be empty or be longer than 16 characters

      • NO_CFIND_HANDLER

        public static final ErrorCode NO_CFIND_HANDLER
        No request handler factory for DICOM C-FIND SCP

      • NO_CMOVE_HANDLER

        public static final ErrorCode NO_CMOVE_HANDLER
        No request handler factory for DICOM C-MOVE SCP

      • NO_CSTORE_HANDLER

        public static final ErrorCode NO_CSTORE_HANDLER
        No request handler factory for DICOM C-STORE SCP

      • NO_APPLICATION_ENTITY_FILTER

        public static final ErrorCode NO_APPLICATION_ENTITY_FILTER
        No application entity filter

      • NO_SOP_CLASS_OR_INSTANCE

        public static final ErrorCode NO_SOP_CLASS_OR_INSTANCE
        DicomUserConnection: Unable to find the SOP class and instance

      • NO_PRESENTATION_CONTEXT

        public static final ErrorCode NO_PRESENTATION_CONTEXT
        DicomUserConnection: No acceptable presentation context for modality

      • DICOM_FIND_UNAVAILABLE

        public static final ErrorCode DICOM_FIND_UNAVAILABLE
        DicomUserConnection: The C-FIND command is not supported by the remote SCP

      • DICOM_MOVE_UNAVAILABLE

        public static final ErrorCode DICOM_MOVE_UNAVAILABLE
        DicomUserConnection: The C-MOVE command is not supported by the remote SCP

      • CANNOT_STORE_INSTANCE

        public static final ErrorCode CANNOT_STORE_INSTANCE
        Cannot store an instance

      • CREATE_DICOM_NOT_STRING

        public static final ErrorCode CREATE_DICOM_NOT_STRING
        Only string values are supported when creating DICOM instances

      • CREATE_DICOM_OVERRIDE_TAG

        public static final ErrorCode CREATE_DICOM_OVERRIDE_TAG
        Trying to override a value inherited from a parent module

      • CREATE_DICOM_USE_CONTENT

        public static final ErrorCode CREATE_DICOM_USE_CONTENT
        Use \"Content\" to inject an image into a new DICOM instance

      • CREATE_DICOM_NO_PAYLOAD

        public static final ErrorCode CREATE_DICOM_NO_PAYLOAD
        No payload is present for one instance in the series

      • CREATE_DICOM_USE_DATA_URI_SCHEME

        public static final ErrorCode CREATE_DICOM_USE_DATA_URI_SCHEME
        The payload of the DICOM instance must be specified according to Data URI scheme

      • CREATE_DICOM_BAD_PARENT

        public static final ErrorCode CREATE_DICOM_BAD_PARENT
        Trying to attach a new DICOM instance to an inexistent resource

      • CREATE_DICOM_PARENT_IS_INSTANCE

        public static final ErrorCode CREATE_DICOM_PARENT_IS_INSTANCE
        Trying to attach a new DICOM instance to an instance (must be a series, study or patient)

      • CREATE_DICOM_PARENT_ENCODING

        public static final ErrorCode CREATE_DICOM_PARENT_ENCODING
        Unable to get the encoding of the parent resource

      • UNKNOWN_MODALITY

        public static final ErrorCode UNKNOWN_MODALITY
        Unknown modality

      • BAD_JOB_ORDERING

        public static final ErrorCode BAD_JOB_ORDERING
        Bad ordering of filters in a job

      • JSON_TO_LUA_TABLE

        public static final ErrorCode JSON_TO_LUA_TABLE
        Cannot convert the given JSON object to a Lua table

      • CANNOT_CREATE_LUA

        public static final ErrorCode CANNOT_CREATE_LUA
        Cannot create the Lua context

      • CANNOT_EXECUTE_LUA

        public static final ErrorCode CANNOT_EXECUTE_LUA
        Cannot execute a Lua command

      • LUA_ALREADY_EXECUTED

        public static final ErrorCode LUA_ALREADY_EXECUTED
        Arguments cannot be pushed after the Lua function is executed

      • LUA_BAD_OUTPUT

        public static final ErrorCode LUA_BAD_OUTPUT
        The Lua function does not give the expected number of outputs

      • NOT_LUA_PREDICATE

        public static final ErrorCode NOT_LUA_PREDICATE
        The Lua function is not a predicate (only true/false outputs allowed)

      • LUA_RETURNS_NO_STRING

        public static final ErrorCode LUA_RETURNS_NO_STRING
        The Lua function does not return a string

      • STORAGE_AREA_ALREADY_REGISTERED

        public static final ErrorCode STORAGE_AREA_ALREADY_REGISTERED
        Another plugin has already registered a custom storage area

      • DATABASE_BACKEND_ALREADY_REGISTERED

        public static final ErrorCode DATABASE_BACKEND_ALREADY_REGISTERED
        Another plugin has already registered a custom database back-end

      • DATABASE_NOT_INITIALIZED

        public static final ErrorCode DATABASE_NOT_INITIALIZED
        Plugin trying to call the database during its initialization

      • SSL_DISABLED

        public static final ErrorCode SSL_DISABLED
        Orthanc has been built without SSL support

      • CANNOT_ORDER_SLICES

        public static final ErrorCode CANNOT_ORDER_SLICES
        Unable to order the slices of the series

      • NO_WORKLIST_HANDLER

        public static final ErrorCode NO_WORKLIST_HANDLER
        No request handler factory for DICOM C-Find Modality SCP

      • ALREADY_EXISTING_TAG

        public static final ErrorCode ALREADY_EXISTING_TAG
        Cannot override the value of a tag that already exists

      • NO_STORAGE_COMMITMENT_HANDLER

        public static final ErrorCode NO_STORAGE_COMMITMENT_HANDLER
        No request handler factory for DICOM N-ACTION SCP (storage commitment)

      • NO_CGET_HANDLER

        public static final ErrorCode NO_CGET_HANDLER
        No request handler factory for DICOM C-GET SCP

      • UNSUPPORTED_MEDIA_TYPE

        public static final ErrorCode UNSUPPORTED_MEDIA_TYPE
        Unsupported media type

    • Method Detail

      • values

        public static ErrorCode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ErrorCode c : ErrorCode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ErrorCode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getInstance

        protected static ErrorCode getInstance​(int value)
        Return the enumeration value that corresponds to an integer value of interest.
        Parameters:
        value - The integer value.
        Returns:
        The enumeration value.

      • getValue

        public int getValue()
        Get the integer value corresponding to this enumeration value.
        Returns:
        The integer value.