Skip to content

Commit 28d637e

Browse files
seratchseratch
committed
Update docs
1 parent 9cb6946 commit 28d637e

File tree

5 files changed

+97
-21
lines changed

5 files changed

+97
-21
lines changed

‎docs/content/guides/socket-mode.md‎

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,44 @@ To manage the Socket Mode connections, in addition to the `bolt-socket-mode` lib
5151
</project>
5252
```
5353

54+
If you prefer using Jakarta EE compatible one, the dependencies would be:
55+
56+
```xml
57+
<project xmlns="http://maven.apache.org/POM/4.0.0"
58+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
59+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
60+
<modelVersion>4.0.0</modelVersion>
61+
<groupId>com.example</groupId>
62+
<artifactId>awesome-slack-app</artifactId>
63+
<version>0.1-SNAPSHOT</version>
64+
<packaging>jar</packaging>
65+
<dependencies>
66+
<dependency>
67+
<groupId>com.slack.api</groupId>
68+
<artifactId>bolt-jakarta-socket-mode</artifactId>
69+
<version>sdkLatestVersion</version>
70+
</dependency>
71+
<dependency>
72+
<groupId>jakarta.websocket</groupId>
73+
<artifactId>jakarta.websocket-client-api</artifactId>
74+
<version>jakartaWebsocketApiVersion</version>
75+
</dependency>
76+
<dependency>
77+
<groupId>org.glassfish.tyrus.bundles</groupId>
78+
<artifactId>tyrus-standalone-client</artifactId>
79+
<version>tyrusStandaloneClientV2Version</version>
80+
</dependency>
81+
</dependencies>
82+
</project>
83+
```
84+
5485
`SocketModeClient`, the Socket Mode connection manager interface, supports the following open-source libraries for WebSocket communications. If you have suggestions for other libraries that this SDK should support, let us know at [the project issue tracker](https://github.com/slackapi/java-slack-sdk/issues).
5586

56-
|Name|Maven Artifact|
57-
|-|-|
58-
|[Tyrus Standalone Client (default)](https://github.com/eclipse-ee4j/tyrus)|[org.glassfish.tyrus.bundles:tyrus-standalone-client](https://search.maven.org/artifact/org.glassfish.tyrus.bundles/tyrus-standalone-client)|
59-
|[Java-WebSocket](https://github.com/TooTallNate/Java-WebSocket)|[org.java-websocket:Java-WebSocket](https://search.maven.org/artifact/org.java-websocket/Java-WebSocket)|
87+
| Name |Maven Artifact|
88+
|--------------------------------------------------------------------------------|-|
89+
| [Tyrus Standalone Client 1.x (default)](https://github.com/eclipse-ee4j/tyrus) |[org.glassfish.tyrus.bundles:tyrus-standalone-client](https://search.maven.org/artifact/org.glassfish.tyrus.bundles/tyrus-standalone-client)|
90+
| [Tyrus Standalone Client 2.x](https://github.com/eclipse-ee4j/tyrus) |[org.glassfish.tyrus.bundles:tyrus-standalone-client](https://search.maven.org/artifact/org.glassfish.tyrus.bundles/tyrus-standalone-client)|
91+
| [Java-WebSocket](https://github.com/TooTallNate/Java-WebSocket) |[org.java-websocket:Java-WebSocket](https://search.maven.org/artifact/org.java-websocket/Java-WebSocket)|
6092

6193
To switch the underlying implementation, you can pass a `SocketModeClient.Backend.*` to either `SocketModeClient` in `slack-api-client` or `SocketModeApp` in `bolt-socket-mode`. If your own one implements `SocketModeClient` interface, you can just instantiate the class.
6294

@@ -100,6 +132,8 @@ The `SocketModeApp` class in **bolt-socket-mode** library is an adapter module f
100132

101133
```java
102134
import com.slack.api.bolt.socket_mode.SocketModeApp;
135+
// Note: If you use bolt-jakarta-socket-mode instead, the import would be:
136+
// import com.slack.api.bolt.jakarta_socket_mode.SocketModeApp;
103137

104138
// the app-level token with `connections:write` scope
105139
String appToken = System.getenv("SLACK_APP_TOKEN");
@@ -140,6 +174,8 @@ app.event(AppMentionEvent.class, (req, ctx) -> {
140174
// ------------------------------
141175
// Start a new thread that runs the Socket Mode app in this process
142176
import com.slack.api.bolt.socket_mode.SocketModeApp;
177+
// Note: If you use bolt-jakarta-socket-mode instead, the import would be:
178+
// import com.slack.api.bolt.jakarta_socket_mode.SocketModeApp;
143179

144180
String appToken = "xapp-1-A111-111-xxx";
145181
SocketModeApp socketModeApp = new SocketModeApp(appToken, app);

‎docs/content/reference.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ All released versions are available on the Maven Central repositories. The lates
66

77
## Bolt & Built-in Extensions
88

9-
| groupId:artifactId | Javadoc | Description |
10-
|----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
11-
| [`com.slack.api:bolt`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt/sdkLatestVersion/bolt-sdkLatestVersion-javadoc.jar/!/index.html#package) | Bolt is a framework that offers an abstraction layer to build Slack apps safely and quickly. |
9+
| groupId:artifactId | Javadoc | Description |
10+
|----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
11+
| [`com.slack.api:bolt`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt/sdkLatestVersion/bolt-sdkLatestVersion-javadoc.jar/!/index.html#package) | Bolt is a framework that offers an abstraction layer to build Slack apps safely and quickly. |
1212
| [`com.slack.api:bolt-socket-mode`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-socket-mode) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-socket-mode/sdkLatestVersion/bolt-socket-mode-sdkLatestVersion-javadoc.jar/!/index.html#package) | This module offers a handy way to run Bolt apps through [Socket Mode](https://api.slack.com/) connections. |
13-
| [`com.slack.api:bolt-jakarata-socket-mode`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-jakarta-socket-mode) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-jakarta-socket-mode/sdkLatestVersion/bolt-jakarta-socket-mode-sdkLatestVersion-javadoc.jar/!/index.html#package) | This module offers a handy way to run Bolt apps through [Socket Mode](https://api.slack.com/) connections. |
13+
| [`com.slack.api:bolt-jakarata-socket-mode`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-jakarta-socket-mode) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-jakarta-socket-mode/sdkLatestVersion/bolt-jakarta-socket-mode-sdkLatestVersion-javadoc.jar/!/index.html#package) | This module offers a handy way to run Bolt apps through [Socket Mode](https://api.slack.com/) connections (Jakarta EE compatible). |
1414
| [`com.slack.api:bolt-servlet`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-servlet) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-servlet/sdkLatestVersion/bolt-servlet-sdkLatestVersion-javadoc.jar/!/index.html) | This module offers a handy way to run Bolt apps on the Java EE Servlet environments. |
1515
| [`com.slack.api:bolt-jetty`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-jetty) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-jetty/sdkLatestVersion/bolt-jetty-sdkLatestVersion-javadoc.jar/!/index.html) | This module offers a handy way to run Bolt apps on the [Java EE compatible Jetty HTTP server (9.x)](https://www.eclipse.org/jetty/). |
1616
| [`com.slack.api:bolt-jakarta-servlet`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-jakarta-servlet) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-jakarta-servlet/sdkLatestVersion/bolt-jakarta-servlet-sdkLatestVersion-javadoc.jar/!/index.html) | This module offers a handy way to run Bolt apps on the Jakarta EE Servlet environments. |
1717
| [`com.slack.api:bolt-jakarta-jetty`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-jakarta-jetty) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-jakarta-jetty/sdkLatestVersion/bolt-jakarta-jetty-sdkLatestVersion-javadoc.jar/!/index.html) | This module offers a handy way to run Bolt apps on the [Jakarta EE compatible Jetty HTTP server](https://www.eclipse.org/jetty/). |
1818
| [`com.slack.api:bolt-aws-lambda`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-aws-lambda) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-aws-lambda/sdkLatestVersion/bolt-aws-lambda-sdkLatestVersion-javadoc.jar/!/index.html) | This module offers a handy way to run Bolt apps on AWS [API Gateway](https://aws.amazon.com/api-gateway/) + [Lambda](https://aws.amazon.com/lambda/). |
19-
| [`com.slack.api:bolt-google-cloud-functions`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-google-cloud-functions) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-google-cloud-functions/sdkLatestVersion/bolt-google-cloud-functions-sdkLatestVersion-javadoc.jar/!/index.html) | This module offers a handy way to run Bolt apps on [Google Cloud Functions](https://cloud.google.com/functions). |
19+
| [`com.slack.api:bolt-google-cloud-functions`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-google-cloud-functions) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-google-cloud-functions/sdkLatestVersion/bolt-google-cloud-functions-sdkLatestVersion-javadoc.jar/!/index.html) | This module offers a handy way to run Bolt apps on [Google Cloud Functions](https://cloud.google.com/functions). |
2020
| [`com.slack.api:bolt-micronaut`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-micronaut) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-micronaut/sdkLatestVersion/bolt-micronaut-sdkLatestVersion-javadoc.jar/!/index.html) | This is an adapter for [Micronaut](https://micronaut.io/) to run Bolt apps on top of it. |
2121
| [`com.slack.api:bolt-helidon`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-helidon) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-helidon/sdkLatestVersion/bolt-helidon-sdkLatestVersion-javadoc.jar/!/index.html) | This is an adapter for [Helidon SE](https://helidon.io/docs/latest/) to run Bolt apps on top of it. |
2222
| [`com.slack.api:bolt-http4k`](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-http4k) | [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-http4k/sdkLatestVersion/bolt-http4k-sdkLatestVersion-javadoc.jar/!/index.html) | This is an adapter for [http4k](https://http4k.org/) to run Bolt apps on top of any of the multiple server backends that the library supports. |

‎docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/guides/socket-mode.md‎

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,44 @@ lang: ja
5151
</project>
5252
```
5353

54+
Jakarta EE 互換のものを利用したい場合、以下のようになります:
55+
56+
```xml
57+
<project xmlns="http://maven.apache.org/POM/4.0.0"
58+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
59+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
60+
<modelVersion>4.0.0</modelVersion>
61+
<groupId>com.example</groupId>
62+
<artifactId>awesome-slack-app</artifactId>
63+
<version>0.1-SNAPSHOT</version>
64+
<packaging>jar</packaging>
65+
<dependencies>
66+
<dependency>
67+
<groupId>com.slack.api</groupId>
68+
<artifactId>bolt-jakarta-socket-mode</artifactId>
69+
<version>sdkLatestVersion</version>
70+
</dependency>
71+
<dependency>
72+
<groupId>jakarta.websocket</groupId>
73+
<artifactId>jakarta.websocket-client-api</artifactId>
74+
<version>jakartaWebsocketApiVersion</version>
75+
</dependency>
76+
<dependency>
77+
<groupId>org.glassfish.tyrus.bundles</groupId>
78+
<artifactId>tyrus-standalone-client</artifactId>
79+
<version>tyrusStandaloneClientV2Version</version>
80+
</dependency>
81+
</dependencies>
82+
</project>
83+
```
84+
5485
ソケットモードのコネクション管理インターフェースである `SocketModeClient` は WebSocket でのコミュニケーションレイヤーとして、以下のオープンソースライブラリをサポートしています。もし、これら以外にサポートすべきライブラリの推薦があれば、ぜひ[こちらから](https://github.com/slackapi/java-slack-sdk/issues)フィードバックをお願いします（**英語でお願いします**）。
5586

56-
|ライブラリ名|Maven アーティファクト|
57-
|-|-|
58-
|[Tyrus Standalone Client (default)](https://github.com/eclipse-ee4j/tyrus)|[org.glassfish.tyrus.bundles:tyrus-standalone-client](https://search.maven.org/artifact/org.glassfish.tyrus.bundles/tyrus-standalone-client)|
59-
|[Java-WebSocket](https://github.com/TooTallNate/Java-WebSocket)|[org.java-websocket:Java-WebSocket](https://search.maven.org/artifact/org.java-websocket/Java-WebSocket)|
87+
| ライブラリ名 |Maven アーティファクト|
88+
|--------------------------------------------------------------------------------|-|
89+
| [Tyrus Standalone Client 1.x (default)](https://github.com/eclipse-ee4j/tyrus) |[org.glassfish.tyrus.bundles:tyrus-standalone-client](https://search.maven.org/artifact/org.glassfish.tyrus.bundles/tyrus-standalone-client)|
90+
| [Tyrus Standalone Client 2.x](https://github.com/eclipse-ee4j/tyrus) |[org.glassfish.tyrus.bundles:tyrus-standalone-client](https://search.maven.org/artifact/org.glassfish.tyrus.bundles/tyrus-standalone-client)|
91+
| [Java-WebSocket](https://github.com/TooTallNate/Java-WebSocket) |[org.java-websocket:Java-WebSocket](https://search.maven.org/artifact/org.java-websocket/Java-WebSocket)|
6092

6193
実装を切り替える場合、`SocketModeClient.Backend.*` を **slack-api-client** の `SocketModeClient` か **bolt-socket-mode** の `SocketModeApp` のコンストラクターに渡します。まt、それ以外の実装が `SocketModeClient` インターフェースを実装しているなら、直接インスタンス化してもよいでしょう。
6294

@@ -100,6 +132,8 @@ app.event(AppMentionEvent.class, (req, ctx) -> {
100132

101133
```java
102134
import com.slack.api.bolt.socket_mode.SocketModeApp;
135+
// Note: bolt-jakarta-socket-mode を使う場合は以下の import になります：
136+
// import com.slack.api.bolt.jakarta_socket_mode.SocketModeApp;
103137

104138
// `connections:write` スコープが付与されたアプリレベルトークン
105139
String appToken = System.getenv("SLACK_APP_TOKEN");
@@ -139,6 +173,8 @@ app.event(AppMentionEvent.class, (req, ctx) -> {
139173
// ------------------------------
140174
// ソケットモードアプリを実行するスレッドを開始
141175
import com.slack.api.bolt.socket_mode.SocketModeApp;
176+
// Note: bolt-jakarta-socket-mode を使う場合は以下の import になります：
177+
// import com.slack.api.bolt.jakarta_socket_mode.SocketModeApp;
142178

143179
String appToken = "xapp-1-A111-111-xxx";
144180
SocketModeApp socketModeApp = new SocketModeApp(appToken, app);

0 commit comments

Comments
 (0)