{"id":13724758,"url":"https://github.com/maruTA-bis5/mattermost4j","last_synced_at":"2025-05-07T19:30:50.577Z","repository":{"id":23673440,"uuid":"95425915","full_name":"maruTA-bis5/mattermost4j","owner":"maruTA-bis5","description":"Mattermost API v4 Client for Java","archived":false,"fork":false,"pushed_at":"2023-11-14T22:31:29.000Z","size":19150,"stargazers_count":31,"open_issues_count":73,"forks_count":20,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-04T01:25:53.649Z","etag":null,"topics":["hacktoberfest","java","mattermost"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maruTA-bis5.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"maruTA-bis5"}},"created_at":"2017-06-26T08:36:14.000Z","updated_at":"2024-07-18T09:08:12.000Z","dependencies_parsed_at":"2024-01-10T07:03:00.562Z","dependency_job_id":"a2de3f37-658c-4611-9fdb-bb77114ff38c","html_url":"https://github.com/maruTA-bis5/mattermost4j","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruTA-bis5%2Fmattermost4j","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruTA-bis5%2Fmattermost4j/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruTA-bis5%2Fmattermost4j/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruTA-bis5%2Fmattermost4j/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maruTA-bis5","download_url":"https://codeload.github.com/maruTA-bis5/mattermost4j/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224636893,"owners_count":17344631,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","java","mattermost"],"created_at":"2024-08-03T01:02:03.010Z","updated_at":"2024-11-14T14:32:11.570Z","avatar_url":"https://github.com/maruTA-bis5.png","language":"Java","funding_links":["https://github.com/sponsors/maruTA-bis5"],"categories":["Java","API\u0026客户端"],"sub_categories":["文件同步"],"readme":"mattermost4j\n============\n\n![CI Status](https://github.com/maruTA-bis5/mattermost4j/workflows/CI/badge.svg)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.bis5.mattermost4j/mattermost4j-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.bis5.mattermost4j/mattermost4j-core)\n[![Javadocs](http://javadoc.io/badge/net.bis5.mattermost4j/mattermost4j-core.svg)](http://javadoc.io/doc/net.bis5.mattermost4j/mattermost4j-core)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=net.bis5.mattermost4j%3Amattermost4j-parent\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=net.bis5.mattermost4j%3Amattermost4j-parent)\n\nMattermost API v4 client for Java.\n\n## Requirement\n- JDK 11 or later\n\t- Additional dependencies required for Java SE runtime environment. These dependencies is not required for Jakarta EE server environment.\n\t\t- Jakarta XML Binding (`jakarta.xml.bind:jakarta.xml.bind-api`)\n\t\t- Jakarta Activation (`jakarta.activation:jakarta.activation-api`)\n- Mattermost Server\n    - Please check mattermost4j version compatible with your server instance:\n    https://github.com/maruTA-bis5/mattermost4j/wiki#what-version-shoud-i-use\n- Jakarta RESTful Web Services 3.1 implementation (Client only, A part of Jakarta EE 10)\n\n## Usage\n### Basic API Client\n```java\n// Create client instance\nMattermostClient client;\n// case 1. use constructor - log disable and prohibit unknown properties\nclient = new MattermostClient(\"YOUR-MATTERMOST-URL\");\n// case 2. use builder\nclient = MattermostClient.builder()\n    .url(\"YOUR-MATTERMOST-URL\")\n\t.ignoreUnknownProperties()\n\t.build();\n\n// Login by id + password\nclient.login(loginId, password);\n// Login by Personal Access Token\nclient.setAccessToken(token);\n```\n\n### Use Incoming Webhook\n```java\n// You can also use builder for create client instance.\nIncomingWebhookClient client = new IncomingWebhookClient(\"YOUR-MATTERMOST-URL\");\n\nIncomingWebhookRequest payload = new IncomingWebhookRequest();\npayload.setText(\"Hello World!\");\npayload.setUsername(\"Override Username\");\n\nclient.postByIncomingWebhook(payload);\n```\n\n## Install\nAdd these dependencies to your project.\n- Core (`net.bis5.mattermost4j:mattermost4j-core`)\n- Client Adapter matches to your RESTful Web Service Client  \nYou can request to create new client adapter for other client not in below list if you would like to use.\n\t- for Jersey: `net.bis5.mattermost4j:mattermost4j-jersey`\n\t- for RESTEasy: `net.bis5.mattermost4j:mattermost4j-resteasy`\n\n## Module index\ngroupId: `net.bis5.mattermost4j`\n|artifactId|JPMS module|module name|note|\n|---|---|---|---|\n|`mattermost-models`|`net.bis5.mattermost4j.models`|Maattermost Data Models||\n|`mattermost4j-core`|`net.bis5.mattermost4j.core`|Mattermost APIv4 Client for Java||\n|`mattermost4j-integration-test-base`|`net.bis5.mattermost4j.testbase`|Mattermost4J :: Integration Test Base||\n|`mattermost4j-jersey`|`net.bis5.mattermost4j.jersey`|Mattermost4J :: Jersey Client||\n|`mattermost4j-resteasy`|`net.bis5.mattermost4j.resteasy`|Mattermost4J :: RESTEasy Client|(JPMS) Automatic module|\n\n## Contribution\n1. Fork it ( https://github.com/maruTA-bis5/mattermost4j/fork )\n2. Create your feature branch (git checkout -b my-new-feature)\n3. Commit your changes (git commit -am 'Add some feature')\n4. Push to the branch (git push origin my-new-feature)\n5. Create new Pull Request\n\n### Code Formatter\nuse https://github.com/google/styleguide/ {intellij,eclipse}-java-google-style.xml .\n\n### CheckStyle\nCurrently, use CheckStyle's built-in `google_checks.xml`.\n\n## Test\n### Integration with Mattermost Server\n1. `docker-compose up`\n2. `mvn test`\n\n#### To run specify test\n1. `docker-compose up`\n2. `mvn test -Dtest=UsersApiTest -Dsurefire.failIfNoSpecifiedTests=false`\n\n## Contact\n- Create GitHub Issue (https://github.com/maruTA-bis5/primefaces-excella-exporter/issues/new)\n- or Start new Discussion (https://github.com/maruTA-bis5/primefaces-excella-exporter/discussions/new)\n- or DM me on the Mattermost Community Server (https://community.mattermost.com/core/messages/@maruta-bis5)\n\n## License\n[Apache Software License, Version 2.0](LICENSE.txt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FmaruTA-bis5%2Fmattermost4j","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FmaruTA-bis5%2Fmattermost4j","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FmaruTA-bis5%2Fmattermost4j/lists"}