com.yammer.dropwizard.config.Configuration Maven / Gradle / Ivy

Go to download
package com.yammer.dropwizard.config;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Objects;

import javax.validation.Valid;
import javax.validation.constraints.NotNull;

/**
 * An object representation of the YAML configuration file. Extend this with your own configuration
 * properties, and they'll be parsed from the YAML file as well.
 * 
 * For example, given a YAML file with this:
 * 
 * name: "Random Person"
 * age: 43
 * # ... etc ...
 * 
 * And a configuration like this:
 *  * public class ExampleConfiguration extends Configuration {
 *     \@NotNull
 *     private String name;
 *
 *     \@Min(1)
 *     \@Max(120)
 *     private int age;
 *
 *     public String getName() {
 *         return name;
 *     }
 *
 *     public int getAge() {
 *         return age;
 *     }
 * }
 * 
 * Dropwizard will parse the given YAML file and provide an {@code ExampleConfiguration} instance
 * to your service whose {@code getName()} method will return {@code "Random Person"} and whose
 * {@code getAge()} method will return {@code 43}.
 *
 * @see YAML Cookbook
 */
@SuppressWarnings("UnusedDeclaration")
public class Configuration {
    @Valid
    @NotNull
    @JsonProperty
    private HttpConfiguration http = new HttpConfiguration();

    @Valid
    @NotNull
    @JsonProperty
    private LoggingConfiguration logging = new LoggingConfiguration();

    /**
     * Returns the HTTP-specific section of the configuration file.
     *
     * @return HTTP-specific configuration parameters
     */
    public HttpConfiguration getHttpConfiguration() {
        return http;
    }

    /**
     * Sets the HTTP-specific section of the configuration file.
     */
    public void setHttpConfiguration(HttpConfiguration config) {
        this.http = config;
    }

    /**
     * Returns the logging-specific section of the configuration file.
     *
     * @return logging-specific configuration parameters
     */
    public LoggingConfiguration getLoggingConfiguration() {
        return logging;
    }

    /**
     * Sets the logging-specific section of the configuration file.
     */
    public void setLoggingConfiguration(LoggingConfiguration config) {
        this.logging = config;
    }

    @Override
    public String toString() {
        return Objects.toStringHelper(this)
                      .add("http", http)
                      .add("logging", logging)
                      .toString();
    }
}