PAK Error Codes

1. General Error Codes

Error Code	Exception	Description
-1	UNKNOWN_ERROR	Is used for all errors which are not defined by another error code. Mostly because the error is not yet known to us.
219	COMMON_CORRUPT_ZIP	Occurs in case of a corrupt ZIP.
404	RESOURCE_NOT_FOUND	Occurs when something is about to be fetched but cannot be found.
666	FATAL_ERROR	Can be used to tell the developer that something really evil happened.
667	FILE_ERROR	Error can be used for File specific IO errors. Examples: – PAK specific files which can’t be read – PAK specific files which can’t be written

Error Code

Exception

Description

-1

UNKNOWN_ERROR

Is used for all errors which are not defined by another error code. Mostly because the error is not yet known to us.

219

COMMON_CORRUPT_ZIP

Occurs in case of a corrupt ZIP.

404

RESOURCE_NOT_FOUND

Occurs when something is about to be fetched but cannot be found.

666

FATAL_ERROR

Can be used to tell the developer that something really evil happened.

667

FILE_ERROR

Error can be used for File specific IO errors.
Examples:
– PAK specific files which can’t be read
– PAK specific files which can’t be written

2. Common Exceptions (1xxx)

Error Code Exception Description

Error Code	Exception	Description
1000	COMMON_SPECIFIC_ERROR	Used in case no error code matches as the error to describe is too specific. Enrichment of additional specific exception information by using `PakException#specificExceptionData`.
1001	CONNECTION_TIMEOUT	Occurs whenever a connection times out.
1002	SSL_CERTIFICATE_ERROR	Occurs whenever ssl certificates are missing, not up-to-date, or generally invalid.

1000

COMMON_SPECIFIC_ERROR

Used in case no error code matches as the error to describe is too specific. Enrichment of additional specific exception information by using PakException#specificExceptionData.

1001

CONNECTION_TIMEOUT

Occurs whenever a connection times out.

1002

SSL_CERTIFICATE_ERROR

Occurs whenever ssl certificates are missing, not up-to-date, or generally invalid.

3. Repository Exception (6xx)

Whenever something fails due to repositories (repos), the following exception codes should be used.

Error Code	Exception	Description
601	REPO_WRONG_CREDENTIALS	Occurs when the given credentials do not grant access to a repository.
602	REPO_MALFORMED_LOCATION	occurs when – Repo location is empty – Repo location does not conform to URI – Repo location does not conform to a defined standard (example WEB-URL)
603	REPO_UNSUPPORTED_LOCATION	Occurs when – Location is forbidden to be read from/ written to – Given repo location is not actually a repo – Server is reachable but does not support repos and thus, refuses to serve
604	REPO_UNKNOWN_LOCATION	Occurs when – Repo is no repo at all – Location cannot be found
605	REPO_CANNOT_OVERWRITE	Occurs when someone tried to overwrite files on a repo, but the repo does not allow that.
606	REPO_ONLY_ALLOWS_SNAPSHOT	Occurs when someone tried to write a non snapshot version to a repo, but the repo only allows snapshots.
607	REPO_ONLY_ALLOWS_RELEASE	Occurs when someone tried to write a non release version to a repo, but the repo only allows releases.
608	REPO_UNABLE_TO_SERIALIZE_MODEL	Occurs when serializing from a model to file fails.
609	REPO_CANNOT_DELETE	Occurs when deleting from a repo fails.
610	REPO_CANNOT_CREATE_META_FILE	Occurs when meta file could not be created.
611	REPO_CANNOT_CREATE_DIRECTORY	Occurs when a directory cannot be created.
612	REPO_SERVER_ERROR	Occurs when the repository is server based and a 5xx HTTP Code returns. This error code is taken when the error couldn’t be specified better.
613	REPO_BAD_REQUEST_ERROR	Occurs when the repository is server based and a 4xx HTTP Code returns. This error code is taken when the error couldn’t be specified better.

Error Code

Exception

Description

601

REPO_WRONG_CREDENTIALS

Occurs when the given credentials do not grant access to a repository.

602

REPO_MALFORMED_LOCATION

occurs when
– Repo location is empty
– Repo location does not conform to URI
– Repo location does not conform to a defined standard (example WEB-URL)

603

REPO_UNSUPPORTED_LOCATION

Occurs when
– Location is forbidden to be read from/ written to
– Given repo location is not actually a repo
– Server is reachable but does not support repos and thus, refuses to serve

604

REPO_UNKNOWN_LOCATION

Occurs when
– Repo is no repo at all
– Location cannot be found

605

REPO_CANNOT_OVERWRITE

Occurs when someone tried to overwrite files on a repo, but the repo does not allow that.

606

REPO_ONLY_ALLOWS_SNAPSHOT

Occurs when someone tried to write a non snapshot version to a repo, but the repo only allows snapshots.

607

REPO_ONLY_ALLOWS_RELEASE

Occurs when someone tried to write a non release version to a repo, but the repo only allows releases.

608

REPO_UNABLE_TO_SERIALIZE_MODEL

Occurs when serializing from a model to file fails.

609

REPO_CANNOT_DELETE

Occurs when deleting from a repo fails.

610

REPO_CANNOT_CREATE_META_FILE

Occurs when meta file could not be created.

611

REPO_CANNOT_CREATE_DIRECTORY

Occurs when a directory cannot be created.

612

REPO_SERVER_ERROR

Occurs when the repository is server based and a 5xx HTTP Code returns. This error code is taken when the error couldn’t be specified better.

613

REPO_BAD_REQUEST_ERROR

Occurs when the repository is server based and a 4xx HTTP Code returns. This error code is taken when the error couldn’t be specified better.

4. Engine Exceptions (7xx)

Whenever something fails due to the engine, the following exception codes should be used.

Error Code	Exception	Description
701	ENGINE_UNRECOVERABLE_NODE_ERROR	Occurs when the command execution fails and no boundary event is set. Possible causes: – Fails for missing inputs/ outputs – Execution method of command throws exception
702	ENGINE_INITIALIZATION_ERROR	Occurs when – Commands are missing – Models are missing – Credentials are missing – Dataflow Analysis is enabled and fails
703	ENGINE_UNHANDABLE_EXCEPTION	Occurs for errors based on „plain“ Java, e.g. runtime errors, null-pointer, 3rd party framework problems, threading issues.
704	ENGINE_DFA_FAILED	Occurs when the model got DFA errors, e.g. missing mandatory values, missing mappings → Engine will stop
705	ENGINE_DFA_ERROR	Occurs when the DFA could not run due to model errors like – Missing commands – Mapping to fields of commands which do not exist – Other Java based (fatal) errors
706	ENGINE_CREDENTIAL_MANAGER_ERROR	Occurs when credentials are missing and the callback „de.asap.pak.core.credentials.api.ICredentialRequestProvider“ could not fetch them as well

Error Code

Exception

Description

701

ENGINE_UNRECOVERABLE_NODE_ERROR

Occurs when the command execution fails and no boundary event is set.
Possible causes:
– Fails for missing inputs/ outputs
– Execution method of command throws exception

702

ENGINE_INITIALIZATION_ERROR

Occurs when
– Commands are missing
– Models are missing
– Credentials are missing
– Dataflow Analysis is enabled and fails

703

ENGINE_UNHANDABLE_EXCEPTION

Occurs for errors based on „plain“ Java, e.g. runtime errors, null-pointer, 3rd party framework problems, threading issues.

704

ENGINE_DFA_FAILED

Occurs when the model got DFA errors, e.g. missing mandatory values, missing mappings
→ Engine will stop

705

ENGINE_DFA_ERROR

Occurs when the DFA could not run due to model errors like
– Missing commands
– Mapping to fields of commands which do not exist
– Other Java based (fatal) errors

706

ENGINE_CREDENTIAL_MANAGER_ERROR

Occurs when credentials are missing and the callback „de.asap.pak.core.credentials.api.ICredentialRequestProvider“ could not fetch them as well

5. Command Pool Exceptions (8xx)

Whenever something fails due to the command pools, the following exception codes should be used.

Error Code	Exception	Description
801	COMMAND_POOL_CANNOT_FETCH_ALL_COMMANDS	Occurs when fetching all commands fails. Possible causes: – Missing/ wrong command version
802	COMMAND_POOL_CANNOT_FIND_COMMAND_IN_REPOS	Occurs when a command could not be found within a repository.
803	COMMAND_POOL_CANNOT_PULL_COMMAND	Occurs when pulling a command fails.
804	COMMAND_POOL_COMMAND_CREATION_FAILED	Occurs when creating a command fails.
805	COMMAND_POOL_LOADING_COMMAND_INTERPRETER_FAILED	Occurs in case it was not possible ot load an interpreter.
806	COMMAND_POOL_LOADING_SERVICE_METAS_FAILED	Occurs when the service could not be loaded.
807	COMMAND_POOL_READING_SERVICE_METAS_FAILED	Occurs when the service meta could not be read. Possible causes: – Service meta file/folder not found
808	COMMAND_POOL_CLEANUP_CLASSLOADER_CACHE_FAILED	Occurs when the class loader cache cleanup fails.
809	COMMAND_POOL_UNEXPECTED_DOWNLOAD_LOCATION	Occurs in case of an unexpected download location. Possible causes: – Wrong file URL
810	COMMAND_POOL_ARTIFACT_PROVIDES_INVALID_SERVICE_DEFINITION	Occurs in case of an invalid service definition.
811	COMMAND_POOL_NO_SUITABLE_SERVICE_FOUND	Occurs when no suitable service is found.
812	COMMAND_POOL_MULTIPLE_SERVICE_CANDIDATES_FOUND	Occurs when several services are found.
813	COMMAND_POOL_SERVICE_TRANSITIVE_CLASS_MISSING	Occurs when a transitive class is missing by e.g. an artifact, dependency or system class loader.
814	COMMAND_POOL_SERVICE_CLASS_CANNOT_BE_INSTANTIATED	Occurs when a service cannot be instantiated. Possible causes: – Not found within an artifact or dependency
815	COMMAND_POOL_SERVICE_CLASS_CANNOT_BE_INITIALIZED	Occurs when a service cannot be initialized.
816	COMMAND_POOL_CANNOT_PULL_SERVICE	Occurs when pulling a service fails.
817	COMMAND_POOL_SERVICE_VERSION_PARSING_ERROR	Occurs when parsing a version fails.
818	COMMAND_POOL_ONLY_ONE_SERVICE_PER_COMMAND_ALLOWED	Occurs when several services are registered for a command.
819	COMMAND_POOL_META_DATA_NOT_FOUND	Occurs when a command meta could not be found due to an e.g. missing or deprecated command version.

Error Code

Exception

Description

801

COMMAND_POOL_CANNOT_FETCH_ALL_COMMANDS

Occurs when fetching all commands fails.
Possible causes:
– Missing/ wrong command version

802

COMMAND_POOL_CANNOT_FIND_COMMAND_IN_REPOS

Occurs when a command could not be found within a repository.

803

COMMAND_POOL_CANNOT_PULL_COMMAND

Occurs when pulling a command fails.

804

COMMAND_POOL_COMMAND_CREATION_FAILED

Occurs when creating a command fails.

805

COMMAND_POOL_LOADING_COMMAND_INTERPRETER_FAILED

Occurs in case it was not possible ot load an interpreter.

806

COMMAND_POOL_LOADING_SERVICE_METAS_FAILED

Occurs when the service could not be loaded.

807

COMMAND_POOL_READING_SERVICE_METAS_FAILED

Occurs when the service meta could not be read.
Possible causes:
– Service meta file/folder not found

808

COMMAND_POOL_CLEANUP_CLASSLOADER_CACHE_FAILED

Occurs when the class loader cache cleanup fails.

809

COMMAND_POOL_UNEXPECTED_DOWNLOAD_LOCATION

Occurs in case of an unexpected download location.
Possible causes:
– Wrong file URL

810

COMMAND_POOL_ARTIFACT_PROVIDES_INVALID_SERVICE_DEFINITION

Occurs in case of an invalid service definition.

811

COMMAND_POOL_NO_SUITABLE_SERVICE_FOUND

Occurs when no suitable service is found.

812

COMMAND_POOL_MULTIPLE_SERVICE_CANDIDATES_FOUND

Occurs when several services are found.

813

COMMAND_POOL_SERVICE_TRANSITIVE_CLASS_MISSING

Occurs when a transitive class is missing by e.g. an artifact, dependency or system class loader.

814

COMMAND_POOL_SERVICE_CLASS_CANNOT_BE_INSTANTIATED

Occurs when a service cannot be instantiated.
Possible causes:
– Not found within an artifact or dependency

815

COMMAND_POOL_SERVICE_CLASS_CANNOT_BE_INITIALIZED

Occurs when a service cannot be initialized.

816

COMMAND_POOL_CANNOT_PULL_SERVICE

Occurs when pulling a service fails.

817

COMMAND_POOL_SERVICE_VERSION_PARSING_ERROR

Occurs when parsing a version fails.

818

COMMAND_POOL_ONLY_ONE_SERVICE_PER_COMMAND_ALLOWED

Occurs when several services are registered for a command.

819

COMMAND_POOL_META_DATA_NOT_FOUND

Occurs when a command meta could not be found due to an e.g. missing or deprecated command version.

6. Command Interpreter Exceptions (9xx)

Whenever something fails due to the command interpreter, the following exception codes should be used.

Error Code	Exception	Description
901	COMMAND_INTERPRETER_CONSTRUCTION_EXCEPTION	Should be raised by an implementing „de.asap.pak.core.commandpool.spi.ICommandInterpreter“, which is not able to create the desired command. Possible causes: – Missing mandatory keys – Command implementation itself could not be found, e.g. fully-qualified name of a Java class was not found
902	COMMAND_INTERPRETER_FETCHING_COMMAND_ FROM_CLASSLOADER_NOT_POSSIBLE	Occurs when fetching a command from the classloader fails.
903	COMMAND_INTERPRETER_CREATE_EXECUTABLE_ NOT_POSSIBLE	Occurs when no executable could be created.
904	COMMAND_INTERPRETER_EXECUTABLE_FILE_ NOT_FOUND_OR_NULL	Occurs when no executable file could be found. Possible causes: – Missing or wrong file path

Error Code

Exception

Description

901

COMMAND_INTERPRETER_CONSTRUCTION_EXCEPTION

Should be raised by an implementing „de.asap.pak.core.commandpool.spi.ICommandInterpreter“, which is not able to create the desired command.
Possible causes:
– Missing mandatory keys
– Command implementation itself could not be found, e.g. fully-qualified name of a Java class was not found

902

COMMAND_INTERPRETER_FETCHING_COMMAND_ FROM_CLASSLOADER_NOT_POSSIBLE

Occurs when fetching a command from the classloader fails.

903

COMMAND_INTERPRETER_CREATE_EXECUTABLE_ NOT_POSSIBLE

Occurs when no executable could be created.

904

COMMAND_INTERPRETER_EXECUTABLE_FILE_ NOT_FOUND_OR_NULL

Occurs when no executable file could be found.
Possible causes:
– Missing or wrong file path