com.slack.api.bolt.AppConfig Maven / Gradle / Ivy
package com.slack.api.bolt;
import com.slack.api.Slack;
import com.slack.api.SlackConfig;
import com.slack.api.bolt.handler.UnmatchedRequestHandler;
import com.slack.api.bolt.handler.builtin.DefaultUnmatchedRequestHandler;
import com.slack.api.bolt.meta.BoltLibraryVersion;
import com.slack.api.bolt.service.builtin.oauth.view.OAuthInstallPageRenderer;
import com.slack.api.bolt.service.builtin.oauth.view.OAuthRedirectUriPageRenderer;
import com.slack.api.bolt.service.builtin.oauth.view.default_impl.OAuthDefaultInstallPageRenderer;
import com.slack.api.bolt.service.builtin.oauth.view.default_impl.OAuthDefaultRedirectUriPageRenderer;
import com.slack.api.token_rotation.TokenRotator;
import com.slack.api.util.http.SlackHttpClient;
import com.slack.api.util.thread.DaemonThreadExecutorServiceProvider;
import com.slack.api.util.thread.ExecutorServiceProvider;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
/**
* Configuration for a Slack App.
*/
@Data
@Builder(toBuilder = true)
@NoArgsConstructor
@AllArgsConstructor
public class AppConfig {
public static final class EnvVariableName {
private EnvVariableName() {
}
public static final String SLACK_BOT_TOKEN = "SLACK_BOT_TOKEN";
public static final String SLACK_SIGNING_SECRET = "SLACK_SIGNING_SECRET";
public static final String SLACK_VERIFICATION_TOKEN = "SLACK_VERIFICATION_TOKEN";
public static final String SLACK_CLIENT_ID = "SLACK_CLIENT_ID";
public static final String SLACK_CLIENT_SECRET = "SLACK_CLIENT_SECRET";
public static final String SLACK_REDIRECT_URI = "SLACK_REDIRECT_URI";
public static final String SLACK_SCOPES = "SLACK_SCOPES";
public static final String SLACK_USER_SCOPES = "SLACK_USER_SCOPES";
public static final String SLACK_INSTALL_PATH = "SLACK_INSTALL_PATH";
public static final String SLACK_REDIRECT_URI_PATH = "SLACK_REDIRECT_URI_PATH";
public static final String SLACK_OAUTH_CANCELLATION_URL = "SLACK_OAUTH_CANCELLATION_URL";
public static final String SLACK_OAUTH_COMPLETION_URL = "SLACK_OAUTH_COMPLETION_URL";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_CLIENT_ID = "SLACK_APP_CLIENT_ID";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_CLIENT_SECRET = "SLACK_APP_CLIENT_SECRET";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_REDIRECT_URI = "SLACK_APP_REDIRECT_URI";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_SCOPE = "SLACK_APP_SCOPE";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_USER_SCOPE = "SLACK_APP_USER_SCOPE";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_OAUTH_START_PATH = "SLACK_APP_OAUTH_START_PATH";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_OAUTH_CALLBACK_PATH = "SLACK_APP_OAUTH_CALLBACK_PATH";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_OAUTH_CANCELLATION_URL = "SLACK_APP_OAUTH_CANCELLATION_URL";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_OAUTH_COMPLETION_URL = "SLACK_APP_OAUTH_COMPLETION_URL";
}
// We don't use SlackConfig.DEFAULT here to enable developers to customize the properties later on
@Builder.Default
private transient Slack slack = Slack.getInstance(new SlackConfig(), buildSlackHttpClient());
@Builder.Default
private transient ExecutorServiceProvider executorServiceProvider = DaemonThreadExecutorServiceProvider.getInstance();
private static SlackHttpClient buildSlackHttpClient() {
Map userAgentCustomInfo = new HashMap<>();
userAgentCustomInfo.put("bolt", BoltLibraryVersion.get());
SlackHttpClient client = new SlackHttpClient(SlackConfig.DEFAULT, userAgentCustomInfo);
return client;
}
@Builder.Default
private String singleTeamBotToken = System.getenv(EnvVariableName.SLACK_BOT_TOKEN);
@Builder.Default
private String signingSecret = System.getenv(EnvVariableName.SLACK_SIGNING_SECRET);
@Deprecated
@Builder.Default
private String verificationToken = System.getenv(EnvVariableName.SLACK_VERIFICATION_TOKEN);
// https://api.slack.com/docs/oauth
public boolean isDistributedApp() {
return clientId != null && clientSecret != null;
}
// --------------------------
@Builder.Default
private boolean oAuthInstallPathEnabled = false;
public boolean isOAuthInstallPathEnabled() {
return oAuthInstallPathEnabled || oAuthStartEnabled;
}
@Deprecated // will be removed in v2.0 - use oAuthInstallPathEnabled
@Builder.Default
private boolean oAuthStartEnabled = false;
@Deprecated
public boolean isOAuthStartEnabled() {
return isOAuthInstallPathEnabled();
}
@Deprecated
public void setOAuthStartEnabled(boolean enabled) {
setOAuthInstallPathEnabled(enabled);
}
// --------------------------
@Builder.Default
private boolean openIDConnectEnabled = false;
// --------------------------
@Builder.Default
private boolean oAuthRedirectUriPathEnabled = false;
public boolean isOAuthRedirectUriPathEnabled() {
return oAuthRedirectUriPathEnabled || oAuthCallbackEnabled;
}
@Deprecated // will be removed in v2.0 - use oAuthRedirectUriPathEnabled
@Builder.Default
private boolean oAuthCallbackEnabled = false;
@Deprecated
public boolean isOAuthCallbackEnabled() {
return isOAuthRedirectUriPathEnabled();
}
@Deprecated
public void setOAuthCallbackEnabled(boolean enabled) {
setOAuthRedirectUriPathEnabled(enabled);
}
// --------------------------
// OAuth flow page renderer
/**
* If you prefer the behavior in v1.0 - 1.3, set this flag as false
*/
@Builder.Default
private boolean oAuthInstallPageRenderingEnabled = true;
/**
* Renders the web page content to display to installers.
*/
@Builder.Default
private transient OAuthInstallPageRenderer oAuthInstallPageRenderer =
new OAuthDefaultInstallPageRenderer();
/**
* Renders the web page content to display to installers.
*/
@Builder.Default
private transient OAuthRedirectUriPageRenderer oAuthRedirectUriPageRenderer =
new OAuthDefaultRedirectUriPageRenderer();
/**
* Handles unmatched requests (default behavior is simply returning 404 Not Found).
*/
@Builder.Default
private transient UnmatchedRequestHandler unmatchedRequestHandler =
new DefaultUnmatchedRequestHandler();
// --------------------------
/**
* Returns true if auth.test call result cache in MultiTeamsAuthorization middleware
* is enabled. The default is false.
*/
@Builder.Default
private boolean authTestCacheEnabled = false;
/**
* Returns the millisecond value to keep cached auth.test response in cache.
* Negative value indicates the cache is permanent. The default is 10 minutes.
*/
@Builder.Default
private long authTestCacheExpirationMillis = 600_000L;
@Builder.Default
// https://api.slack.com/authentication/migration
private boolean classicAppPermissionsEnabled = false;
/**
* The thread pool size for the built-in handy executor service.
*/
@Builder.Default
private int threadPoolSize = 10;
@Builder.Default
private String clientId = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_CLIENT_ID))
.orElse(System.getenv(EnvVariableName.SLACK_APP_CLIENT_ID));
@Builder.Default
private String clientSecret = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_CLIENT_SECRET))
.orElse(System.getenv(EnvVariableName.SLACK_APP_CLIENT_SECRET));
@Builder.Default
private String redirectUri = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_REDIRECT_URI))
.orElse(System.getenv(EnvVariableName.SLACK_APP_REDIRECT_URI));
@Builder.Default
private String scope = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_SCOPES))
.orElse(System.getenv(EnvVariableName.SLACK_APP_SCOPE));
@Builder.Default
private String userScope = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_USER_SCOPES))
.orElse(System.getenv(EnvVariableName.SLACK_APP_USER_SCOPE));
@Builder.Default
private long tokenRotationExpirationMillis = TokenRotator.DEFAULT_MILLISECONDS_BEFORE_EXPIRATION;
private String appPath;
// --------------------------
@Deprecated // will be removed in v2.0 - use getOauthInstallRequestURI instead
public String getOauthStartRequestURI() {
return getOauthInstallRequestURI();
}
public String getOauthInstallRequestURI() {
if (appPath == null) {
return getOauthInstallPath();
} else {
return appPath + getOauthInstallPath();
}
}
// --------------------------
@Deprecated // will be removed in v2.0 - use getOauthRedirectUriRequestURI instead
public String getOauthCallbackRequestURI() {
return getOauthRedirectUriRequestURI();
}
public String getOauthRedirectUriRequestURI() {
if (appPath == null) {
return getOauthRedirectUriPath();
} else {
return appPath + getOauthRedirectUriPath();
}
}
// --------------------------
// NOTE: We should not change this default value in v1.x as it's a breaking change to existing users.
// We will be changing this in v2.0.
private static final String DEFAULT_OAUTH_INSTALL_PATH = "start";
@Deprecated // will be removed in v2.0 - use oauthInstallPath instead
@Builder.Default
private String oauthStartPath = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_INSTALL_PATH))
.orElse(Optional.ofNullable(System.getenv(EnvVariableName.SLACK_APP_OAUTH_START_PATH))
.orElse(DEFAULT_OAUTH_INSTALL_PATH));
@Deprecated
public String getOauthStartPath() {
return getOauthInstallPath();
}
@Deprecated
public void setOauthStartPath(String oauthStartPath) {
setOauthInstallPath(oauthStartPath);
}
@Builder.Default
private String oauthInstallPath = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_INSTALL_PATH))
.orElse(Optional.ofNullable(System.getenv(EnvVariableName.SLACK_APP_OAUTH_START_PATH))
.orElse(DEFAULT_OAUTH_INSTALL_PATH));
public String getOauthInstallPath() {
String path = this.oauthInstallPath;
String legacyPath = this.oauthStartPath;
if (path != null
&& path.equals(DEFAULT_OAUTH_INSTALL_PATH) == false
&& legacyPath.equals(DEFAULT_OAUTH_INSTALL_PATH)) {
return path;
} else {
return legacyPath;
}
}
public void setOauthInstallPath(String oauthInstallPath) {
this.oauthInstallPath = oauthInstallPath;
this.oAuthInstallPathEnabled = oauthInstallPath != null;
}
// --------------------------
// NOTE: We should not change this default value in v1.x as it's a breaking change to existing users.
// We will be changing this in v2.0.
private static final String DEFAULT_OAUTH_REDIRECT_URI_PATH = "callback";
@Deprecated // will be removed in v2.0 - use oauthRedirectUriPath instead
@Builder.Default
private String oauthCallbackPath = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_REDIRECT_URI_PATH))
.orElse(Optional.ofNullable(System.getenv(EnvVariableName.SLACK_APP_OAUTH_CALLBACK_PATH))
.orElse(DEFAULT_OAUTH_REDIRECT_URI_PATH));
@Deprecated
public String getOauthCallbackPath() {
return getOauthRedirectUriPath();
}
@Deprecated
public void setOauthCallbackPath(String oauthCallbackPath) {
setOauthRedirectUriPath(oauthCallbackPath);
}
@Builder.Default
private String oauthRedirectUriPath = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_REDIRECT_URI_PATH))
.orElse(Optional.ofNullable(System.getenv(EnvVariableName.SLACK_APP_OAUTH_CALLBACK_PATH))
.orElse(DEFAULT_OAUTH_REDIRECT_URI_PATH));
public String getOauthRedirectUriPath() {
String path = this.oauthRedirectUriPath;
String legacyPath = this.oauthCallbackPath;
if (path != null
&& path.equals(DEFAULT_OAUTH_REDIRECT_URI_PATH) == false
&& legacyPath.equals(DEFAULT_OAUTH_REDIRECT_URI_PATH)) {
return path;
} else {
return legacyPath;
}
}
public void setOauthRedirectUriPath(String oauthRedirectUriPath) {
this.oauthRedirectUriPath = oauthRedirectUriPath;
this.oAuthRedirectUriPathEnabled = oauthRedirectUriPath != null;
}
// --------------------------
/**
* Enables validation of the state parameter in the OAuth flow.
* It is highly recommended to enable this validation for better security.
* A valid exception is when Enterprise Grid Org admins install apps from the app management page.
*/
@Builder.Default
private boolean stateValidationEnabled = true;
@Builder.Default
private String oauthCancellationUrl = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_OAUTH_CANCELLATION_URL))
.orElse(System.getenv(EnvVariableName.SLACK_APP_OAUTH_CANCELLATION_URL));
@Builder.Default
private String oauthCompletionUrl = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_OAUTH_COMPLETION_URL))
.orElse(System.getenv(EnvVariableName.SLACK_APP_OAUTH_COMPLETION_URL));
@Builder.Default
private boolean alwaysRequestUserTokenNeeded = false;
@Builder.Default
private boolean appInitializersEnabled = true;
/**
* Automatically acknowledge message events that have subtype if true.
* Find the list of available subtypes at https://api.slack.com/events/message#subtypes
*/
@Builder.Default
private boolean subtypedMessageEventsAutoAckEnabled = false;
/**
* Automatically acknowledge all Event API events if true.
* This behavior is compatible with bolt-js.
*/
@Builder.Default
private boolean allEventsApiAutoAckEnabled = false;
/**
* When true, the framework automatically attaches context#functionBotAccessToken
* to context#client instead of context#botToken.
* Enabling this behavior only affects function_executed event handlers
* and app.action/app.view handlers associated with the function token.
*/
@Builder.Default
private boolean attachingFunctionTokenEnabled = true;
// ---------------------------------
// Default middleware configuration
// ---------------------------------
// This middleware works only for HTTP Mode
@Builder.Default
private boolean sslCheckEnabled = true;
// This middleware works only for HTTP Mode
@Builder.Default
private boolean requestVerificationEnabled = true;
@Builder.Default
private boolean ignoringSelfEventsEnabled = true;
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy