Matrix Client SDK for Java
This project is no longer maintained.
Purpose
Matrix SDK in Java 1.8 for:
- Client -> Homeserver
- Client -> Identity Server
- Application Server -> Homeserver
Use
Add to your project
Gradle
repositories {
maven {
url 'https://kamax.io/maven/releases/'
}
}
dependencies {
compile 'io.kamax:matrix-java-sdk:<USE_LATEST_TAG_WITHOUT_LEADING_V>'
}
Maven
<repositories>
<repository>
<id>kamax-io</id>
<name>kamax-io</name>
<url>https://kamax.io/maven/releases/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>io.kamax</groupId>
<artifactId>matrix-java-sdk</artifactId>
<version>USE_LATEST_TAG_WITHOUT_LEADING_V</version>
</dependency>
</dependencies>
WARNING: This SDK was originally created to support Kamax.io projects and is therefore not necessarily complete. It will be built as the various projects evolve and grow. The SDK is therefore still in Alpha.
Getting started
Getting the client object
With .well-known auto-discovery:
_MatrixClient client = new MatrixHttpClient("example.org");
client.discoverSettings();With C2S API Base URL:
URL baseUrl = new URL("https://example.org");
_MatrixClient client = new MatrixHttpClient(baseUrl);Providing credentials
Access token:
client.setAccessToken(accessToken);Log in:
client.login(new MatrixPasswordCredentials(username, password));Sync
// We will update this after each sync call
String syncToken = null;
// We sync until the process is interrupted via Ctrl+C or a signal
while (!Thread.currentThread().isInterrupted()) {
// We provide the next batch token, or null if we don't have one yet
_SyncData data = client.sync(SyncOptions.build().setSince(syncToken).get());
// We check the joined rooms
for (JoinedRoom joinedRoom : data.getRooms().getJoined()) {
// We get the relevant room object to act on it while we process
_Room room = client.getRoom(joinedRoom.getId());
for (_MatrixEvent rawEv : joinedRoom.getTimeline()) {
// We only want to act on room messages
if ("m.room.message".contentEquals(rawEv.getType())) {
MatrixJsonRoomMessageEvent msg = new MatrixJsonRoomMessageEvent(rawEv.getJson());
// Ping?
if (StringUtils.equals("ping", msgg.getBody())) {
// Pong!
room.sendText("pong");
}
}
}
}
// We check the invited rooms
for (InvitedRoom invitedRoom : data.getRooms().getInvited()) {
// We auto-join rooms we are invited to
client.getRoom(invitedRoom.getId()).join());
}
// Done processing sync data. We save the next batch token for the next loop execution
syncToken = data.nextBatchToken();
}As an Application Service
Use MatrixApplicationServiceClient instead of MatrixHttpClient when creating the main client object.
To talk to the API as a virtual user, use the method createClient(localpart) on MatrixApplicationServiceClient, then
processed normally.
Real-world usage
As a regular client
You can check the Send'n'Leave bot which make uses of this SDK in a more realistic fashion.
Direct link to the relevant code: here
As an Application Service
-
mxasd-voip
-
mxasd-email - WARNING: This project use a very old version of the SDK but is still relevant
Contribute
Contributions and PRs are welcome to turn this into a fully fledged Matrix Java SDK.
Your code will be licensed under AGPLv3.
To ensure code formatting consistency, we use Spotless.
Before opening any PR, make sure you format the code:
./gradlew spotlessApplyYour code must pass all existing tests with and must provide tests for any new method/class/feature.
Make sure you run:
./gradlew test