Dropwizard Admin Resource

Provides the ability to register resources under the admin port

License

License

Categories

Categories

DropWizard Container Microservices
GroupId

GroupId

com.github.mtakaki
ArtifactId

ArtifactId

dropwizard-admin-resource
Last Version

Last Version

2.0.9
Release Date

Release Date

Type

Type

jar
Description

Description

Dropwizard Admin Resource
Provides the ability to register resources under the admin port
Project URL

Project URL

https://github.com/mtakaki/dropwizard-admin-resource
Source Code Management

Source Code Management

https://github.com/mtakaki/dropwizard-admin-resource

Download dropwizard-admin-resource

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.mtakaki/dropwizard-admin-resource/ -->
<dependency>
    <groupId>com.github.mtakaki</groupId>
    <artifactId>dropwizard-admin-resource</artifactId>
    <version>2.0.9</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.mtakaki/dropwizard-admin-resource/
implementation 'com.github.mtakaki:dropwizard-admin-resource:2.0.9'
// https://jarcasting.com/artifacts/com.github.mtakaki/dropwizard-admin-resource/
implementation ("com.github.mtakaki:dropwizard-admin-resource:2.0.9")
'com.github.mtakaki:dropwizard-admin-resource:jar:2.0.9'
<dependency org="com.github.mtakaki" name="dropwizard-admin-resource" rev="2.0.9">
  <artifact name="dropwizard-admin-resource" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.mtakaki', module='dropwizard-admin-resource', version='2.0.9')
)
libraryDependencies += "com.github.mtakaki" % "dropwizard-admin-resource" % "2.0.9"
[com.github.mtakaki/dropwizard-admin-resource "2.0.9"]

Dependencies

provided (2)

Group / Artifact Type Version
io.dropwizard : dropwizard-core jar 2.0.9
org.projectlombok : lombok jar 1.18.12

test (4)

Group / Artifact Type Version
io.dropwizard : dropwizard-testing jar 2.0.9
io.dropwizard : dropwizard-client jar 2.0.9
org.junit.jupiter : junit-jupiter-engine jar 5.5.2
org.assertj : assertj-core jar 3.16.1

Project Modules

There are no modules declared in this project.

Status

CircleCI Coverage Status Codacy Badge Download Javadoc

dropwizard-admin-resource

This library provides the ability to register Jersey resources to the admin port.

Supported versions:

Dropwizard Admin resource
1.1.0 1.1.0
1.1.4 1.1.4
1.2.2 1.2.2
1.3.8 1.3.8
2.0.0 2.0.0
2.0.9 2.0.9

Maven

The library is available at the maven central, so just add dependency to pom.xml:

<dependencies>
  <dependency>
    <groupId>com.github.mtakaki</groupId>
    <artifactId>dropwizard-admin-resource</artifactId>
    <version>2.0.9</version>
  </dependency>
</dependencies>

Adding admin resources

First you add the bundle to your application:

public class TestApplication extends Application<TestConfiguration> {
    private final AdminResourceBundle adminResource = new AdminResourceBundle();

    @Override
    public void initialize(final Bootstrap<TestConfiguration> bootstrap) {
        bootstrap.addBundle(this.adminResource);
    }

    @Override
    public void run(final TestConfiguration configuration, final Environment environment)
            throws Exception {
        final JerseyEnvironment adminJerseyEnvironment = this.adminResourceBundle
                .getJerseyEnvironment();
        // Not necessary, but with this you can make sure you use the same settings
        // of your jackson mapper settings for both jersey environments.
        adminJerseyEnvironment.register(new JacksonBinder(environment.getObjectMapper()));
        adminJerseyEnvironment.register(new TestResource());
    }
}

The following will show on your logs when the admin resource is successfully registered:

INFO  [2017-04-10 04:39:22,177] io.dropwizard.jersey.DropwizardResourceConfig: Registering admin resources
The following paths were found for the configured resources:

    GET     /test (com.github.mtakaki.dropwizard.admin.AdminResourceBundleIntegrationTest.TestResource)

Versions

Version
2.0.9
2.0.0
1.3.8
1.2.2
1.1.0