Standardize exception message style and failure taxonomy across the PKI module #16

Open
opened 2026-03-24 18:07:37 +01:00 by galambos · 0 comments
Owner

The codebase already trends toward concise exception messages, but message style and failure taxonomy are not fully uniform. Some messages are phrased as internal diagnostics, others as user-facing validation errors, and some still use inconsistent punctuation or wording. This showed up across multiple classes during review.

Why this matters

For a professional PKI foundation, failures should be consistent, reviewable, and easy to map into audit records, logs, and external service responses.

Acceptance criteria

  • Standardize message style across the PKI module.
  • Separate internal diagnostics from externally meaningful error messages where appropriate.
  • Keep messages safe for logs in regulated environments.
  • Update JavaDoc for thrown exceptions where the contract is public/protected.
The codebase already trends toward concise exception messages, but message style and failure taxonomy are not fully uniform. Some messages are phrased as internal diagnostics, others as user-facing validation errors, and some still use inconsistent punctuation or wording. This showed up across multiple classes during review. ## Why this matters For a professional PKI foundation, failures should be consistent, reviewable, and easy to map into audit records, logs, and external service responses. ## Acceptance criteria - Standardize message style across the PKI module. - Separate internal diagnostics from externally meaningful error messages where appropriate. - Keep messages safe for logs in regulated environments. - Update JavaDoc for thrown exceptions where the contract is public/protected.
galambos added this to the PKI Foundation Hardening and Regulated Operations Roadmap project 2026-03-24 18:56:06 +01:00
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Egothor/ZeroEcho#16