Module net.bis5.mattermost4j.core

Package net.bis5.mattermost.client4.api

Interface SystemApi

All Known Implementing Classes:

MattermostClient

public interface SystemApi

System API.

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method	Description
ApiResponse<Boolean>	databaseRecycle()	will recycle the connections.
default ApiResponse<AnalyticsRows>	getAnalytics()
default ApiResponse<AnalyticsRows>	getAnalytics(String teamId)
default ApiResponse<AnalyticsRows>	getAnalytics(AnalyticsCategory category)
ApiResponse<AnalyticsRows>	getAnalytics(AnalyticsCategory category, String teamId)
ApiResponse<Config>	getConfig()	will retrieve the server config with some sanitized items.
default ApiResponse<Map<String,String>>	getOldClientConfig()	will retrieve the parts of the server configuration needed by the client, formatted in the old format.
ApiResponse<Map<String,String>>	getOldClientConfig(String etag)	will retrieve the parts of the server configuration needed by the client, formatted in the old format.
default ApiResponse<Map<String,String>>	getOldClientLicense()	will retrieve the parts of the server license needed by the client, formatted in the old format.
ApiResponse<Map<String,String>>	getOldClientLicense(String etag)	will retrieve the parts of the server license needed by the client, formatted in the old format.
ApiResponse<Boolean>	getPing()	will ping the server and to see if it is up and running.
ApiResponse<Boolean>	invalidateCaches()	will purge the cache and can affect the performance while is cleaning.
ApiResponse<Boolean>	reloadConfig()	will reload the server configuration.
ApiResponse<Boolean>	removeLicense()
ApiResponse<Boolean>	testEmail()	will attempt to connect to the configured SMTP server.
ApiResponse<Config>	updateConfig(Config config)	will update the server configuration.
ApiResponse<Boolean>	uploadLicenseFile(Path licenseFile)

Method Detail

getPing

ApiResponse<Boolean> getPing()

will ping the server and to see if it is up and running.

testEmail

ApiResponse<Boolean> testEmail()

will attempt to connect to the configured SMTP server.

getConfig

ApiResponse<Config> getConfig()

will retrieve the server config with some sanitized items.

reloadConfig

ApiResponse<Boolean> reloadConfig()

will reload the server configuration.

getOldClientConfig

default ApiResponse<Map<String,String>> getOldClientConfig()

will retrieve the parts of the server configuration needed by the client, formatted in the old format.

getOldClientConfig

ApiResponse<Map<String,String>> getOldClientConfig(String etag)

will retrieve the parts of the server configuration needed by the client, formatted in the old format.

getOldClientLicense

default ApiResponse<Map<String,String>> getOldClientLicense()

will retrieve the parts of the server license needed by the client, formatted in the old format.

getOldClientLicense

ApiResponse<Map<String,String>> getOldClientLicense(String etag)

will retrieve the parts of the server license needed by the client, formatted in the old format.

databaseRecycle

ApiResponse<Boolean> databaseRecycle()

will recycle the connections. Discard current connection and get new one.

invalidateCaches

ApiResponse<Boolean> invalidateCaches()

will purge the cache and can affect the performance while is cleaning.

updateConfig

ApiResponse<Config> updateConfig(Config config)

will update the server configuration.

getAnalytics

default ApiResponse<AnalyticsRows> getAnalytics()

getAnalytics

default ApiResponse<AnalyticsRows> getAnalytics(AnalyticsCategory category)

getAnalytics

default ApiResponse<AnalyticsRows> getAnalytics(String teamId)

getAnalytics

ApiResponse<AnalyticsRows> getAnalytics(AnalyticsCategory category,
                                        String teamId)

uploadLicenseFile

ApiResponse<Boolean> uploadLicenseFile(Path licenseFile)

removeLicense

ApiResponse<Boolean> removeLicense()