microprofile-server

name

microprofile-server

description

Architecture and coding rules for long-running Java MicroProfile / Jakarta EE server applications — BCE layering, business components (BC), JAX-RS resources, CDI, JSON-P, testing (unit/integration/system), and Maven project structure. Use when creating, generating, scaffolding, writing, or reviewing code, resources, entities, boundaries, or business components in MicroProfile server projects. Not for serverless deployments.

Composition

• compose with java-conventions for all language-level Java rules (syntax, style, naming, visibility, interfaces/classes, methods/lambdas, streams/collections, exceptions, comments/JavaDoc)
• this skill specializes only the MicroProfile / Jakarta EE server context — it does not restate language-level rules

Dependencies

• prefer dependencies in this order: Java SE, MicroProfile, Jakarta EE

Exceptions (JAX-RS)

• in JAX-RS projects, inherit from WebApplicationException for custom exceptions
• use explicit exceptions like BadRequestException for Response.Status.BAD_REQUEST
• throw explicit WebApplicationException subclasses (e.g. BadRequestException, NotFoundException) rather than constructing Response objects inline — they are automatically mapped to the correct HTTP status by the JAX-RS runtime

BCE/ECB Architecture

• structure code using the Boundary Control Entity (BCE/ECB) pattern
• package structure: [ORGANIZATION_NAME].[PROJECT_NAME].[COMPONENT_NAME].[boundary|control|entity]
• top level package reflects the application responsibility or name
• suggest renaming the top level [PROJECT_NAME] package when it does not reflect the project's name or responsibility
• business components are children of top level package, named after their responsibilities
• a BC may represent a domain concept or a shared concern; both are valid when the responsibility has a name and is reused across the application
• boundary, control, entity packages are only allowed in business components