Specification: Eclipse MicroProfile

Version: 2.1

Status: Final

Release: October 19, 2018

Copyright (c) 2017-2018 Eclipse Microprofile Contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Architecture

The MicroProfile pom will identify the contents of each MicroProfile release. The contents will be those features and versions agreed to by the MicroProfile community. These features may be external to the MicroProfile community (Java EE features such as JAX-RS 2.1), or they be a component of the MicroProfile project (such as Config 1.3).

Since the MicroProfile repo is an "umbrella" project, there will be no individual API or TCK generated for this component. Only this Specification will be generated and maintained to document the contents of each release.

In reverse chronological order, here’s the specification for each MicroProfile release.

MicroProfile 2.1 (4Q2018)

MicroProfile 2.1 is the eighth release for the Eclipse MicroProfile project. Based on MicroProfile’s time-boxed release process, this is an incremental release that includes an update to OpenTracing 1.2. MicroProfile 2.x releases are based on Java EE 8. If you are still dependent on Java EE 7, please consider using the 1.4 release of MicroProfile.

Thus, the complete list of functional components for MicroProfile 2.1 includes…​

The Maven coordinates for this Eclipse release are as follows:

<dependency>
    <groupId>org.eclipse.microprofile</groupId>
    <artifactId>microprofile</artifactId>
    <version>2.1</version>
    <type>pom</type>
    <scope>provided</scope>
</dependency>

Here is the link to the github repository for this Eclipse-based project.

MicroProfile 2.0.1 (3Q2018)

MicroProfile 2.0.1 is the seventh release for the Eclipse MicroProfile project. This is a patch release to correct an issue with the JSON-B maven dependency in the pom.xml. The defined content for MicroProfile 2.0 did not change — MicroProfile 2.0 was a major release since the Java EE dependencies are now based on Java EE 8. If you are still dependent on Java EE 7, please consider using the 1.4 release of MicroProfile.

The Maven coordinates for this Eclipse release are as follows:

<dependency>
    <groupId>org.eclipse.microprofile</groupId>
    <artifactId>microprofile</artifactId>
    <version>2.0.1</version>
    <type>pom</type>
    <scope>provided</scope>
</dependency>

Here is the link to the github repository for this Eclipse-based project.

MicroProfile 2.0 (2Q2018)

MicroProfile 2.0 is the sixth release for the Eclipse MicroProfile project. This is a major new release for MicroProfile since the Java EE dependencies are now based on Java EE 8. If you are still dependent on Java EE 7, please consider using the 1.4 release of MicroProfile.

Based on our time-boxed process, the content for MicroProfile 2.0 will be MicroProfile 1.4 plus Java EE 8. Thus, the complete list of functional components for MicroProfile 2.0 includes…​

The Maven coordinates for this Eclipse release are as follows:

<dependency>
    <groupId>org.eclipse.microprofile</groupId>
    <artifactId>microprofile</artifactId>
    <version>2.0</version>
    <type>pom</type>
    <scope>provided</scope>
</dependency>

Here is the link to the github repository for this Eclipse-based project.

Required APIs

Compliant implementations of Eclipse MicroProfile 2.0.1 must provide at least the following APIs and minimum versions. These APIs and versions guarantee application developers a minimum set of APIs and are not intended to be restrictive. Implementations may include APIs not listed below as well they may support more recent versions than what is listed below.

MicroProfile applications that make use of APIs or versions not mentioned below are not considered portable.

Java SE 8

Libraries in use by the MicroProfile leverage new features provided in Java SE 8, therefore Java SE 7 and before are unsupported. MicroProfile 2.x implementations may provide support for Java SE 9 and beyond, however Java SE 8 compatibility must be maintained.

CDI 2.0

CDI provides the base for a growing number of APIs included in MicroProfile 2.0. Use of implementations beyond CDI 2.0 in MicroProfile is allowed, however, not required as of version 2.0 of MicroProfile.

JAX-RS 2.1

JAX-RS provides both standard client and server APIs for RESTful communication by MicroProfile 2.0 applications. Use of implementations beyond JAX-RS 2.1 in MicroProfile is allowed, however, not required as of version 2.0 of MicroProfile.

JSON-B 1.0

JSON-B is leveraged as part of MicroProfile 2.0 to provide standard APIs for binding JSON documents to Java code. Use of implementations beyond JSON-B 1.0 in MicroProfile is allowed, however, not required as of version 2.0 of MicroProfile.

JSON-P 1.1

JSON-P is leveraged as part of MicroProfile 2.0 to provide standard APIs for processing JSON documents. Use of implementations beyond JSON-P 1.1 in MicroProfile is allowed, however, not required as of version 2.0 of MicroProfile.

Common Annotations 1.3

Common Annotations provides annotations for common semantic concepts across a variety of individual technologies in the Java™ SE and Java™ EE platforms. Use of implementations beyond Common Annotations 1.3 in MicroProfile is allowed, however, not required as of version 2.0 of MicroProfile.

Eclipse MicroProfile Config 1.3

Eclipse MicroProfile Config provides applications and microservices means to obtain configuration properties through several environment-aware sources both internal and external to the application and made available through dependency injection or lookup.

The Eclipse MicroProfile Config API is currently in the JSR process and is actively seeking adoption stories, feedback, and Expert Group members.

Eclipse MicroProfile Fault Tolerance 1.1

Eclipse MicroProfile Fault Tolerance provides the ability to separate execution logic from business logic. Key aspects of the API include TimeOut, RetryPolicy, Fallback, Bulkhead, and Circuit Breaker processing.

Eclipse MicroProfile Health Check 1.0

Eclipse MicroProfile Health Check provides the ability to probe the state of a computing node from another machine (e.g. kubernetes service controller).

Eclipse MicroProfile JWT Authentication 1.1

Eclipse MicroProfile JWT Authentication provides role based access control (RBAC) microservice endpoints using OpenID Connect (OIDC) and JSON Web Tokens (JWT).

Eclipse MicroProfile Metrics 1.1

Eclipse MicroProfile Metrics provides a unified way for MicroProfile servers to export monitoring data to management agents. Metrics will also provide a common Java API for exposing their telemetry data.

Eclipse MicroProfile OpenAPI 1.0

Eclipse MicroProfile OpenAPI provides a unified Java API for the OpenAPI v3 specification that all application developers can use to expose their API documentation.

Eclipse MicroProfile OpenTracing 1.2

Eclipse MicroProfile OpenTracing defines an API and associated behaviors that allow services to easily participate in a distributed tracing environment.

Eclipse MicroProfile Rest Client 1.1

Eclipse MicroProfile Rest Client provides a type-safe approach for invoking RESTful services over HTTP. The MicroProfile Rest Client builds upon the JAX-RS 2.1 APIs for consistency and ease-of-use.

Notices

Compatibility Disclaimer

APIs originating from the Eclipse MicroProfile community, such as Config 1.0, should be considered pre-standard and experimental in nature. While these APIs are developed collaboratively and generally considered best-of-breed, the MicroProfile community reserves the right to make backwards incompatible changes based on substantial user feedback.

It is the overarching goal of the Eclipse MicroProfile community to iterate quickly and prioritize innovation over legacy. Thus, APIs included are offered with the express purpose of feedback and rapid innovation through proven real-world usage. Developers should use these APIs with this knowledge in mind and are encouraged to provide feedback of any kind, including proposals of fundamental change to the design of the APIs themselves.

Contribution

The Eclipse MicroProfile community is an open source community part of the Eclipse Foundation. We accept contributions from corporations or individuals. To learn how to contribute to the Eclipse MicroProfile see:

Feedback

Comments, questions or feedback on this document should be directed to The Eclipse MicroProfile community as a whole at [email protected]. Archives are available via the Google Group page: