Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tigase/jaxmpp

Java XMPP client library
https://github.com/tigase/jaxmpp

android chat instant-messaging jabber java library xmpp

Last synced: 3 months ago
JSON representation

Java XMPP client library

Host: GitHub
URL: https://github.com/tigase/jaxmpp
Owner: tigase
License: agpl-3.0
Created: 2019-04-26T09:03:09.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-06-27T21:28:10.000Z (over 1 year ago)
Last Synced: 2024-05-18T17:46:58.600Z (6 months ago)
Topics: android, chat, instant-messaging, jabber, java, library, xmpp
Language: Java
Homepage: https://tigase.net/
Size: 4.52 MB
Stars: 30
Watchers: 9
Forks: 7
Open Issues: 5
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: COPYING

Awesome Lists containing this project

awesome-xmpp - JaXMPP - Java XMPP client library (Libraries)

README

        > # NOTE: Tigase JaXMPP has new home at [tigase.dev/tigase/_libraries/jaxmpp](https://tigase.dev/tigase/_libraries/jaxmpp/) - please submit all issues/pull-requests there!



  Tigase Java XMPP Client Library



![](jaxmpp-documentation/src/main/restructured/images/logo_320.png)

# What it is

Tigase Java XMPP Client Library is an [XMPP](https://xmpp.org) client library written in a Java programming language. 

It provides implementation of core of the XMPP standard and processing XML. Additionally it provides support for many popular extensions (XEP's). 

This repository contains source files of the library.

# Features

JaXMPP implements support for [RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core](https://xmpp.org/rfcs/rfc6120.html) and [RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence](https://xmpp.org/rfcs/rfc6121.html).

Additionally it supports many popular XEPs. Below is a list of some of the supported XEPs:

* [XEP-0004: Data Forms](https://xmpp.org/extensions/xep-0004.html)

* [XEP-0030: Service Discovery](https://xmpp.org/extensions/xep-0030.html)

* [XEP-0045: Multi-User Chat](https://xmpp.org/extensions/xep-0045.html)

* [XEP-0050: Ad-Hoc Commands](https://xmpp.org/extensions/xep-0050.html)

* [XEP-0054: vcard-temp](https://xmpp.org/extensions/xep-0054.html)

* [XEP-0069: Result Set Management](https://xmpp.org/extensions/xep-0059.html)

* [XEP-0060: Publish-Subscribe](https://xmpp.org/extensions/xep-0060.html)

* [XEP-0077: In-Band Registration](https://xmpp.org/extensions/xep-0077.html)

* [XEP-0084: User Avatar](https://xmpp.org/extensions/xep-0084.html)

* [XEP-0092: Software Version](https://xmpp.org/extensions/xep-0092.html)

* [XEP-0115: Entity Capabilities](https://xmpp.org/extensions/xep-0115.html)

* [XEP-0138: Stream Compression](https://xmpp.org/extensions/xep-0138.html)

* [XEP-0153: vCard-Based Avatar](https://xmpp.org/extensions/xep-0153.html)

* [XEP-0163: Personal Eventing Protocol](https://xmpp.org/extensions/xep-0163.html)

* [XEP-0166: Jingle](https://xmpp.org/extensions/xep-0166.html)

* [XEP-0167: Jingle RTP Session](https://xmpp.org/extensions/xep-0167.html)

* [XEP-0176: Jingle ICE-UDP Transport Method](https://xmpp.org/extensions/xep-0176.html)

* [XEP-0184: Message Delivery Receipts](https://xmpp.org/extensions/xep-0184.html)

* [XEP-0198: Stream Management](https://xmpp.org/extensions/xep-0198.html)

* [XEP-0203: Delayed Delivery](https://xmpp.org/extensions/xep-0203.html)

* [XEP-0249: Direct MUC Invitations](https://xmpp.org/extensions/xep-0249.html)

* [XEP-0280: Message Carbons](https://xmpp.org/extensions/xep-0280.html)

* [XEP-0305: XMPP Quickstart](https://xmpp.org/extensions/xep-0305.html)

* [XEP-0313: Message Archive Management](https://xmpp.org/extensions/xep-0313.html)

* [XEP-0357: Push Notifications](https://xmpp.org/extensions/xep-0357.html)

* [XEP-0363: HTTP File Upload](https://xmpp.org/extensions/xep-0363.html)

* [XEP-0384: OMEMO Encryption](https://xmpp.org/extensions/xep-0384.html)

# Compilation 

[Maven](https://maven.apache.org/) is required tool to compile library:

    mvn package

To build [Android](https://developer.android.com/) JaXMPP module just use `android` profile:

    mvn package -Pandroid 

Note, that following requirements has to be met:

* Java 1.8 has to be used

* Android sdk must be installed (e.g.: `brew install android-sdk`)

* Proper tooling mus be installed (e.g.: `sdkmanager "platform-tools" "platforms;android-28"`)

* `ANDROID_HOME` must be declared. (e.g.: `export ANDROID_HOME=/usr/local/Caskroom/android-sdk/4333796`)

## Releasing

* prepare release: `mvn -Pdist clean release:clean release:prepare`

* perform: `mvn -Pdist release:perform`

# Simple client

Following snippet (in `groovy`) creates simple XMPP client, that connects to the server and prints out all incomming messages (waits for 1 minut and disconnects)

```groovy

import tigase.jaxmpp.core.client.BareJID

import tigase.jaxmpp.core.client.JID

import tigase.jaxmpp.core.client.SessionObject

import tigase.jaxmpp.core.client.exceptions.JaxmppException

import tigase.jaxmpp.core.client.xmpp.modules.chat.Chat

import tigase.jaxmpp.core.client.xmpp.modules.chat.MessageModule

import tigase.jaxmpp.core.client.xmpp.stanzas.Message

import tigase.jaxmpp.j2se.Jaxmpp

final Jaxmpp contact = new Jaxmpp()

tigase.jaxmpp.j2se.Presence.initialize(contact);

contact.getModulesManager().register(new MessageModule());

contact.getProperties().setUserProperty(SessionObject.USER_BARE_JID, BareJID.bareJIDInstance("admin@atlantiscity"))

contact.getProperties().setUserProperty(SessionObject.PASSWORD, "admin")

contact.getEventBus().addHandler(MessageModule.MessageReceivedHandler.MessageReceivedEvent.class,

        new MessageModule.MessageReceivedHandler() {

            @Override

            public void onMessageReceived(SessionObject sessionObject, Chat chat, Message stanza) {

                System.out.println("received message: " + stanza.getBody());

            }

        });

println("Loging in...");

contact.login(true)

if (contact.isConnected()) {

    TimeUnit.MINUTES.sleep(1);

    contact.disconnect()

}

```

# Support

When looking for support, please first search for answers to your question in the available online channels:

* Our online documentation: [Tigase Docs](https://docs.tigase.net)

* Existing issues in relevant project, for Tigase Server it's: [Tigase XMPP Server GitHub issues](https://github.com/tigase/jaxmpp/issues)

If you didn't find an answer in the resources above, feel free to submit your question as [new issue on GitHub](https://github.com/tigase/jaxmpp/issues/new/choose) or, if you have valid support subscription, open [new support ticket](https://tigase.net/technical-support).

# License

 Official Tigase repository is available at: https://github.com/tigase/jaxmpp/.

Copyright (c) 2004 Tigase, Inc.

Licensed under AGPL License Version 3. Other licensing options available upon request.