JarCastingAeroGear Unified Push Java Client
A Java API for sending Push Notifications to the AeroGear UnifiedPush Server.
| Project Info | |
|---|---|
| License: | Apache License, Version 2.0 |
| Build: | Maven |
| End User Documentation: | https://docs.aerogear.org |
| Community Documentation: | https://aerogear.org |
| Issue tracker: | https://issues.jboss.org/browse/AEROGEAR |
| Mailing lists: | https://groups.google.com/forum/#!forum/aerogear |
Getting started
Add the following dependencies to your pom.xml file:
<dependency>
<groupId>org.jboss.aerogear</groupId>
<artifactId>unifiedpush-java-client</artifactId>
<version>1.1.0.Final</version>
</dependency>
Usage
Create a JavaSender:
PushSender defaultPushSender = DefaultPushSender
.withRootServerURL("<pushServerURL e.g http(s)//host:port/context>")
.pushApplicationId("<pushApplicationId e.g. 1234456-234320>")
.masterSecret("<masterSecret e.g. 1234456-234320>")
.build();
You can also use an external config file:
pushConfig.json
{
"serverUrl": "<pushServerURL e.g http(s)//host:port/context>",
"pushApplicationId": "<pushApplicationId e.g. 1234456-234320>",
"masterSecret": "<masterSecret e.g. 1234456-234320>"
}
And then :
PushSender defaultPushSender = DefaultPushSender
.withConfig("pushConfig.json")
.build();
To connect via proxy:
PushSender defaultPushSender = DefaultPushSender
.withConfig("pushConfig.json")
.proxy("proxy.example.com", 8080)
.proxyUser("proxyuser")
.proxyPassword("password")
.proxyType(Proxy.Type.HTTP)
.build();
To use a custom TrustStore:
PushSender defaultPushSender = DefaultPushSender
.withConfig("pushConfig.json")
.customTrustStore("setup/aerogear.truststore", "jks", "aerogear")
.build();
Send a message
Construct a UnifiedMessage using the Builder :
UnifiedMessage unifiedMessage = UnifiedMessage.withCriteria()
.aliases("john", "maria")
.message()
.alert("Hello from Java Sender API!")
.sound("default")
// iOS specific
.badge("1")
// optional specific to your app
.userData("some_key", "some_value")
// optional cordova Android specific attribute (default is appName)
.userData("title", "Cool Title")
.build();
Create a callback
MessageResponseCallback callback = new MessageResponseCallback() {
@Override
public void onComplete() {
//do cool stuff
}
};
Send the message
defaultPushSender.send(unifiedMessage, callback);
You can also omit the callback
defaultPushSender.send(unifiedMessage);
Known issues
On Java7 you might see a SSLProtocolException: handshake alert: unrecognized_name expection when the UnifiedPush server is running on https. There are a few workarounds:
- JBoss'
standalone.xmlconfiguration file:
...
</extensions>
<system-properties>
<property name="jsse.enableSNIExtension" value="false"/>
</system-properties>
- in the Java app, that is using the Java Client SDK:
System.setProperty("jsse.enableSNIExtension", "false"); - Or via commandline argument:
-Djsse.enableSNIExtension=false
License
See LICENSE file
Questions?
Join our user mailing list for any questions or help! We really hope you enjoy app development with AeroGear.
Found a bug?
If you found a bug please create a ticket for us on Jira with some steps to reproduce it.
