Package com.slack.api
Class SlackConfig
- java.lang.Object
-
- com.slack.api.SlackConfig
-
public class SlackConfig extends Object
The basic configuration of this SDK. Some settings can be propagated to submodules such as Bolt.
-
-
Field Summary
Fields Modifier and Type Field Description static SlackConfigDEFAULTThe default instance is immutable.
-
Constructor Summary
Constructors Constructor Description SlackConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleancanEqual(Object other)booleanequals(Object o)AuditConfiggetAuditConfig()StringgetAuditEndpointUrlPrefix()ExecutorServiceProvidergetExecutorServiceProvider()IntegergetHttpClientCallTimeoutMillis()The underlying HTTP client's call timeout (in milliseconds).IntegergetHttpClientReadTimeoutMillis()The underlying HTTP client's read timeout (in milliseconds).List<HttpResponseListener>getHttpClientResponseHandlers()IntegergetHttpClientWriteTimeoutMillis()The underlying HTTP client's write timeout (in milliseconds).StringgetLegacyStatusEndpointUrlPrefix()MethodsConfiggetMethodsConfig()StringgetMethodsEndpointUrlPrefix()Map<String,String>getProxyHeaders()Additional headers for proxy (e.g., Proxy-Authorization)StringgetProxyUrl()The proxy server URL supposed to be used for all api calls.LonggetRateLimiterBackgroundJobIntervalMillis()SCIMConfiggetSCIMConfig()StringgetScimEndpointUrlPrefix()StringgetStatusEndpointUrlPrefix()inthashCode()booleanisFailOnUnknownProperties()If you would like to detect unknown properties by throwing exceptions, set this flag as true.booleanisLibraryMaintainerMode()Don't enable this flag in production.booleanisPrettyResponseLoggingEnabled()booleanisStatsEnabled()booleanisTokenExistenceVerificationEnabled()Slack Web API client verifies the existence of tokens before sending HTTP requests to Slack servers.voidsetAuditConfig(AuditConfig auditConfig)voidsetAuditEndpointUrlPrefix(String auditEndpointUrlPrefix)voidsetExecutorServiceProvider(ExecutorServiceProvider executorServiceProvider)voidsetFailOnUnknownProperties(boolean failOnUnknownProperties)If you would like to detect unknown properties by throwing exceptions, set this flag as true.voidsetHttpClientCallTimeoutMillis(Integer httpClientCallTimeoutMillis)The underlying HTTP client's call timeout (in milliseconds).voidsetHttpClientReadTimeoutMillis(Integer httpClientReadTimeoutMillis)The underlying HTTP client's read timeout (in milliseconds).voidsetHttpClientResponseHandlers(List<HttpResponseListener> httpClientResponseHandlers)voidsetHttpClientWriteTimeoutMillis(Integer httpClientWriteTimeoutMillis)The underlying HTTP client's write timeout (in milliseconds).voidsetLegacyStatusEndpointUrlPrefix(String legacyStatusEndpointUrlPrefix)voidsetLibraryMaintainerMode(boolean libraryMaintainerMode)voidsetMethodsConfig(MethodsConfig methodsConfig)voidsetMethodsEndpointUrlPrefix(String methodsEndpointUrlPrefix)voidsetPrettyResponseLoggingEnabled(boolean prettyResponseLoggingEnabled)voidsetProxyHeaders(Map<String,String> proxyHeaders)Additional headers for proxy (e.g., Proxy-Authorization)voidsetProxyUrl(String proxyUrl)The proxy server URL supposed to be used for all api calls.voidsetRateLimiterBackgroundJobIntervalMillis(Long rateLimiterBackgroundJobIntervalMillis)voidsetSCIMConfig(SCIMConfig sCIMConfig)voidsetScimEndpointUrlPrefix(String scimEndpointUrlPrefix)voidsetStatsEnabled(boolean statsEnabled)voidsetStatusEndpointUrlPrefix(String statusEndpointUrlPrefix)voidsetTokenExistenceVerificationEnabled(boolean tokenExistenceVerificationEnabled)Slack Web API client verifies the existence of tokens before sending HTTP requests to Slack servers.voidsynchronizeExecutorServiceProviders()voidsynchronizeLibraryMaintainerMode()voidsynchronizeMetricsDatabases()StringtoString()
-
-
-
Field Detail
-
DEFAULT
public static final SlackConfig DEFAULT
The default instance is immutable. It's not allowed to modify the value runtime for any reasons.
-
-
Method Detail
-
setLibraryMaintainerMode
public void setLibraryMaintainerMode(boolean libraryMaintainerMode)
-
setRateLimiterBackgroundJobIntervalMillis
public void setRateLimiterBackgroundJobIntervalMillis(Long rateLimiterBackgroundJobIntervalMillis)
-
setStatsEnabled
public void setStatsEnabled(boolean statsEnabled)
-
synchronizeMetricsDatabases
public void synchronizeMetricsDatabases()
-
synchronizeExecutorServiceProviders
public void synchronizeExecutorServiceProviders()
-
synchronizeLibraryMaintainerMode
public void synchronizeLibraryMaintainerMode()
-
getHttpClientReadTimeoutMillis
public Integer getHttpClientReadTimeoutMillis()
The underlying HTTP client's read timeout (in milliseconds). The default is 10 seconds. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/read-timeout-millis/
-
getHttpClientWriteTimeoutMillis
public Integer getHttpClientWriteTimeoutMillis()
The underlying HTTP client's write timeout (in milliseconds). The default is 10 seconds. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/write-timeout-millis/
-
getHttpClientCallTimeoutMillis
public Integer getHttpClientCallTimeoutMillis()
The underlying HTTP client's call timeout (in milliseconds). By default, there is no timeout for complete calls while there is for connect/write/read actions within a call. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/call-timeout-millis/
-
getProxyUrl
public String getProxyUrl()
The proxy server URL supposed to be used for all api calls.
-
getProxyHeaders
public Map<String,String> getProxyHeaders()
Additional headers for proxy (e.g., Proxy-Authorization)
-
isPrettyResponseLoggingEnabled
public boolean isPrettyResponseLoggingEnabled()
-
isLibraryMaintainerMode
public boolean isLibraryMaintainerMode()
Don't enable this flag in production. This flag enables some validation features for development.
-
isFailOnUnknownProperties
public boolean isFailOnUnknownProperties()
If you would like to detect unknown properties by throwing exceptions, set this flag as true.
-
isTokenExistenceVerificationEnabled
public boolean isTokenExistenceVerificationEnabled()
Slack Web API client verifies the existence of tokens before sending HTTP requests to Slack servers.
-
getHttpClientResponseHandlers
public List<HttpResponseListener> getHttpClientResponseHandlers()
-
getAuditEndpointUrlPrefix
public String getAuditEndpointUrlPrefix()
-
getMethodsEndpointUrlPrefix
public String getMethodsEndpointUrlPrefix()
-
getScimEndpointUrlPrefix
public String getScimEndpointUrlPrefix()
-
getStatusEndpointUrlPrefix
public String getStatusEndpointUrlPrefix()
-
getLegacyStatusEndpointUrlPrefix
public String getLegacyStatusEndpointUrlPrefix()
-
getExecutorServiceProvider
public ExecutorServiceProvider getExecutorServiceProvider()
-
getRateLimiterBackgroundJobIntervalMillis
public Long getRateLimiterBackgroundJobIntervalMillis()
-
isStatsEnabled
public boolean isStatsEnabled()
-
getMethodsConfig
public MethodsConfig getMethodsConfig()
-
getAuditConfig
public AuditConfig getAuditConfig()
-
getSCIMConfig
public SCIMConfig getSCIMConfig()
-
setHttpClientReadTimeoutMillis
public void setHttpClientReadTimeoutMillis(Integer httpClientReadTimeoutMillis)
The underlying HTTP client's read timeout (in milliseconds). The default is 10 seconds. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/read-timeout-millis/
-
setHttpClientWriteTimeoutMillis
public void setHttpClientWriteTimeoutMillis(Integer httpClientWriteTimeoutMillis)
The underlying HTTP client's write timeout (in milliseconds). The default is 10 seconds. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/write-timeout-millis/
-
setHttpClientCallTimeoutMillis
public void setHttpClientCallTimeoutMillis(Integer httpClientCallTimeoutMillis)
The underlying HTTP client's call timeout (in milliseconds). By default, there is no timeout for complete calls while there is for connect/write/read actions within a call. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/call-timeout-millis/
-
setProxyUrl
public void setProxyUrl(String proxyUrl)
The proxy server URL supposed to be used for all api calls.
-
setProxyHeaders
public void setProxyHeaders(Map<String,String> proxyHeaders)
Additional headers for proxy (e.g., Proxy-Authorization)
-
setPrettyResponseLoggingEnabled
public void setPrettyResponseLoggingEnabled(boolean prettyResponseLoggingEnabled)
-
setFailOnUnknownProperties
public void setFailOnUnknownProperties(boolean failOnUnknownProperties)
If you would like to detect unknown properties by throwing exceptions, set this flag as true.
-
setTokenExistenceVerificationEnabled
public void setTokenExistenceVerificationEnabled(boolean tokenExistenceVerificationEnabled)
Slack Web API client verifies the existence of tokens before sending HTTP requests to Slack servers.
-
setHttpClientResponseHandlers
public void setHttpClientResponseHandlers(List<HttpResponseListener> httpClientResponseHandlers)
-
setAuditEndpointUrlPrefix
public void setAuditEndpointUrlPrefix(String auditEndpointUrlPrefix)
-
setMethodsEndpointUrlPrefix
public void setMethodsEndpointUrlPrefix(String methodsEndpointUrlPrefix)
-
setScimEndpointUrlPrefix
public void setScimEndpointUrlPrefix(String scimEndpointUrlPrefix)
-
setStatusEndpointUrlPrefix
public void setStatusEndpointUrlPrefix(String statusEndpointUrlPrefix)
-
setLegacyStatusEndpointUrlPrefix
public void setLegacyStatusEndpointUrlPrefix(String legacyStatusEndpointUrlPrefix)
-
setExecutorServiceProvider
public void setExecutorServiceProvider(ExecutorServiceProvider executorServiceProvider)
-
setMethodsConfig
public void setMethodsConfig(MethodsConfig methodsConfig)
-
setAuditConfig
public void setAuditConfig(AuditConfig auditConfig)
-
setSCIMConfig
public void setSCIMConfig(SCIMConfig sCIMConfig)
-
canEqual
protected boolean canEqual(Object other)
-
-