All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.honeybadger.reporter.config.ConfigContext Maven / Gradle / Ivy

There is a newer version: 2.1.2
Show newest version
package io.honeybadger.reporter.config;

import java.net.URI;
import java.util.Set;

/**
 * Interface defining the common properties needed to configure a
 * {@link io.honeybadger.reporter.NoticeReporter}.
 *
 * @author Elijah Zupancic
 * @since 1.0.10
 */
public interface ConfigContext {
    /** @return name of environment */
    String getEnvironment();

    /** @return Honeybadger URL to use */
    URI getHoneybadgerUrl();

    /** @return Honeybadger API key to use */
    String getApiKey();

    /** @return Set of system properties to not include */
    Set getExcludedSysProps();

    /** @return Set of parameters to not include */
    Set getExcludedParams();

    /** @return Set of exception classes to ignore */
    Set getExcludedClasses();

    /** @return String that maps a package to an application */
    String getApplicationPackage();

    /** @return Honeybadger Read API key */
    String getHoneybadgerReadApiKey();

    /** @return Do we display the feedback form? */
    Boolean isFeedbackFormDisplayed();

    /** @return The path to the feedback form template */
    String getFeedbackFormPath();

    /** @return Host of proxy server to send traffic through */
    String getHttpProxyHost();

    /** @return Port of proxy server to send traffic through */
    Integer getHttpProxyPort();

    /** @return Optional configuration parameter to adjust number of attempts to retry sending an error
     * report in the event of a network timeout or other transmission exception. Defaults to 3. */
    Integer getMaximumErrorReportingRetries();
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy