Utility Methods API for PubNub Java SDK
Breaking changes in v9.0.0
PubNub Java SDK version 9.0.0 unifies the codebases for Java and Kotlin SDKs, introduces a new way of instantiating the PubNub client, and changes asynchronous API callbacks and emitted status events. These changes can impact applications built with previous versions (< 9.0.0) of the Java SDK.
For more details about what has changed, refer to Java/Kotlin SDK migration guide.
The methods on this page are utility methods that don't fit into other categories.
Create Push Payload
This method creates the push payload for use in the appropriate endpoint calls.
Method(s)
PushPayloadHelper()
.setApnsPayload(PushPayloadHelper.APNSPayload)
.setFcmPayload(PushPayloadHelper.FCMPayload)
.setCommonPayload(Map<String, Object>)
.build()
| Parameter | Type | Required | Description |
|---|---|---|---|
setApnsPayload() | APNSPayload | Optional | Set APNs and APNs2 Payload. Associated devices will receive only the data supplied here within the pn_apns key. |
setFcmPayload() | FCMPayload | Optional | Set FCM Payload. Associated devices will receive only the data supplied here within the pn_gcm key. |
setCommonPayload() | Map<String, Object> | Optional | Set common Payload. Native PubNub subscribers will receive the data provided here, together with the pn_apns, and pn_gcm objects. |
build() | Map<String, Object> | Yes | Builds the payload from the values set using the parameters. |
Basic Usage
Create Push Payload
// Create an instance of PushPayloadHelper
PushPayloadHelper pushPayloadHelper = new PushPayloadHelper();
// Setup FCM parameters (FCMPayload)
PushPayloadHelper.FCMPayload fcmPayload = new PushPayloadHelper.FCMPayload();
// The FCMPayload includes a custom Notification object, which FCM itself uses
// to display the message automatically to end-user devices on behalf of the
// client app.
// Notification messages have a predefined set of user-visible keys
PushPayloadHelper.FCMPayload.Notification fcmNotification =
new PushPayloadHelper.FCMPayload.Notification()
.setTitle("Notification title")
.setBody("Notification body text")
.setImage("http://example.com/image.png");
fcmPayload.setNotification(fcmNotification);
Response
The PushPayloadHelper#build() operation returns a Map<String, Object> which can be passed directly as the message() parameter to the pubnub.publish() method.
Destroy
Destroy frees up the threads and allows for clean exit.
Method(s)
destroy()
Basic Usage
pubnub.destroy();
Returns
None
Encrypt
This function allows to encrypt the data.
Deprecated
The cipherKey parameter in this method is deprecated. We recommend that you configure a seprate instance of the crypto module and use it for partial encryption.
If you pass cipherKey as an argument, it overrides the crypto module configuration and the legacy encryption with 128-bit cipher key entropy is used.
Method(s)
To encrypt the data you can use the following method(s) in Java SDK.
pubnub.encrypt(data, customCipherKey)
| Parameter | Type | Required | Description |
|---|---|---|---|
data | String | Yes | The data to encrypt. |
customCipherKey | String | Optional | Cipher key to use for encryption. If provided, the legacy encryption with 128-bit cipher key entropy is used. If not provided, the cryptoModule from PubNub config will be used. For more information, refer to Crypto module configuration. |
Basic Usage
Encrypt part of message
CryptoModule aesCbcCryptoModule = CryptoModule.createAesCbcCryptoModule("myCipherKey01", true);
String stringToBeEncrypted = "string to be encrypted";
byte[] encryptedData = aesCbcCryptoModule.encrypt(stringToBeEncrypted.getBytes(StandardCharsets.UTF_8));
Encrypt File Input Stream
Encrypts input stream with a cipher key.
Deprecated
The cipherKey parameter in this method is deprecated. We recommend that you configure a seprate instance of the crypto module and use it for partial encryption.
If you pass cipherKey as an argument, it overrides the crypto module configuration and the legacy encryption with 128-bit cipher key entropy is used.
Method(s)
pubnub.encryptInputStream(inputStream, cipherKey)
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inputStream | InputStream | Yes | Stream with content to encrypt. | |
cipherKey | String | Optional | PNConfiguration.getCipherKey() | If provided, the legacy encryption with 128-bit cipher key entropy is used. If not provided, the cryptoModule from PubNub config will be used. For more information, refer to Crypto module configuration |
Basic Usage
CryptoModule aesCbcCryptoModule = CryptoModule.createAesCbcCryptoModule("myCipherKey01", true);
InputStream inputStream = new ByteArrayInputStream(stringToBeEncrypted.getBytes(StandardCharsets.UTF_8));
InputStream encryptedStream = aesCbcCryptoModule.encryptStream(inputStream);
Returns
InputStream with encrypted data.
Decrypt
This function allows to decrypt the data.
Method(s)
To decrypt the data you can use the following method(s) in Java SDK.
Deprecated
The cipherKey parameter in this method is deprecated. We recommend that you configure a seprate instance of the crypto module and use it for partial encryption.
If you pass cipherKey as an argument, it overrides the crypto module configuration and the legacy encryption with 128-bit cipher key entropy is used.
pubnub.decrypt(data, customCipherKey)
| Parameter | Type | Required | Description |
|---|---|---|---|
data | String | Yes | The data to decrypt. |
customCipherKey | String | Optional | Cipher key to use for decryption. |
Basic Usage
CryptoModule aesCbcCryptoModule = CryptoModule.createAesCbcCryptoModule("myCipherKey01", true);
String stringToBeEncrypted = "string to be encrypted";
byte[] encryptedData = aesCbcCryptoModule.encrypt(stringToBeEncrypted.getBytes(StandardCharsets.UTF_8));
byte[] decryptedData = aesCbcCryptoModule.decrypt(encryptedData);
Decrypt File Input Stream
Decrypts input stream with a cipher key.
Deprecated
The cipherKey parameter in this method is deprecated. We recommend that you configure a seprate instance of the crypto module and use it for partial encryption.
If you pass cipherKey as an argument, it overrides the crypto module configuration and the legacy encryption with 128-bit cipher key entropy is used.
Method(s)
pubnub.decryptInputStream(inputStream, cipherKey)
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inputStream | InputStream | Yes | Stream with content encrypted data. | |
cipherKey | String | Optional | PNConfiguration.getCipherKey() | Cipher key to use for encryption. If provided, the legacy encryption with 128-bit cipher key entropy is used. If not provided, the cryptoModule from PubNub config will be used. For more information, refer to Crypto module configuration. |
Basic Usage
CryptoModule aesCbcCryptoModule = CryptoModule.createAesCbcCryptoModule("myCipherKey01", true);
InputStream inputStream = new ByteArrayInputStream(stringToBeEncrypted.getBytes(StandardCharsets.UTF_8));
InputStream encryptedStream = aesCbcCryptoModule.encryptStream(inputStream);
InputStream decryptedStream = aesCbcCryptoModule.decryptStream(encryptedStream);
Returns
InputStream with decrypted data.
Get Subscribed Channel Groups
Returns all the subscribed channel groups in a List of type String.
Method(s)
To Get Subscribe Channel Groups you can use the following method(s) in the Java SDK:
public final List<String> getSubscribedChannelGroups()
Basic Usage
Get Subscribed Channel Groups
List<String> groups = pubnub.getSubscribedChannelGroups();
Response
List<String>
["channelGroup1", "channelGroup2"]
Get Subscribed Channels
Returns all the subscribed channels in a List of type String.
Method(s)
To Get Subscribed Channels you can use the following method(s) in the Java SDK:
public final List<String> getSubscribedChannels()
Basic Usage
Get Subscribed Channels
List<String> channels = pubnub.getSubscribedChannels();
Response
List<String>
["channel1", "channel2"]
Disconnect
Call the disconnect method to force the SDK to stop all requests to PubNub server when there are active subscribe channels.
Method(s)
To disconnect the data transmission you can use the following method(s) in Java SDK.
disconnect()
This method doesn't take any arguments.
Basic Usage
pubnub.disconnect();
Reconnect
Call the reconnect method to force the SDK to try and reach out PubNub.
Method(s)
To reconnect the data you can use the following method(s) in Java SDK.
reconnect()
This method doesn't take any arguments.
Basic Usage
pubnub.reconnect();
Time
This function will return a 17 digit precision Unix epoch.
Algorithm constructing the timetoken
timetoken = (Unix epoch time in seconds) * 10000000
Example of creating a timetoken for a specific time and date:
08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000
Method(s)
To fetch Time you can use the following method(s) in Java SDK:
this.pubnub.Time()
| Parameter | Type | Required | Description |
|---|---|---|---|
async | Consumer<Result> | Yes | Consumer of a Result of type PNTimeResult |
Basic Usage
Get PubNub Timetoken
pubnub.time().async(result -> { /* check result */ });
Returns
The time() operation returns a PNTimeResult which contains the following operations:
| Method | Type | Description |
|---|---|---|
getTimetoken() | Long | Returns a long representation of current timetoken. |