com.clevertap.apns.clients

Class ApnsClientBuilder

java.lang.Object

com.clevertap.apns.clients.ApnsClientBuilder

public class ApnsClientBuilder
extends java.lang.Object

A builder to build an APNS client.

Constructor Summary

Constructors

Constructor and Description
ApnsClientBuilder()

Method Summary

Modifier and Type	Method and Description
ApnsClient	build()
static okhttp3.OkHttpClient.Builder	createDefaultOkHttpClientBuilder() Creates a default OkHttp client builder that can be customized later and then passed to one of the constructors taking a builder instance.
ApnsClientBuilder	inAsynchronousMode()
ApnsClientBuilder	inSynchronousMode()
ApnsClientBuilder	withApnsAuthKey(java.lang.String apnsAuthKey)
ApnsClientBuilder	withCertificate(java.io.InputStream inputStream)
ApnsClientBuilder	withConnectionPool(okhttp3.ConnectionPool connectionPool)
ApnsClientBuilder	withDefaultTopic(java.lang.String defaultTopic)
ApnsClientBuilder	withDevelopmentGateway()
ApnsClientBuilder	withKeyID(java.lang.String keyID)
ApnsClientBuilder	withOkHttpClientBuilder(okhttp3.OkHttpClient.Builder clientBuilder) Replaces the default OkHttp client builder with this one.
ApnsClientBuilder	withPassword(java.lang.String password)
ApnsClientBuilder	withPort(int port) APNs supports connections over ports 443 and 2197.
ApnsClientBuilder	withProductionGateway()
ApnsClientBuilder	withProductionGateway(boolean production)
ApnsClientBuilder	withTeamID(java.lang.String teamID)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApnsClientBuilder

public ApnsClientBuilder()

Method Detail

createDefaultOkHttpClientBuilder

public static okhttp3.OkHttpClient.Builder createDefaultOkHttpClientBuilder()

Creates a default OkHttp client builder that can be customized later and then passed to one of the constructors taking a builder instance. The constructors that don't take builders themselves use this method internally to create their client builders. Note: The returned Builder also has a default connection pool configured. You can replace that pool by calling OkHttpClient.Builder.connectionPool(okhttp3.ConnectionPool).

Returns:

a new OkHttp client builder, intialized with default settings.

withOkHttpClientBuilder

public ApnsClientBuilder withOkHttpClientBuilder(okhttp3.OkHttpClient.Builder clientBuilder)

Replaces the default OkHttp client builder with this one. The default builder is created internally with createDefaultOkHttpClientBuilder(). A custom builder can also be created by calling that method explicitly, customizing the builder and then passing it to this method.

Parameters:

clientBuilder - An existing OkHttp client builder to be used as the base

Returns:

this object

withPort

public ApnsClientBuilder withPort(int port)

APNs supports connections over ports 443 and 2197.

Parameters:

port - Either 443 or 2197

Returns:

the builder

withConnectionPool

public ApnsClientBuilder withConnectionPool(okhttp3.ConnectionPool connectionPool)

withCertificate

public ApnsClientBuilder withCertificate(java.io.InputStream inputStream)

withPassword

public ApnsClientBuilder withPassword(java.lang.String password)

withApnsAuthKey

public ApnsClientBuilder withApnsAuthKey(java.lang.String apnsAuthKey)

withTeamID

public ApnsClientBuilder withTeamID(java.lang.String teamID)

withKeyID

public ApnsClientBuilder withKeyID(java.lang.String keyID)

withProductionGateway

public ApnsClientBuilder withProductionGateway()

withProductionGateway

public ApnsClientBuilder withProductionGateway(boolean production)

withDevelopmentGateway

public ApnsClientBuilder withDevelopmentGateway()

inSynchronousMode

public ApnsClientBuilder inSynchronousMode()

inAsynchronousMode

public ApnsClientBuilder inAsynchronousMode()

withDefaultTopic

public ApnsClientBuilder withDefaultTopic(java.lang.String defaultTopic)

build

public ApnsClient build()
                 throws java.security.cert.CertificateException,
                        java.security.NoSuchAlgorithmException,
                        java.security.KeyStoreException,
                        java.io.IOException,
                        java.security.UnrecoverableKeyException,
                        java.security.KeyManagementException

Throws:

java.security.cert.CertificateException

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.io.IOException

java.security.UnrecoverableKeyException

java.security.KeyManagementException