com.clevertap.apns.clients

Class SyncOkHttpApnsClient

java.lang.Object

com.clevertap.apns.clients.SyncOkHttpApnsClient

All Implemented Interfaces:

ApnsClient

Direct Known Subclasses:

AsyncOkHttpApnsClient

public class SyncOkHttpApnsClient
extends java.lang.Object
implements ApnsClient

A wrapper around OkHttp's http client to send out notifications using Apple's HTTP/2 API.

Field Summary

Fields

Modifier and Type	Field and Description
protected okhttp3.OkHttpClient	client

Constructor Summary

Constructors

Constructor and Description
SyncOkHttpApnsClient(java.io.InputStream certificate, java.lang.String password, boolean production, java.lang.String defaultTopic, okhttp3.ConnectionPool connectionPool) Creates a new client and automatically loads the key store with the push certificate read from the input stream.
SyncOkHttpApnsClient(java.io.InputStream certificate, java.lang.String password, boolean production, java.lang.String defaultTopic, okhttp3.OkHttpClient.Builder builder) Creates a new client and automatically loads the key store with the push certificate read from the input stream.
SyncOkHttpApnsClient(java.io.InputStream certificate, java.lang.String password, boolean production, java.lang.String defaultTopic, okhttp3.OkHttpClient.Builder builder, int connectionPort) Creates a new client and automatically loads the key store with the push certificate read from the input stream.
SyncOkHttpApnsClient(java.lang.String apnsAuthKey, java.lang.String teamID, java.lang.String keyID, boolean production, java.lang.String defaultTopic, okhttp3.ConnectionPool connectionPool) Creates a new client which uses token authentication API.
SyncOkHttpApnsClient(java.lang.String apnsAuthKey, java.lang.String teamID, java.lang.String keyID, boolean production, java.lang.String defaultTopic, okhttp3.OkHttpClient.Builder clientBuilder) Creates a new client which uses token authentication API.
SyncOkHttpApnsClient(java.lang.String apnsAuthKey, java.lang.String teamID, java.lang.String keyID, boolean production, java.lang.String defaultTopic, okhttp3.OkHttpClient.Builder clientBuilder, int connectionPort) Creates a new client which uses token authentication API.

Method Summary

Modifier and Type	Method and Description
protected okhttp3.Request	buildRequest(Notification notification)
okhttp3.OkHttpClient	getHttpClient() Returns the underlying OkHttpClient instance.
boolean	isSynchronous() Checks whether the client supports synchronous operations.
protected NotificationResponse	parseResponse(okhttp3.Response response)
NotificationResponse	push(Notification notification) Sends a notification synchronously to the Apple Push Notification Service.
void	push(Notification notification, NotificationResponseListener listener) Sends a notification asynchronously to the Apple Push Notification Service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

client

protected final okhttp3.OkHttpClient client

Constructor Detail

SyncOkHttpApnsClient

public SyncOkHttpApnsClient(java.lang.String apnsAuthKey,
                            java.lang.String teamID,
                            java.lang.String keyID,
                            boolean production,
                            java.lang.String defaultTopic,
                            okhttp3.OkHttpClient.Builder clientBuilder)

Creates a new client which uses token authentication API.

Parameters:

apnsAuthKey - The private key - exclude -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY-----

teamID - The team ID

keyID - The key ID (retrieved from the file name)

production - Whether to use the production endpoint or the sandbox endpoint

defaultTopic - A default topic (can be changed per message)

clientBuilder - An OkHttp client builder, possibly pre-initialized, to build the actual client

SyncOkHttpApnsClient

public SyncOkHttpApnsClient(java.lang.String apnsAuthKey,
                            java.lang.String teamID,
                            java.lang.String keyID,
                            boolean production,
                            java.lang.String defaultTopic,
                            okhttp3.OkHttpClient.Builder clientBuilder,
                            int connectionPort)

Creates a new client which uses token authentication API.

Parameters:

apnsAuthKey - The private key - exclude -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY-----

teamID - The team ID

keyID - The key ID (retrieved from the file name)

production - Whether to use the production endpoint or the sandbox endpoint

defaultTopic - A default topic (can be changed per message)

clientBuilder - An OkHttp client builder, possibly pre-initialized, to build the actual client

connectionPort - The port to establish a connection with APNs. Either 443 or 2197

SyncOkHttpApnsClient

public SyncOkHttpApnsClient(java.lang.String apnsAuthKey,
                            java.lang.String teamID,
                            java.lang.String keyID,
                            boolean production,
                            java.lang.String defaultTopic,
                            okhttp3.ConnectionPool connectionPool)

Creates a new client which uses token authentication API.

Parameters:

apnsAuthKey - The private key - exclude -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY-----

teamID - The team ID

keyID - The key ID (retrieved from the file name)

production - Whether to use the production endpoint or the sandbox endpoint

defaultTopic - A default topic (can be changed per message)

connectionPool - A connection pool to use. If null, a new one will be generated

SyncOkHttpApnsClient

public SyncOkHttpApnsClient(java.io.InputStream certificate,
                            java.lang.String password,
                            boolean production,
                            java.lang.String defaultTopic,
                            okhttp3.OkHttpClient.Builder builder)
                     throws java.security.cert.CertificateException,
                            java.security.NoSuchAlgorithmException,
                            java.security.KeyStoreException,
                            java.io.IOException,
                            java.security.UnrecoverableKeyException,
                            java.security.KeyManagementException

Creates a new client and automatically loads the key store with the push certificate read from the input stream.

Parameters:

certificate - The client certificate to be used

password - The password (if required, else null)

production - Whether to use the production endpoint or the sandbox endpoint

defaultTopic - A default topic (can be changed per message)

builder - An OkHttp client builder, possibly pre-initialized, to build the actual client

Throws:

java.security.UnrecoverableKeyException - If the key cannot be recovered

java.security.KeyManagementException - if the key failed to be loaded

java.security.cert.CertificateException - if any of the certificates in the keystore could not be loaded

java.security.NoSuchAlgorithmException - if the algorithm used to check the integrity of the keystore cannot be found

java.io.IOException - if there is an I/O or format problem with the keystore data, if a password is required but not given, or if the given password was incorrect

java.security.KeyStoreException - if no Provider supports a KeyStoreSpi implementation for the specified type

SyncOkHttpApnsClient

public SyncOkHttpApnsClient(java.io.InputStream certificate,
                            java.lang.String password,
                            boolean production,
                            java.lang.String defaultTopic,
                            okhttp3.OkHttpClient.Builder builder,
                            int connectionPort)
                     throws java.security.cert.CertificateException,
                            java.security.NoSuchAlgorithmException,
                            java.security.KeyStoreException,
                            java.io.IOException,
                            java.security.UnrecoverableKeyException,
                            java.security.KeyManagementException

Creates a new client and automatically loads the key store with the push certificate read from the input stream.

Parameters:

certificate - The client certificate to be used

password - The password (if required, else null)

production - Whether to use the production endpoint or the sandbox endpoint

defaultTopic - A default topic (can be changed per message)

builder - An OkHttp client builder, possibly pre-initialized, to build the actual client

connectionPort - The port to establish a connection with APNs. Either 443 or 2197

Throws:

java.security.UnrecoverableKeyException - If the key cannot be recovered

java.security.KeyManagementException - if the key failed to be loaded

java.security.cert.CertificateException - if any of the certificates in the keystore could not be loaded

java.security.NoSuchAlgorithmException - if the algorithm used to check the integrity of the keystore cannot be found

java.io.IOException - if there is an I/O or format problem with the keystore data, if a password is required but not given, or if the given password was incorrect

java.security.KeyStoreException - if no Provider supports a KeyStoreSpi implementation for the specified type

SyncOkHttpApnsClient

public SyncOkHttpApnsClient(java.io.InputStream certificate,
                            java.lang.String password,
                            boolean production,
                            java.lang.String defaultTopic,
                            okhttp3.ConnectionPool connectionPool)
                     throws java.security.cert.CertificateException,
                            java.security.NoSuchAlgorithmException,
                            java.security.KeyStoreException,
                            java.io.IOException,
                            java.security.UnrecoverableKeyException,
                            java.security.KeyManagementException

Creates a new client and automatically loads the key store with the push certificate read from the input stream.

Parameters:

certificate - The client certificate to be used

password - The password (if required, else null)

production - Whether to use the production endpoint or the sandbox endpoint

defaultTopic - A default topic (can be changed per message)

connectionPool - A connection pool to use. If null, a new one will be generated

Throws:

java.security.UnrecoverableKeyException - If the key cannot be recovered

java.security.KeyManagementException - if the key failed to be loaded

java.security.cert.CertificateException - if any of the certificates in the keystore could not be loaded

java.security.NoSuchAlgorithmException - if the algorithm used to check the integrity of the keystore cannot be found

java.io.IOException - if there is an I/O or format problem with the keystore data, if a password is required but not given, or if the given password was incorrect

java.security.KeyStoreException - if no Provider supports a KeyStoreSpi implementation for the specified type

Method Detail

isSynchronous

public boolean isSynchronous()

Description copied from interface: ApnsClient

Checks whether the client supports synchronous operations.

This is specified when building the client using

Specified by:

isSynchronous in interface ApnsClient

Returns:

Whether the client supports synchronous operations

push

public void push(Notification notification,
                 NotificationResponseListener listener)

Description copied from interface: ApnsClient

Sends a notification asynchronously to the Apple Push Notification Service.

Specified by:

push in interface ApnsClient

Parameters:

notification - The notification built using Notification.Builder

listener - The listener to be called after the request is complete

buildRequest

protected final okhttp3.Request buildRequest(Notification notification)

push

public NotificationResponse push(Notification notification)

Description copied from interface: ApnsClient

Sends a notification synchronously to the Apple Push Notification Service.

Specified by:

push in interface ApnsClient

Parameters:

notification - The notification built using Notification.Builder

Returns:

The notification response

getHttpClient

public okhttp3.OkHttpClient getHttpClient()

Description copied from interface: ApnsClient

Returns the underlying OkHttpClient instance. This can be used for further customizations such as using proxies.

Specified by:

getHttpClient in interface ApnsClient

Returns:

The underlying OkHttpClient instance

parseResponse

protected NotificationResponse parseResponse(okhttp3.Response response)
                                      throws java.io.IOException

Throws:

java.io.IOException