Add error descriptions from TR-031312-1

common/src/main/java/org/openecard/common/ECardConstants.java

@@ -139,14 +139,41 @@ public class ECardConstants {
 	    private static final String APP_TV_PREFIX  = APP_PREFIX + "/TrustedViewer#";   // TrustedViewer
 	    private static final String APP_TSL_PREFIX = APP_PREFIX + "/TSL#";             // TrustedViewer
 
+	    /**
+	     * There was some unknown error.
+	     * An unexpected error has occurred during processing which cannot be represented by the standard codes or
+	     * specific service error codes. The error and detail texts can describe the error more closely.
+	     */
 	    public static final String UNKNOWN_ERROR = APP_PREFIX + "/common#unknownError";
+	    /**
+	     * Use of the function by the client application is not permitted.
+	     */
 	    public static final String NO_PERM = APP_PREFIX + "/common#noPermission";
+	    /**
+	     * Internal error.
+	     */
 	    public static final String INT_ERROR = APP_PREFIX + "/common#internalError";
 	    public static final String PARM_ERROR = APP_PREFIX + "/common#parameterError";
+	    /**
+	     * API function unknown.
+	     */
 	    public static final String UNKNOWN_API = APP_PREFIX + "/common#unknownAPIFunction";
+	    /**
+	     * Framework or layer not initialised.
+	     */
 	    public static final String NOT_INITIALIZED = APP_PREFIX + "/common#notInitialized";
+	    /**
+	     * Warning indicating termination of an active session.
+	     */
 	    public static final String CON_DISCONNECT = APP_PREFIX + "/common#warningConnectionDisconnected";
+	    /**
+	     * Warning indicating termination of an active session.
+	     */
 	    public static final String SESS_TERMINATED = APP_PREFIX + "/common#SessionTerminatedWarning";
+	    /**
+	     * Parameter error.
+	     * There was some problem with a provided or omitted parameter.
+	     */
 	    public static final String INCORRECT_PARM = APP_PREFIX + "/common#incorrectParameter";
 	    public static final String COMMUNICATION_ERROR = APP_PREFIX + "/common#communicationError";
 
@@ -157,10 +184,25 @@ public class ECardConstants {
 	     */
 	    public static class CIF {
 
+		/**
+		 * CardInfo file cannot be added.
+		 */
 		public static final String ADD_NOT_POSSIBLE = APP_CIF_PREFIX + "addNotPossible";
+		/**
+		 * CardInfo file does not exist.
+		 */
 		public static final String NOT_EXISTING = APP_CIF_PREFIX + "notExisting";
+		/**
+		 * CardInfo file cannot be deleted.
+		 */
 		public static final String DEL_NOT_POSSIBLE = APP_CIF_PREFIX + "deleteNotPossible";
+		/**
+		 * The CardInfo file already exists.
+		 */
 		public static final String ALREADY_EXISTING = APP_CIF_PREFIX + "alreadyExisting";
+		/**
+		 * The CardInfo file is incorrect.
+		 */
 		public static final String INCORRECT_FILE = APP_CIF_PREFIX + "incorrectFile";
 
 	    };
@@ -171,11 +213,29 @@ public class ECardConstants {
 	     */
 	    public static class FW {
 
+		/**
+		 * Update service is not accessible.
+		 */
 		public static final String SERVICE_NA = APP_FW_PREFIX + "serviceNotAvailable";
+		/**
+		 * Unknown module.
+		 */
 		public static final String UNKNOWN_MODULE = APP_FW_PREFIX + "unknownModule";
+		/**
+		 * Invalid version number for module.
+		 */
 		public static final String INVALID_VERSION = APP_FW_PREFIX + "invalidVersionNumber";
+		/**
+		 * Operating system not supported.
+		 */
 		public static final String OS_NOT_SUPPORTED = APP_FW_PREFIX + "operationSystemNotSupported";
+		/**
+		 * No available space.
+		 */
 		public static final String NO_SPACE = APP_FW_PREFIX + "noSpaceAvailable";
+		/**
+		 * Access denied.
+		 */
 		public static final String SEC_NOT_SATISFIED = APP_FW_PREFIX + "securityConditionsNotSatisfied";
 
 	    };
@@ -187,9 +247,21 @@ public class ECardConstants {
 	     */
 	    public static class IFD {
 
+		/**
+		 * The card terminal configuration cannot be written.
+		 */
 		public static final String WRITE_CONF_IMPOSS = APP_IFD_PREFIX + "writeConfigurationNotPossible";
+		/**
+		 * The card terminal cannot be added.
+		 */
 		public static final String COULD_NOT_ADD = APP_IFD_PREFIX + "couldNotAdd";
+		/**
+		 * The card terminal cannot be deleted.
+		 */
 		public static final String DEL_IMPOSS = APP_IFD_PREFIX + "deleteNotPossible";
+		/**
+		 * The card terminal already exists.
+		 */
 		public static final String ADD_IMPOSS = APP_IFD_PREFIX + "addNotPossible";
 
 	    };
@@ -200,9 +272,21 @@ public class ECardConstants {
 	     */
 	    public static class Viewer {
 
+		/**
+		 * The trusted viewer cannot be deleted.
+		 */
 		public static final String DEL_IMPOSS = APP_TV_PREFIX + "deleteNotPossible";
+		/**
+		 * Invalid TrustedViewerId.
+		 */
 		public static final String INVALID_ID = APP_TV_PREFIX + "invalidID";
+		/**
+		 * Invalid configuration information for the trusted viewer.
+		 */
 		public static final String INVALID_CONF = APP_TV_PREFIX + "invalidConfiguration";
+		/**
+		 * The trusted viewer already exists with the entered ID.
+		 */
 		public static final String EXISTING = APP_TV_PREFIX + "alreadyExisting";
 
 	    };
@@ -214,6 +298,11 @@ public class ECardConstants {
 	     */
 	    public static class TSL {
 
+		/**
+		 * TSLSequenceNumber has been ignored.
+		 * As only a {@code TSLSequenceNumber} but no {@code SchemeName} has been specified, the
+		 * {@code TSLSequenceNumber}-element has been ignored.
+		 */
 		public static final String SEQNUM_IGNORED = APP_TSL_PREFIX + "TSLSequenceNumberIgnoredWarning";
 
 	    };
@@ -229,15 +318,40 @@ public class ECardConstants {
 
 	    private static final String DP_PREFIX = MINOR_PREFIX + "dp";
 
+	    /**
+	     * Time exceeded (timeout).
+	     * The operation was terminated as the set time was exceeded.
+	     */
 	    public static final String TIMEOUT = DP_PREFIX + "#timeoutError";
 	    public static final String UNKNOWN_CHANNEL_HANDLE = DP_PREFIX + "#unknownChannelHandle";
+	    /**
+	     * Communication error.
+	     */
 	    public static final String COMM_ERROR = DP_PREFIX + "#communicationError";
+	    /**
+	     * Failure to open a trusted channel.
+	     */
 	    public static final String CHANNEL_ESTABLISHMENT_FAILED = DP_PREFIX + "#trustedChannelEstablishmentFailed";
+	    /**
+	     * Unknown protocol.
+	     */
 	    public static final String UNKOWN_PROTOCOL = DP_PREFIX + "#unknownProtocol";
+	    /**
+	     * Unknown cipher suite.
+	     */
 	    public static final String UNKNOWN_CIPHER = DP_PREFIX + "#unknownCipherSuite";
+	    /**
+	     * Unknown web service binding.
+	     */
 	    public static final String UNKNOWN_BINDING = DP_PREFIX + "#unknownWebserviceBinding";
+	    /**
+	     * Node not reachable.
+	     */
 	    public static final String NODE_NOT_REACHABLE = DP_PREFIX + "#nodeNotReachable";
 	    // this one is mentioned in EstablishContexResponse TR-03112-6
+	    /**
+	     * Invalid channel handle.
+	     */
 	    public static final String INVALID_CHANNEL_HANDLE = DP_PREFIX + "#invalidChannelHandle";
 
 	};
@@ -264,7 +378,13 @@ public class ECardConstants {
 	     */
 	    public static class Algorithm {
 
+		/**
+		 * Stated hash algorithm is not supported.
+		 */
 		public static final String HASH_NOT_SUPPORTED = ALG_PFX + "hashAlgorithmNotSupported";
+		/**
+		 * The stated signature algorithm is not supported.
+		 */
 		public static final String SIG_NOT_SUPPORTED = ALG_PFX + "signatureAlgorithmNotSupported";
 
 	    };
@@ -276,11 +396,29 @@ public class ECardConstants {
 	     */
 	    public static class CertificateRequest {
 
+		/**
+		 * Unknown attribute in the certificate application.
+		 */
 		public static final String UNKNOWN_ATTR = CR_PFX + "unknownAttribute";
+		/**
+		 * Generation of the certificate application failed.
+		 */
 		public static final String CREATION_FAILED = CR_PFX + "creationOfCertificateRequestFailed";
+		/**
+		 * Submission of the certificate application failed.
+		 */
 		public static final String SUBMISSION_FAILED = CR_PFX + "submissionFailed";
+		/**
+		 * Unknown transaction identifier.
+		 */
 		public static final String UNKOWN_TRANSACTION = CR_PFX + "unknownTransactionID";
+		/**
+		 * Not possible to collect the certificate.
+		 */
 		public static final String DOWNLOAD_FAILED = CR_PFX + "certificateDownloadFailed";
+		/**
+		 * No subject specified in request.
+		 */
 		public static final String SUBJECT_MISSING = CR_PFX + "subjectMissing";
 
 	    };
@@ -292,8 +430,17 @@ public class ECardConstants {
 	     */
 	    public static class Encryption {
 
+		/**
+		 * Specific nodes can only be encrypted in case of an XML document.
+		 */
 		public static final String NODES_ENC = ENC_PFX + "encryptionOfCertainNodesOnlyForXMLDocuments";
+		/**
+		 * The encryption format is not supported.
+		 */
 		public static final String FORMAT_NOT_SUPPORTED = ENC_PFX + "encryptionFormatNotSupported";
+		/**
+		 * The encryption certificate of an intended recipient is invalid.
+		 */
 		public static final String INVALID_CERT = ENC_PFX + "invalidCertificate";
 
 	    };
@@ -305,7 +452,13 @@ public class ECardConstants {
 	     */
 	    public static class Key {
 
+		/**
+		 * Key generation is not possible.
+		 */
 		public static final String KEYGEN_NOT_POSSIBLE = KEY_PFX + "keyGenerationNotPossible";
+		/**
+		 * The stated encryption algorithm is not supported.
+		 */
 		public static final String ENC_ALG_NOT_SUPPORTED = KEY_PFX + "encryptionAlgorithmNotSupported";
 
 	    };
@@ -317,8 +470,17 @@ public class ECardConstants {
 	     */
 	    public static class Service {
 
+		/**
+		 * The OCSP responder is inaccessible.
+		 */
 		public static final String OCSP_UNREACHABLE = SERVICE_PFX + "ocspResponderUnreachable";
+		/**
+		 * The directory service is inaccessible.
+		 */
 		public static final String DIR_UNREACHABLE = SERVICE_PFX + "directoryServiceUnreachable";
+		/**
+		 * The time stamp service is inaccessible.
+		 */
 		public static final String TS_UNREACHABLE = SERVICE_PFX + "timeStampServiceUnreachable";
 
 	    };
@@ -330,37 +492,150 @@ public class ECardConstants {
 	     */
 	    public static class Signature {
 
+		/**
+		 * The signature format is not supported.
+		 * The stated signature or time stamp format is not supported.
+		 */
 		public static final String FORMAT_NOT_SUPPORTED = SIG_PFX + "signatureFormatNotSupported";
+		/**
+		 * PDF signature for non-PDF document requested.
+		 */
 		public static final String SIG_NON_PDFDOC = SIG_PFX + "PDFSignatureForNonPDFDocument";
+		/**
+		 * IncludeEContent not possible.
+		 * This warning is returned if the {@code IncludeEContent} flag is set when a PDF signature or a time
+		 * stamp is generated, or when a hash value is transmitted for signature generation.
+		 */
 		public static final String INCLUDE_ECONTENT_NOT_POSSIBLE = SIG_PFX + "unableToIncludeEContentWarning";
+		/**
+		 * The SignaturePlacement flag was ignored.
+		 * This warning is returned when the {@code SignaturePlacement} flag was set for a non-XML-based signature.
+		 */
 		public static final String IGNORE_SIG_PLACEMENT = SIG_PFX + "ignoredSignaturePlacementFlagWarning";
+		/**
+		 * The certificate is not available.
+		 * The stated certificate is not available for the function. This could be due to an incorrect
+		 * reference or a deleted data field.
+		 */
 		public static final String CERT_NOT_FOUND = SIG_PFX + "certificateNotFound";
+		/**
+		 * The certificate cannot be interpreted.
+		 * The format of the stated certificate is unknown and cannot be interpreted.
+		 */
 		public static final String WRONG_CERT_FORMAT = SIG_PFX + "certificateFormatNotCorrect";
+		/**
+		 * Invalid certificate reference.
+		 */
 		public static final String INVALID_CERT_REF = SIG_PFX + "invalidCertificateReference";
+		/**
+		 * The certificate chain is interrupted.
+		 * The stated certificate chain is interrupted. It is therefore not possible to complete full
+		 * verification up to the root certificate.
+		 */
 		public static final String CHAIN_INTERRUPTED = SIG_PFX + "certificateChainInterrupted";
+		/**
+		 * It was not possible to resolve the object reference.
+		 */
 		public static final String OBJREF_UNRESOLVEABLE = SIG_PFX + "resolutionOfObjectReferenceImpossible";
+		/**
+		 * The transformation algorithm is not supported.
+		 */
 		public static final String TRANSFORM_NOT_SUPPORTED = SIG_PFX + "transformationAlgorithmNotSupported";
+		/**
+		 * The viewer is unknown or not available.
+		 */
 		public static final String UNKNOWN_VIEWER = SIG_PFX + "unknownViewer";
+		/**
+		 * The certificate path was not checked.
+		 * Due to some problems it was not possible to validate the certificate path.
+		 */
 		public static final String CERT_PATH_NOT_VALIDATED = SIG_PFX + "certificatePathNotValidated";
+		/**
+		 * The certificate status was not checked.
+		 * Due to some problems it was not possible to check the certificate status.
+		 */
 		public static final String CERT_STATUS_NOT_CHECKED = SIG_PFX + "certificateStatusNotChecked";
+		/**
+		 * The signature manifest was not verified.
+		 * This is a warning.
+		 */
 		public static final String SIG_MANIFEST_NOT_CHECKED = SIG_PFX + "signatureManifestNotCheckedWarning";
+		/**
+		 * The suitability of the signature and hash algorithms was not checked.
+		 */
 		public static final String ALGS_NOT_CHECKED = SIG_PFX + "suitabilityOfAlgorithmsNotChecked";
+		/**
+		 * No signature-related data were found (detached signature without EContent).
+		 */
 		public static final String DETACHED_NO_CONTENT = SIG_PFX + "detachedSignatureWithoutEContent";
+		/**
+		 * It is not possible to interpret revocation information.
+		 */
 		public static final String WRONG_REVOCATION_INFO = SIG_PFX + "improperRevocationInformation";
+		/**
+		 * The signature format is incorrect.
+		 * The format of the transmitted signature does not correspond to the respective specification. This
+		 * error occurs when a supported format is recognised (e.g. in accordance with [RFC3275] or [RFC3369]),
+		 * but the signature does not meet the respective form requirements. If the transmitted format was
+		 * already not recognised, error {@link #FORMAT_NOT_SUPPORTED} is returned.
+		 */
 		public static final String INVALID_SIG_FORMAT = SIG_PFX + "invalidSignatureFormat";
+		/**
+		 * The security of the signature algorithm is not suitable at the relevant point of time.
+		 */
 		public static final String SIGALG_NOT_SUITABLE = SIG_PFX + "signatureAlgorithmNotSuitable";
+		/**
+		 * The security of the hash algorithm is not suitable at the relevant point of time.
+		 */
 		public static final String HASHALG_NOT_SUITABLE = SIG_PFX + "hashAlgorithmNotSuitable";
+		/**
+		 * The certificate path is invalid.
+		 */
 		public static final String CERT_PATH_INVALID = SIG_PFX + "invalidCertificatePath";
+		/**
+		 * The certificate has been revoked.
+		 */
 		public static final String CERT_REVOKED = SIG_PFX + "certificateRevoked";
+		/**
+		 * The reference time is outside the validity period of a certificate.
+		 */
 		public static final String CERT_EXPIRED = SIG_PFX + "referenceTimeNotWithinCertificateValidityPeriod";
+		/**
+		 * Invalid extensions in a certificate.
+		 */
 		public static final String INVALID_CERT_EXT = SIG_PFX + "invalidCertificateExtension";
+		/**
+		 * Verification of a signature manifest has failed.
+		 */
 		public static final String SIG_MANIFEST_WRONG = SIG_PFX + "signatureManifestNotCorrect";
+		/**
+		 * The stated {@code SignatureType} does not support {@code SignatureForm} parameter.
+		 */
 		public static final String SIG_NOT_SUPPORT_FORM_CLARIFICATION = SIG_PFX + "signatureTypeDoesNot" +
 			"SupportSignatureFormClarificationWarning";
+		/**
+		 * Unknown {@code SignatureForm}.
+		 */
 		public static final String UNKNOWN_SIG_FORM = SIG_PFX + "unknownSignatureForm";
+		/**
+		 * {@code IncludeObject} only permitted with XML signatures.
+		 */
 		public static final String INCLUDE_ONLY_XML = SIG_PFX + "includeObjectOnlyForXMLSignatureAllowedWarning";
+		/**
+		 * It was not possible to resolve the XPath expression.
+		 */
 		public static final String XPATH_ERROR = SIG_PFX + "xPathEvaluationError";
+		/**
+		 * Wrong message digest.
+		 * The calculated digest of the message is not equal to the message digest in the
+		 * {@code MessageDigest}-attribute of the CMS-Signature or the {@code DigestValue}-element of the
+		 * XML-signature respectively.
+		 */
 		public static final String WRONG_MSG_DIGEST = SIG_PFX + "wrongMessageDigest";
+		/**
+		 * IFD inconsistency.
+		 * The compatibility-check with the present IFD failed.
+		 */
 		public static final String IFD_INCONSISTENCY = SIG_PFX + "IFDInconsistency";
 	    };
 
@@ -371,9 +646,22 @@ public class ECardConstants {
 	     */
 	    public static class Viewer {
 
+		/**
+		 * Unsuitable stylesheet for transmitted document.
+		 */
 		public static final String UNSUITABLE_SS = VIEW_PFX + "unsuitableStylesheetForDocument";
+		/**
+		 * Cancellation by the viewer.
+		 */
 		public static final String USER_CANCEL = VIEW_PFX + "cancelationByUser";
+		/**
+		 * Time exceeded (timeout).
+		 * The operation was terminated as the set time was exceeded.
+		 */
 		public static final String TIMEOUT = VIEW_PFX + "timeout";
+		/**
+		 * The ViewerMessage is too long.
+		 */
 		public static final String MSG_TOO_LONG = VIEW_PFX + "viewerMessageTooLong";
 
 	    };
@@ -392,27 +680,103 @@ public class ECardConstants {
 	    private static final String SUPPORT_PFX = SAL_PFX + "/support#";
 	    private static final String EAC_PFX = SAL_PFX + "/mEAC#";