MapConfigContext (honeybadger-java-shaded 2.1.2 API)

java.lang.Object
- io.honeybadger.reporter.config.MapConfigContext

All Implemented Interfaces:

ConfigContext

Direct Known Subclasses:

ServletFilterConfigContext
```
public class MapConfigContext
extends Object
implements ConfigContext
```
ConfigContext implementation that is used for configuring instances from a Map.

Since:

1.0.10

Author:

Elijah Zupancic

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`ALL_PROPERTIES` List of all properties that we read from configuration.
`static String`	`APPLICATION_PACKAGE_PROP_KEY` System property key that maps a package to an application.
`static String`	`CONNECT_TIMEOUT` System property key identifying the connect timeout
`static String`	`DISPLAY_FEEDBACK_FORM_KEY` System property key indicating if we display the feedback form.
`static String`	`ENVIRONMENT_KEY` System property key identifying the runtime environment.
`static String`	`FEEDBACK_FORM_TEMPLATE_PATH_KEY` System property key indicating the path to the feedback form template.
`static String`	`HONEYBADGER_API_KEY` System property key identifying the Honeybadger API key to use.
`static String`	`HONEYBADGER_API_KEY_ENV` System property key identifying the Honeybadger API key to use.
`static String`	`HONEYBADGER_EXCLUDED_CLASSES_KEY` CSV list of exception classes to ignore.
`static String`	`HONEYBADGER_EXCLUDED_PARAMS_KEY` CSV list of parameters to not include.
`static String`	`HONEYBADGER_EXCLUDED_PROPS_KEY` CSV list of system properties to not include.
`static String`	`HONEYBADGER_MAXIMUM_ERROR_REPORTING_RETRIES_KEY` System property key indicating the maximum number of attempts to submit an error.
`static String`	`HONEYBADGER_URL_KEY` System property key identifying the Honeybadger URL to use.
`static String`	`HTTP_PROXY_HOST_KEY` System property key indicating the proxy server.
`static String`	`HTTP_PROXY_PORT_KEY` System property key indicating the proxy port.
`static String`	`JAVA_ENVIRONMENT_KEY` System property key identifying the runtime environment.
`static String`	`READ_API_KEY_ENV` Environment variable identifying the Honeybadger Read API key.
`static String`	`READ_API_KEY_PROP_KEY` System property key identifying the Honeybadger Read API key.
`static String`	`SOCKET_TIMEOUT` System property key identifying the socket timeout

Constructor Summary

Constructors
Constructor and Description

MapConfigContext(Map<?,?> backingMap)

Constructors
Constructor and Description
`MapConfigContext(Map<?,?> backingMap)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getApiKey()`
`String`	`getApplicationPackage()`
`Integer`	`getConnectTimeout()`
`String`	`getEnvironment()`
`Set<String>`	`getExcludedClasses()`
`Set<String>`	`getExcludedParams()`
`Set<String>`	`getExcludedSysProps()`
`String`	`getFeedbackFormPath()`
`String`	`getHoneybadgerReadApiKey()`
`URI`	`getHoneybadgerUrl()`
`String`	`getHttpProxyHost()`
`Integer`	`getHttpProxyPort()`
`Integer`	`getMaximumErrorReportingRetries()`
`Integer`	`getSocketTimeout()`
`Boolean`	`isFeedbackFormDisplayed()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENVIRONMENT_KEY
```
public static final String ENVIRONMENT_KEY
```
    System property key identifying the runtime environment.
    
    See Also:
    
    Constant Field Values
  - JAVA_ENVIRONMENT_KEY
```
public static final String JAVA_ENVIRONMENT_KEY
```
    System property key identifying the runtime environment.
    
    See Also:
    
    Constant Field Values
  - HONEYBADGER_URL_KEY
```
public static final String HONEYBADGER_URL_KEY
```
    System property key identifying the Honeybadger URL to use.
    
    See Also:
    
    Constant Field Values
  - HONEYBADGER_API_KEY
```
public static final String HONEYBADGER_API_KEY
```
    System property key identifying the Honeybadger API key to use.
    
    See Also:
    
    Constant Field Values
  - HONEYBADGER_API_KEY_ENV
```
public static final String HONEYBADGER_API_KEY_ENV
```
    System property key identifying the Honeybadger API key to use.
    
    See Also:
    
    Constant Field Values
  - HONEYBADGER_EXCLUDED_PROPS_KEY
```
public static final String HONEYBADGER_EXCLUDED_PROPS_KEY
```
    CSV list of system properties to not include.
    
    See Also:
    
    Constant Field Values
  - HONEYBADGER_EXCLUDED_PARAMS_KEY
```
public static final String HONEYBADGER_EXCLUDED_PARAMS_KEY
```
    CSV list of parameters to not include.
    
    See Also:
    
    Constant Field Values
  - HONEYBADGER_EXCLUDED_CLASSES_KEY
```
public static final String HONEYBADGER_EXCLUDED_CLASSES_KEY
```
    CSV list of exception classes to ignore.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_PACKAGE_PROP_KEY
```
public static final String APPLICATION_PACKAGE_PROP_KEY
```
    System property key that maps a package to an application.
    
    See Also:
    
    Constant Field Values
  - READ_API_KEY_PROP_KEY
```
public static final String READ_API_KEY_PROP_KEY
```
    System property key identifying the Honeybadger Read API key.
    
    See Also:
    
    Constant Field Values
  - READ_API_KEY_ENV
```
public static final String READ_API_KEY_ENV
```
    Environment variable identifying the Honeybadger Read API key.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_FEEDBACK_FORM_KEY
```
public static final String DISPLAY_FEEDBACK_FORM_KEY
```
    System property key indicating if we display the feedback form.
    
    See Also:
    
    Constant Field Values
  - FEEDBACK_FORM_TEMPLATE_PATH_KEY
```
public static final String FEEDBACK_FORM_TEMPLATE_PATH_KEY
```
    System property key indicating the path to the feedback form template.
    
    See Also:
    
    Constant Field Values
  - HONEYBADGER_MAXIMUM_ERROR_REPORTING_RETRIES_KEY
```
public static final String HONEYBADGER_MAXIMUM_ERROR_REPORTING_RETRIES_KEY
```
    System property key indicating the maximum number of attempts to submit an error. see { @link HoneyBadgerReporter }
    
    See Also:
    
    Constant Field Values
  - HTTP_PROXY_HOST_KEY
```
public static final String HTTP_PROXY_HOST_KEY
```
    System property key indicating the proxy server.
    
    See Also:
    
    Constant Field Values
  - HTTP_PROXY_PORT_KEY
```
public static final String HTTP_PROXY_PORT_KEY
```
    System property key indicating the proxy port.
    
    See Also:
    
    Constant Field Values
  - SOCKET_TIMEOUT
```
public static final String SOCKET_TIMEOUT
```
    System property key identifying the socket timeout
    
    See Also:
    
    Constant Field Values
  - CONNECT_TIMEOUT
```
public static final String CONNECT_TIMEOUT
```
    System property key identifying the connect timeout
    
    See Also:
    
    Constant Field Values
  - ALL_PROPERTIES
```
public static final String[] ALL_PROPERTIES
```
    List of all properties that we read from configuration.
- Constructor Detail
  - MapConfigContext
```
public MapConfigContext(Map<?,?> backingMap)
```
- Method Detail
  - getEnvironment
```
public String getEnvironment()
```
    Specified by:
    
    getEnvironment in interface ConfigContext
    
    Returns:
    
    name of environment
  - getHoneybadgerUrl
```
public URI getHoneybadgerUrl()
```
    Specified by:
    
    getHoneybadgerUrl in interface ConfigContext
    
    Returns:
    
    Honeybadger URL to use
  - getApiKey
```
public String getApiKey()
```
    Specified by:
    
    getApiKey in interface ConfigContext
    
    Returns:
    
    Honeybadger API key to use
  - getExcludedSysProps
```
public Set<String> getExcludedSysProps()
```
    Specified by:
    
    getExcludedSysProps in interface ConfigContext
    
    Returns:
    
    Set of system properties to not include
  - getExcludedParams
```
public Set<String> getExcludedParams()
```
    Specified by:
    
    getExcludedParams in interface ConfigContext
    
    Returns:
    
    Set of parameters to not include
  - getExcludedClasses
```
public Set<String> getExcludedClasses()
```
    Specified by:
    
    getExcludedClasses in interface ConfigContext
    
    Returns:
    
    Set of exception classes to ignore
  - getApplicationPackage
```
public String getApplicationPackage()
```
    Specified by:
    
    getApplicationPackage in interface ConfigContext
    
    Returns:
    
    String that maps a package to an application
  - getHoneybadgerReadApiKey
```
public String getHoneybadgerReadApiKey()
```
    Specified by:
    
    getHoneybadgerReadApiKey in interface ConfigContext
    
    Returns:
    
    Honeybadger Read API key
  - isFeedbackFormDisplayed
```
public Boolean isFeedbackFormDisplayed()
```
    Specified by:
    
    isFeedbackFormDisplayed in interface ConfigContext
    
    Returns:
    
    Do we display the feedback form?
  - getFeedbackFormPath
```
public String getFeedbackFormPath()
```
    Specified by:
    
    getFeedbackFormPath in interface ConfigContext
    
    Returns:
    
    The path to the feedback form template
  - getHttpProxyHost
```
public String getHttpProxyHost()
```
    Specified by:
    
    getHttpProxyHost in interface ConfigContext
    
    Returns:
    
    Host of proxy server to send traffic through
  - getHttpProxyPort
```
public Integer getHttpProxyPort()
```
    Specified by:
    
    getHttpProxyPort in interface ConfigContext
    
    Returns:
    
    Port of proxy server to send traffic through
  - getMaximumErrorReportingRetries
```
public Integer getMaximumErrorReportingRetries()
```
    Specified by:
    
    getMaximumErrorReportingRetries in interface ConfigContext
    
    Returns:
    
    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.
  - getSocketTimeout
```
public Integer getSocketTimeout()
```
    Specified by:
    
    getSocketTimeout in interface ConfigContext
    
    Returns:
    
    Timeout for socket connection within HTTP client
  - getConnectTimeout
```
public Integer getConnectTimeout()
```
    Specified by:
    
    getConnectTimeout in interface ConfigContext
    
    Returns:
    
    Timeout for initial connect within HTTP client

Class MapConfigContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENVIRONMENT_KEY

JAVA_ENVIRONMENT_KEY

HONEYBADGER_URL_KEY

HONEYBADGER_API_KEY

HONEYBADGER_API_KEY_ENV

HONEYBADGER_EXCLUDED_PROPS_KEY

HONEYBADGER_EXCLUDED_PARAMS_KEY

HONEYBADGER_EXCLUDED_CLASSES_KEY

APPLICATION_PACKAGE_PROP_KEY

READ_API_KEY_PROP_KEY

READ_API_KEY_ENV

DISPLAY_FEEDBACK_FORM_KEY

FEEDBACK_FORM_TEMPLATE_PATH_KEY

HONEYBADGER_MAXIMUM_ERROR_REPORTING_RETRIES_KEY

HTTP_PROXY_HOST_KEY

HTTP_PROXY_PORT_KEY

SOCKET_TIMEOUT

CONNECT_TIMEOUT

ALL_PROPERTIES

Constructor Detail

MapConfigContext

Method Detail

getEnvironment

getHoneybadgerUrl

getApiKey

getExcludedSysProps

getExcludedParams

getExcludedClasses

getApplicationPackage

getHoneybadgerReadApiKey

isFeedbackFormDisplayed

getFeedbackFormPath

getHttpProxyHost

getHttpProxyPort

getMaximumErrorReportingRetries

getSocketTimeout

getConnectTimeout