BaseChainedConfigContext (honeybadger-java-shaded 2.1.2 API)

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

All Implemented Interfaces:

ConfigContext

Direct Known Subclasses:

PlayConfigContext, SpringConfigContext, StandardConfigContext, SystemSettingsConfigContext
```
public abstract class BaseChainedConfigContext
extends Object
implements ConfigContext
```
Abstract implementation of ConfigContext that allows for chaining in default implementations of configuration that are delegate to when we aren't passed a value.

Since:

1.0.10

Author:

Elijah Zupancic

Field Summary

Fields
Modifier and Type Field and Description

static ConfigContext DEFAULT_CONFIG
Singleton instance of default configuration for easy reference.

Fields
Modifier and Type	Field and Description
`static ConfigContext`	`DEFAULT_CONFIG` Singleton instance of default configuration for easy reference.

Constructor Summary

Constructors
Constructor and Description
`BaseChainedConfigContext()` Constructor that prepopulates configuration context with the default values.
`BaseChainedConfigContext(ConfigContext defaultingContext)` Constructor that takes a default value for each one of the configuration values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getApiKey()`
`String`	`getApplicationPackage()`
`Integer`	`getConnectTimeout()`
`String`	`getEnvironment()`
`Set<String>`	`getExcludedClasses()`
`Set<String>`	`getExcludedParams()`
`Set<String>`	`getExcludedSysProps()`
`protected Boolean`	`getFeedbackFormDisplayed()`
`String`	`getFeedbackFormPath()`
`String`	`getHoneybadgerReadApiKey()`
`URI`	`getHoneybadgerUrl()`
`String`	`getHttpProxyHost()`
`Integer`	`getHttpProxyPort()`
`Integer`	`getMaximumErrorReportingRetries()`
`BaseChainedConfigContext`	`getMaximumErrorReportingRetries(Integer maximumRetries)`
`Integer`	`getSocketTimeout()`
`int`	`hashCode()`
`Boolean`	`isFeedbackFormDisplayed()`
`void`	`overwriteWithContext(ConfigContext context)` Overwrites the configuration values with the values of the passed context if those values are not null and aren't empty.
`BaseChainedConfigContext`	`setApiKey(String apiKey)`
`BaseChainedConfigContext`	`setApplicationPackage(String applicationPackage)`
`BaseChainedConfigContext`	`setConnectTimeout(Integer connectTimeout)`
`BaseChainedConfigContext`	`setEnvironment(String environment)`
`BaseChainedConfigContext`	`setExcludedClasses(Set<String> excludedClasses)`
`BaseChainedConfigContext`	`setExcludedParams(Set<String> excludedParams)`
`BaseChainedConfigContext`	`setExcludedSysProps(Set<String> excludedSysProps)`
`Boolean`	`setFeedbackFormDisplayed(Boolean feedbackFormDisplayed)`
`BaseChainedConfigContext`	`setFeedbackFormPath(String feedbackFormPath)`
`BaseChainedConfigContext`	`setHoneybadgerReadApiKey(String honeybadgerReadApiKey)`
`BaseChainedConfigContext`	`setHoneybadgerUrl(URI honeybadgerUrl)`
`BaseChainedConfigContext`	`setHttpProxyHost(String httpProxyHost)`
`BaseChainedConfigContext`	`setHttpProxyPort(Integer httpProxyPort)`
`BaseChainedConfigContext`	`setSocketTimeout(Integer socketTimeout)`
`String`	`toString()`

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

- Field Detail
  - DEFAULT_CONFIG
```
public static final ConfigContext DEFAULT_CONFIG
```
    Singleton instance of default configuration for easy reference.
- Constructor Detail
  - BaseChainedConfigContext
```
public BaseChainedConfigContext()
```
    Constructor that prepopulates configuration context with the default values.
  - BaseChainedConfigContext
```
public BaseChainedConfigContext(ConfigContext defaultingContext)
```
    Constructor that takes a default value for each one of the configuration values.
    
    Parameters:
    
    defaultingContext - context that provides default values
- Method Detail
  - getEnvironment
```
public String getEnvironment()
```
    Specified by:
    
    getEnvironment in interface ConfigContext
    
    Returns:
    
    name of environment
  - setEnvironment
```
public BaseChainedConfigContext setEnvironment(String environment)
```
  - getHoneybadgerUrl
```
public URI getHoneybadgerUrl()
```
    Specified by:
    
    getHoneybadgerUrl in interface ConfigContext
    
    Returns:
    
    Honeybadger URL to use
  - setHoneybadgerUrl
```
public BaseChainedConfigContext setHoneybadgerUrl(URI honeybadgerUrl)
```
  - getApiKey
```
public String getApiKey()
```
    Specified by:
    
    getApiKey in interface ConfigContext
    
    Returns:
    
    Honeybadger API key to use
  - setApiKey
```
public BaseChainedConfigContext setApiKey(String apiKey)
```
  - getExcludedSysProps
```
public Set<String> getExcludedSysProps()
```
    Specified by:
    
    getExcludedSysProps in interface ConfigContext
    
    Returns:
    
    Set of system properties to not include
  - setExcludedSysProps
```
public BaseChainedConfigContext setExcludedSysProps(Set<String> excludedSysProps)
```
  - getExcludedParams
```
public Set<String> getExcludedParams()
```
    Specified by:
    
    getExcludedParams in interface ConfigContext
    
    Returns:
    
    Set of parameters to not include
  - setExcludedParams
```
public BaseChainedConfigContext setExcludedParams(Set<String> excludedParams)
```
  - getExcludedClasses
```
public Set<String> getExcludedClasses()
```
    Specified by:
    
    getExcludedClasses in interface ConfigContext
    
    Returns:
    
    Set of exception classes to ignore
  - setExcludedClasses
```
public BaseChainedConfigContext setExcludedClasses(Set<String> excludedClasses)
```
  - getApplicationPackage
```
public String getApplicationPackage()
```
    Specified by:
    
    getApplicationPackage in interface ConfigContext
    
    Returns:
    
    String that maps a package to an application
  - setApplicationPackage
```
public BaseChainedConfigContext setApplicationPackage(String applicationPackage)
```
  - getHoneybadgerReadApiKey
```
public String getHoneybadgerReadApiKey()
```
    Specified by:
    
    getHoneybadgerReadApiKey in interface ConfigContext
    
    Returns:
    
    Honeybadger Read API key
  - setHoneybadgerReadApiKey
```
public BaseChainedConfigContext setHoneybadgerReadApiKey(String honeybadgerReadApiKey)
```
  - 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
  - setFeedbackFormPath
```
public BaseChainedConfigContext setFeedbackFormPath(String feedbackFormPath)
```
  - getHttpProxyHost
```
public String getHttpProxyHost()
```
    Specified by:
    
    getHttpProxyHost in interface ConfigContext
    
    Returns:
    
    Host of proxy server to send traffic through
  - setHttpProxyHost
```
public BaseChainedConfigContext setHttpProxyHost(String httpProxyHost)
```
  - getHttpProxyPort
```
public Integer getHttpProxyPort()
```
    Specified by:
    
    getHttpProxyPort in interface ConfigContext
    
    Returns:
    
    Port of proxy server to send traffic through
  - setHttpProxyPort
```
public BaseChainedConfigContext setHttpProxyPort(Integer httpProxyPort)
```
  - 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.
  - getMaximumErrorReportingRetries
```
public BaseChainedConfigContext getMaximumErrorReportingRetries(Integer maximumRetries)
```
  - getSocketTimeout
```
public Integer getSocketTimeout()
```
    Specified by:
    
    getSocketTimeout in interface ConfigContext
    
    Returns:
    
    Timeout for socket connection within HTTP client
  - setSocketTimeout
```
public BaseChainedConfigContext setSocketTimeout(Integer socketTimeout)
```
  - getConnectTimeout
```
public Integer getConnectTimeout()
```
    Specified by:
    
    getConnectTimeout in interface ConfigContext
    
    Returns:
    
    Timeout for initial connect within HTTP client
  - setConnectTimeout
```
public BaseChainedConfigContext setConnectTimeout(Integer connectTimeout)
```
  - overwriteWithContext
```
public void overwriteWithContext(ConfigContext context)
```
    Overwrites the configuration values with the values of the passed context if those values are not null and aren't empty.
    
    Parameters:
    
    context - context to overwrite configuration with
  - setFeedbackFormDisplayed
```
public Boolean setFeedbackFormDisplayed(Boolean feedbackFormDisplayed)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getFeedbackFormDisplayed
```
protected Boolean getFeedbackFormDisplayed()
```

Class BaseChainedConfigContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CONFIG

Constructor Detail

BaseChainedConfigContext

BaseChainedConfigContext

Method Detail

getEnvironment

setEnvironment

getHoneybadgerUrl

setHoneybadgerUrl

getApiKey

setApiKey

getExcludedSysProps

setExcludedSysProps

getExcludedParams

setExcludedParams

getExcludedClasses

setExcludedClasses

getApplicationPackage

setApplicationPackage

getHoneybadgerReadApiKey

setHoneybadgerReadApiKey

isFeedbackFormDisplayed

getFeedbackFormPath

setFeedbackFormPath

getHttpProxyHost

setHttpProxyHost

getHttpProxyPort

setHttpProxyPort

getMaximumErrorReportingRetries

getMaximumErrorReportingRetries

getSocketTimeout

setSocketTimeout

getConnectTimeout

setConnectTimeout

overwriteWithContext

setFeedbackFormDisplayed

equals

toString

hashCode

getFeedbackFormDisplayed