README.md

mattermost4j

Mattermost API v4 client for Java.

Requirement

• JDK 8 or 11
  • for JDK 11 users: You may add these dependencies for runtime
    • Jakarta XML Binding
    • Jakarta Activation
• Mattermost Server
  • Please check mattermost4j version compatible with your server instance: https://github.com/maruTA-bis5/mattermost4j/wiki#what-version-shoud-i-use

Usage

Basic API Client

// Create client instance
MattermostClient client;
// case 1. use constructor - log disable and prohibit unknown properties
client = new MattermostClient("YOUR-MATTERMOST-URL");
// case 2. use builder
client = MattermostClient.builder()
    .url("YOUR-MATTERMOST-URL")
	.logLevel(Level.INFO)
	.ignoreUnknownProperties()
	.build();

// Login by id + password
client.login(loginId, password);
// Login by Personal Access Token
client.setAccessToken(token);

Use Incoming Webhook

// You can also use builder for create client instance.
IncomingWebhookClient client = new IncomingWebhookClient("YOUR-MATTERMOST-URL");

IncomingWebhookRequest payload = new IncomingWebhookRequest();
payload.setText("Hello World!");
payload.setUsername("Override Username");

client.postByIncomingWebhook(payload);

Install

Apache Maven:

<dependency>
	<groupId>net.bis5.mattermost4j</groupId>
	<artifactId>mattermost4j-core</artifactId>
	<version>0.22.1</version>
</dependency>

Gradle:

compile 'net.bis5.mattermost4j:mattermost4j-core:0.22.1'

Contribution

1. Fork it ( https://github.com/maruTA-bis5/mattermost4j/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Code Formatter

use https://github.com/google/styleguide/ {intellij,eclipse}-java-google-style.xml .

CheckStyle

Currently, use CheckStyle's built-in google_checks.xml.

Test

Unit test

• mvn test

Integration with Mattermost Server

1. docker-compose up
2. mvn verify

License

Apache Software License, Version 2.0