A Java API for sending Push Notifications to the AeroGear UnifiedPush Server. For more information, please visit the Java Sender Tutorial for example usages.
| Project Info | |
|---|---|
| License: | Apache License, Version 2.0 |
| Build: | Maven |
| Documentation: | https://aerogear.org/push/ |
| Issue tracker: | https://issues.jboss.org/browse/AGPUSH |
| Mailing lists: | aerogear-users (subscribe) |
| aerogear-dev (subscribe) |
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>
Create a JavaSender:
PushSender defaultPushSender = DefaultPushSender.withRootServerURL("http://localhost:8080/ag-push")
.pushApplicationId("c7fc6525-5506-4ca9-9cf1-55cc261ddb9c")
.masterSecret("8b2f43a9-23c8-44fe-bee9-d6b0af9e316b")
.build();
You can also use an external config file :
//pushConfig.json
{
"serverUrl": "http://aerogear.example.com/ag-push",
"pushApplicationId": "c7fc6525-5506-4ca9-9cf1-55cc261ddb9c",
"masterSecret": "8b2f43a9-23c8-44fe-bee9-d6b0af9e316b"}
}
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();
Construct a UnifiedMessage using the Builder :
UnifiedMessage unifiedMessage = UnifiedMessage.withCriteria()
.aliases("john", "maria")
.message()
.alert("Hello from Java Sender API!")
.sound("default")
.badge("1") // iOS specific
.userData("some_key", "some_value") // optional attributes specific to your app
.userData("title", "Cool Title") // optional cordova Android specific attribute (default is appName)
.build();
Create a callback
MessageResponseCallback callback = new MessageResponseCallback() {
@Override
public void onComplete(int statusCode) {
//do cool stuff
}
};
Send the message
defaultPushSender.send(unifiedMessage, callback);
You can also omit the callback
defaultPushSender.send(unifiedMessage);
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
For more details about the current release, please consult our documentation.
If you would like to help develop AeroGear you can join our developer's mailing list, join #aerogear on Freenode, or shout at us on Twitter @aerogears.
Also takes some time and skim the contributor guide
Join our user mailing list for any questions or help! We really hope you enjoy app development with AeroGear!
If you found a bug please create a ticket for us on Jira with some steps to reproduce it.