Beadledom Health - Service

A simple, composable framework for building RESTFul services

License

License

GroupId

GroupId

com.cerner.beadledom
ArtifactId

ArtifactId

beadledom-health
Last Version

Last Version

4.1.2
Release Date

Release Date

Type

Type

jar
Description

Description

Beadledom Health - Service
A simple, composable framework for building RESTFul services
Project Organization

Project Organization

Cerner Innovation, Inc.

Download beadledom-health

How to add to project

<!-- https://jarcasting.com/artifacts/com.cerner.beadledom/beadledom-health/ -->
<dependency>
    <groupId>com.cerner.beadledom</groupId>
    <artifactId>beadledom-health</artifactId>
    <version>4.1.2</version>
</dependency>
// https://jarcasting.com/artifacts/com.cerner.beadledom/beadledom-health/
implementation 'com.cerner.beadledom:beadledom-health:4.1.2'
// https://jarcasting.com/artifacts/com.cerner.beadledom/beadledom-health/
implementation ("com.cerner.beadledom:beadledom-health:4.1.2")
'com.cerner.beadledom:beadledom-health:jar:4.1.2'
<dependency org="com.cerner.beadledom" name="beadledom-health" rev="4.1.2">
  <artifact name="beadledom-health" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.cerner.beadledom', module='beadledom-health', version='4.1.2')
)
libraryDependencies += "com.cerner.beadledom" % "beadledom-health" % "4.1.2"
[com.cerner.beadledom/beadledom-health "4.1.2"]

Dependencies

compile (9)

Group / Artifact Type Version
com.cerner.beadledom : beadledom-health-api jar 4.1.2
com.github.spullara.mustache.java : compiler jar 0.9.5
com.google.auto.value : auto-value-annotations jar 1.7.3
com.google.guava : guava jar 29.0-jre
com.google.inject : guice jar 4.2.3
com.google.inject.extensions : guice-multibindings jar 4.2.3
com.squareup.okhttp3 : okhttp jar 4.7.2
javax.inject : javax.inject jar 1
org.slf4j : slf4j-api jar 1.7.30

provided (1)

Group / Artifact Type Version
com.google.auto.value : auto-value jar 1.7.3

test (10)

Group / Artifact Type Version
com.cerner.beadledom : beadledom-testing jar 4.1.2
com.squareup.okhttp3 : mockwebserver jar 4.7.2
org.jboss.resteasy : resteasy-core jar 4.5.6.Final
org.junit.jupiter : junit-jupiter-api jar 5.6.2
org.junit.jupiter : junit-jupiter-engine jar 5.6.2
org.mockito : mockito-core jar 3.3.3
org.scalatest : scalatest_2.12 jar 3.1.1
org.scalatestplus : junit-4-12_2.12 jar 3.1.1.0
org.scalatestplus : mockito-3-2_2.12 jar 3.1.1.0
org.scalatestplus : scalacheck-1-14_2.12 jar 3.1.1.0

Project Modules

There are no modules declared in this project.

Beadledom

Beadledom is a bundle of common components required for building JAX-RS web services. It is the starting point for new services. The core of Beadledom provides health checks, API docs via Swagger, JSON serialization via Jackson, and integration of these components with Guice. For more information on creating a service check out our documentation.

Beadledom is made up of the following components:

  • avro - Additional Avro functionality required for services.
  • client - Deprecated. HTTP client for communicating with the JAX-RS web services.
  • common - Common utilities.
  • Configuration - Centralized API to access the aggregated configurations from different sources.
  • core - Core Guice module that pulls in all the other recommended Beadledom modules.
  • guice - Additional Guice extensions.
  • guice-dynamicbindings - To retrieve annotated bindings at runtime.
  • health - Health checks for services.
  • jackson - JSON serialization for services.
  • jaxrs - Restful API additions (filters and providers)
  • lifecycle - Defines and manages the lifecyle hooks for an application or a container.
  • lifecycle-governator - An implementation of the beadledom-lifecycle using Governator.
  • pagination - Parameters and hypermedia for paginated endpoints.
  • resteasy - RESTEasy implementation and integration of Beadledom components.
  • swagger2 - API documentation.
  • testing - Testing utilities for the services.

Additional Documentation:

Below is the list of documentations that are helpful to get started but outside the scope of the Beadledom documentation.

Contribute

You are more than welcome to Contribute to Beadledom.

Read our Contribution guidelines.

Releasing

Depending on the need for the release, every month or earlier the beadledom committer team reviews contributions in main that have not been released. The committer team then takes a quick vote on if a release of master should be made. If 2/3 of the committers agree on the release a release is cut.

To release Beadledom please follow our releasing documentation.

License

Copyright 2017 Cerner Innovation, Inc.

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.
com.cerner.beadledom

Cerner

Versions

Version
4.1.2
4.1.1
4.1
4.0
3.7.1
3.7
3.6
3.5
3.4
3.3
3.2.5
3.2.4
3.2.3
3.1
3.0
2.9
2.8
2.7.2
2.7
2.6.1
2.6
2.5.1
2.5
2.4
2.3