Skip to content

mtakaki/dropwizard-admin-resource

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
September 16, 2023 08:25
src
July 24, 2023 09:37
April 9, 2017 22:16
September 16, 2023 08:44

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
4.0.1 4.0.1

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>4.0.1</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)