Package com.slack.api.socket_mode.impl

Class SocketModeClientJavaWSImpl

java.lang.Object

com.slack.api.socket_mode.impl.SocketModeClientJavaWSImpl

All Implemented Interfaces:

SocketModeClient, Closeable, AutoCloseable

public class SocketModeClientJavaWSImpl
extends Object
implements SocketModeClient

Nested Class Summary

Nested classes/interfaces inherited from interface com.slack.api.socket_mode.SocketModeClient

SocketModeClient.Backend

Field Summary

Fields inherited from interface com.slack.api.socket_mode.SocketModeClient

DEFAULT_MESSAGE_PROCESSOR_CONCURRENCY, DEFAULT_SESSION_MONITOR_INTERVAL_MILLISECONDS, EXECUTOR_GROUP_NAME_PREFIX, GSON, LOGGER, PRETTY_PRINTING

Constructor Summary

Constructors

Constructor	Description
SocketModeClientJavaWSImpl(Slack slack, String appToken)
SocketModeClientJavaWSImpl(Slack slack, String appToken, String wssUrl)
SocketModeClientJavaWSImpl(Slack slack, String appToken, String wssUrl, int concurrency)
SocketModeClientJavaWSImpl(Slack slack, String appToken, String wssUrl, int concurrency, SocketModeMessageQueue messageQueue, boolean autoReconnectEnabled, boolean sessionMonitorEnabled, long sessionMonitorIntervalMillis)
SocketModeClientJavaWSImpl(String appToken)

Method Summary

Modifier and Type	Method	Description
void	connect()	Connects to the current WSS endpoint and starts a new WebSocket session.
void	connectToNewEndpoint()	Connects to a new WSS endpoint and starts a new WebSocket session.
void	disconnect()	Disconnects from the wss endpoint and abandons the current session.
String	getAppToken()
List<EnvelopeListener<EventsApiEnvelope>>	getEventsApiEnvelopeListeners()
com.google.gson.Gson	getGson()
List<EnvelopeListener<InteractiveEnvelope>>	getInteractiveEnvelopeListeners()
ScheduledExecutorService	getMessageProcessorExecutor()
SocketModeMessageQueue	getMessageQueue()	Returns the message queue for message processor workers.
Optional<ScheduledExecutorService>	getSessionMonitorExecutor()
Slack	getSlack()
List<EnvelopeListener<SlashCommandsEnvelope>>	getSlashCommandsEnvelopeListeners()
List<WebSocketCloseListener>	getWebSocketCloseListeners()
List<WebSocketErrorListener>	getWebSocketErrorListeners()
List<WebSocketMessageListener>	getWebSocketMessageListeners()
URI	getWssUri()	Returns the current WSS URI.
boolean	isAutoReconnectEnabled()	Tries to reconnect to the Socket Mode server if true.
boolean	isSessionMonitorEnabled()	A background job for session maintenance works if true.
long	maintainCurrentSession()	Maintains the current session in a background job.
void	sendWebSocketMessage(String message)	Sends a text message to the Socket Mode server via the current WebSocket connection.
void	setAppToken(String appToken)
void	setAutoReconnectEnabled(boolean autoReconnectEnabled)
void	setMessageProcessorExecutor(ScheduledExecutorService executorService)
void	setMessageQueue(SocketModeMessageQueue messageQueue)
void	setSessionMonitorEnabled(boolean sessionMonitorEnabled)
void	setSessionMonitorExecutor(Optional<ScheduledExecutorService> executorService)
void	setSlack(Slack slack)
void	setWssUri(URI wssUri)
boolean	verifyConnection()	Returns true if this client is connected to the Socket Mode server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.slack.api.socket_mode.SocketModeClient

addEventsApiEnvelopeListener, addInteractiveEnvelopeListener, addSlashCommandsEnvelopeListener, addWebSocketCloseListener, addWebSocketErrorListener, addWebSocketMessageListener, close, debugLogRequest, debugLogResponse, enqueueMessage, getExecutorGroupNamePrefix, getLogger, initializeMessageProcessorExecutor, initializeSessionMonitorExecutor, processMessage, removeEventsApiEnvelopeListener, removeInteractiveEnvelopeListener, removeSlashCommandsEnvelopeListener, removeWebSocketCloseListener, removeWebSocketErrorListener, removeWebSocketMessageListener, runCloseListenersAndAutoReconnectAsNecessary, runErrorListeners, sendSocketModeResponse, sendSocketModeResponse

Constructor Detail

SocketModeClientJavaWSImpl

public SocketModeClientJavaWSImpl(String appToken)
                           throws IOException,
                                  SlackApiException,
                                  URISyntaxException

Throws:

IOException

SlackApiException

URISyntaxException

SocketModeClientJavaWSImpl

public SocketModeClientJavaWSImpl(Slack slack,
                                  String appToken)
                           throws IOException,
                                  SlackApiException,
                                  URISyntaxException

Throws:

IOException

SlackApiException

URISyntaxException

SocketModeClientJavaWSImpl

public SocketModeClientJavaWSImpl(Slack slack,
                                  String appToken,
                                  String wssUrl)
                           throws URISyntaxException

Throws:

URISyntaxException

SocketModeClientJavaWSImpl

public SocketModeClientJavaWSImpl(Slack slack,
                                  String appToken,
                                  String wssUrl,
                                  int concurrency)
                           throws URISyntaxException

Throws:

URISyntaxException

SocketModeClientJavaWSImpl

public SocketModeClientJavaWSImpl(Slack slack,
                                  String appToken,
                                  String wssUrl,
                                  int concurrency,
                                  SocketModeMessageQueue messageQueue,
                                  boolean autoReconnectEnabled,
                                  boolean sessionMonitorEnabled,
                                  long sessionMonitorIntervalMillis)
                           throws URISyntaxException

Throws:

URISyntaxException

Method Detail

connect

public void connect()

Description copied from interface: SocketModeClient

Connects to the current WSS endpoint and starts a new WebSocket session.

Specified by:

connect in interface SocketModeClient

verifyConnection

public boolean verifyConnection()

Description copied from interface: SocketModeClient

Returns true if this client is connected to the Socket Mode server.

Specified by:

verifyConnection in interface SocketModeClient

disconnect

public void disconnect()

Description copied from interface: SocketModeClient

Disconnects from the wss endpoint and abandons the current session.

Specified by:

disconnect in interface SocketModeClient

connectToNewEndpoint

public void connectToNewEndpoint()
                          throws IOException

Description copied from interface: SocketModeClient

Connects to a new WSS endpoint and starts a new WebSocket session.

Specified by:

connectToNewEndpoint in interface SocketModeClient

Throws:

IOException

sendWebSocketMessage

public void sendWebSocketMessage(String message)

Description copied from interface: SocketModeClient

Sends a text message to the Socket Mode server via the current WebSocket connection.

Specified by:

sendWebSocketMessage in interface SocketModeClient

maintainCurrentSession

public long maintainCurrentSession()

Description copied from interface: SocketModeClient

Maintains the current session in a background job.

see also: initializeSessionMonitorExecutor

Specified by:

maintainCurrentSession in interface SocketModeClient

Returns:

unix time to check next time

getSlack

public Slack getSlack()

Specified by:

getSlack in interface SocketModeClient

setSlack

public void setSlack(Slack slack)

Specified by:

setSlack in interface SocketModeClient

getGson

public com.google.gson.Gson getGson()

Specified by:

getGson in interface SocketModeClient

getAppToken

public String getAppToken()

Specified by:

getAppToken in interface SocketModeClient

setAppToken

public void setAppToken(String appToken)

Specified by:

setAppToken in interface SocketModeClient

getWssUri

public URI getWssUri()

Description copied from interface: SocketModeClient

Returns the current WSS URI.

Specified by:

getWssUri in interface SocketModeClient

setWssUri

public void setWssUri(URI wssUri)

Specified by:

setWssUri in interface SocketModeClient

isAutoReconnectEnabled

public boolean isAutoReconnectEnabled()

Description copied from interface: SocketModeClient

Tries to reconnect to the Socket Mode server if true.

Specified by:

isAutoReconnectEnabled in interface SocketModeClient

setAutoReconnectEnabled

public void setAutoReconnectEnabled(boolean autoReconnectEnabled)

Specified by:

setAutoReconnectEnabled in interface SocketModeClient

isSessionMonitorEnabled

public boolean isSessionMonitorEnabled()

Description copied from interface: SocketModeClient

A background job for session maintenance works if true.

Specified by:

isSessionMonitorEnabled in interface SocketModeClient

setSessionMonitorEnabled

public void setSessionMonitorEnabled(boolean sessionMonitorEnabled)

Specified by:

setSessionMonitorEnabled in interface SocketModeClient

getSessionMonitorExecutor

public Optional<ScheduledExecutorService> getSessionMonitorExecutor()

Specified by:

getSessionMonitorExecutor in interface SocketModeClient

setSessionMonitorExecutor

public void setSessionMonitorExecutor(Optional<ScheduledExecutorService> executorService)

Specified by:

setSessionMonitorExecutor in interface SocketModeClient

getMessageQueue

public SocketModeMessageQueue getMessageQueue()

Description copied from interface: SocketModeClient

Returns the message queue for message processor workers.

Specified by:

getMessageQueue in interface SocketModeClient

setMessageQueue

public void setMessageQueue(SocketModeMessageQueue messageQueue)

Specified by:

setMessageQueue in interface SocketModeClient

getMessageProcessorExecutor

public ScheduledExecutorService getMessageProcessorExecutor()

Specified by:

getMessageProcessorExecutor in interface SocketModeClient

setMessageProcessorExecutor

public void setMessageProcessorExecutor(ScheduledExecutorService executorService)

Specified by:

setMessageProcessorExecutor in interface SocketModeClient

getWebSocketErrorListeners

public List<WebSocketErrorListener> getWebSocketErrorListeners()

Specified by:

getWebSocketErrorListeners in interface SocketModeClient

getWebSocketCloseListeners

public List<WebSocketCloseListener> getWebSocketCloseListeners()

Specified by:

getWebSocketCloseListeners in interface SocketModeClient

getWebSocketMessageListeners

public List<WebSocketMessageListener> getWebSocketMessageListeners()

Specified by:

getWebSocketMessageListeners in interface SocketModeClient

getEventsApiEnvelopeListeners

public List<EnvelopeListener<EventsApiEnvelope>> getEventsApiEnvelopeListeners()

Specified by:

getEventsApiEnvelopeListeners in interface SocketModeClient

getInteractiveEnvelopeListeners

public List<EnvelopeListener<InteractiveEnvelope>> getInteractiveEnvelopeListeners()

Specified by:

getInteractiveEnvelopeListeners in interface SocketModeClient

getSlashCommandsEnvelopeListeners

public List<EnvelopeListener<SlashCommandsEnvelope>> getSlashCommandsEnvelopeListeners()

Specified by:

getSlashCommandsEnvelopeListeners in interface SocketModeClient