com.pubnub.api

Class PNConfiguration

java.lang.Object

com.pubnub.api.PNConfiguration

public class PNConfiguration
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PNConfiguration() Initialize the PNConfiguration with default values

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthKey()
okhttp3.CertificatePinner	getCertificatePinner()
java.lang.String	getCipherKey()
okhttp3.ConnectionSpec	getConnectionSpec()
int	getConnectTimeout() Stores the maximum number of seconds which the client should wait for connection before timing out.
java.lang.String	getFilterExpression() filterExpression used as part of PSV2 specification.
int	getHeartbeatInterval() In seconds, How often the client should announce it's existence via heartbeating.
PNHeartbeatNotificationOptions	getHeartbeatNotificationOptions() verbosity of heartbeat configuration, by default only alerts on failed heartbeats
javax.net.ssl.HostnameVerifier	getHostnameVerifier()
okhttp3.logging.HttpLoggingInterceptor	getHttpLoggingInterceptor()
PNLogVerbosity	getLogVerbosity() toggle to enable verbose logging.
java.lang.Integer	getMaximumConnections()
java.lang.Integer	getMaximumMessagesCacheSize()
int	getMaximumReconnectionRetries() Set how many times the reconneciton manager will try to connect before giving app
int	getNonSubscribeRequestTimeout() Reference on number of seconds which is used by client during non-subscription operations to check whether response potentially failed with 'timeout' or not.
java.lang.String	getOrigin() By default, the origin is pointing directly to PubNub servers.
int	getPresenceTimeout() In seconds, how long the server will consider this client to be online before issuing a leave event.
java.net.Proxy	getProxy() Proxy configuration which will be passed to the networking layer.
okhttp3.Authenticator	getProxyAuthenticator()
java.net.ProxySelector	getProxySelector()
java.lang.String	getPublishKey() Publish Key provided by PubNub.
PNReconnectionPolicy	getReconnectionPolicy() Reconnection policy which will be used if/when networking goes down
java.lang.Integer	getRequestMessageCountThreshold() if set, the SDK will alert once the number of messages arrived in one call equal to the threshold
java.lang.String	getSecretKey()
javax.net.ssl.SSLSocketFactory	getSslSocketFactory()
java.lang.String	getSubscribeKey() Subscribe Key provided by PubNub
int	getSubscribeTimeout()
java.lang.String	getUuid()
javax.net.ssl.X509ExtendedTrustManager	getX509ExtendedTrustManager()
boolean	isCacheBusting() Deprecated.
boolean	isDedupOnSubscribe()
boolean	isGoogleAppEngineNetworking() Use Google App Engine based networking configuration
boolean	isIncludeInstanceIdentifier() Set to true to send a UUID for PubNub instance
boolean	isIncludeRequestIdentifier() Set to true to send a UUID on each request
boolean	isSecure() set to true to switch the client to HTTPS:// based communications.
boolean	isStartSubscriberThread()
boolean	isSupressLeaveEvents() Supress leave events when a channel gets disconnected
PNConfiguration	setAuthKey(java.lang.String authKey)
PNConfiguration	setCacheBusting(boolean cacheBusting) Deprecated.
PNConfiguration	setCertificatePinner(okhttp3.CertificatePinner certificatePinner)
PNConfiguration	setCipherKey(java.lang.String cipherKey)
PNConfiguration	setConnectionSpec(okhttp3.ConnectionSpec connectionSpec)
PNConfiguration	setConnectTimeout(int connectTimeout) Stores the maximum number of seconds which the client should wait for connection before timing out.
PNConfiguration	setDedupOnSubscribe(boolean dedupOnSubscribe)
PNConfiguration	setFilterExpression(java.lang.String filterExpression) filterExpression used as part of PSV2 specification.
PNConfiguration	setGoogleAppEngineNetworking(boolean googleAppEngineNetworking) Use Google App Engine based networking configuration
PNConfiguration	setHeartbeatNotificationOptions(PNHeartbeatNotificationOptions heartbeatNotificationOptions) verbosity of heartbeat configuration, by default only alerts on failed heartbeats
PNConfiguration	setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)
PNConfiguration	setHttpLoggingInterceptor(okhttp3.logging.HttpLoggingInterceptor httpLoggingInterceptor)
PNConfiguration	setIncludeInstanceIdentifier(boolean includeInstanceIdentifier) Set to true to send a UUID for PubNub instance
PNConfiguration	setIncludeRequestIdentifier(boolean includeRequestIdentifier) Set to true to send a UUID on each request
PNConfiguration	setLogVerbosity(PNLogVerbosity logVerbosity) toggle to enable verbose logging.
PNConfiguration	setMaximumConnections(java.lang.Integer maximumConnections)
PNConfiguration	setMaximumMessagesCacheSize(java.lang.Integer maximumMessagesCacheSize)
PNConfiguration	setMaximumReconnectionRetries(int maximumReconnectionRetries) Set how many times the reconneciton manager will try to connect before giving app
PNConfiguration	setNonSubscribeRequestTimeout(int nonSubscribeRequestTimeout) Reference on number of seconds which is used by client during non-subscription operations to check whether response potentially failed with 'timeout' or not.
PNConfiguration	setOrigin(java.lang.String origin) By default, the origin is pointing directly to PubNub servers.
PNConfiguration	setPresenceTimeout(int timeout) set presence configurations for timeout and allow the client to pick the best interval
PNConfiguration	setPresenceTimeoutWithCustomInterval(int timeout, int interval) set presence configurations for timeout and announce interval.
PNConfiguration	setProxy(java.net.Proxy proxy) Proxy configuration which will be passed to the networking layer.
PNConfiguration	setProxyAuthenticator(okhttp3.Authenticator proxyAuthenticator)
PNConfiguration	setProxySelector(java.net.ProxySelector proxySelector)
PNConfiguration	setPublishKey(java.lang.String publishKey) Publish Key provided by PubNub.
PNConfiguration	setReconnectionPolicy(PNReconnectionPolicy reconnectionPolicy) Reconnection policy which will be used if/when networking goes down
PNConfiguration	setRequestMessageCountThreshold(java.lang.Integer requestMessageCountThreshold) if set, the SDK will alert once the number of messages arrived in one call equal to the threshold
PNConfiguration	setSecretKey(java.lang.String secretKey)
PNConfiguration	setSecure(boolean secure) set to true to switch the client to HTTPS:// based communications.
PNConfiguration	setSslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)
PNConfiguration	setStartSubscriberThread(boolean startSubscriberThread)
PNConfiguration	setSubscribeKey(java.lang.String subscribeKey) Subscribe Key provided by PubNub
PNConfiguration	setSubscribeTimeout(int subscribeTimeout)
PNConfiguration	setSupressLeaveEvents(boolean supressLeaveEvents) Supress leave events when a channel gets disconnected
PNConfiguration	setUuid(java.lang.String uuid)
PNConfiguration	setX509ExtendedTrustManager(javax.net.ssl.X509ExtendedTrustManager x509ExtendedTrustManager)

Methods inherited from class java.lang.Object

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

Constructor Detail

PNConfiguration

public PNConfiguration()

Initialize the PNConfiguration with default values

Method Detail

setPresenceTimeoutWithCustomInterval

public PNConfiguration setPresenceTimeoutWithCustomInterval(int timeout,
                                                            int interval)

set presence configurations for timeout and announce interval.

Parameters:

timeout - presence timeout; how long before the server considers this client to be gone.

interval - presence announce interval, how often the client should announce itself.

Returns:

returns itself.

setPresenceTimeout

public PNConfiguration setPresenceTimeout(int timeout)

set presence configurations for timeout and allow the client to pick the best interval

Parameters:

timeout - presence timeout; how long before the server considers this client to be gone.

Returns:

returns itself.

getOrigin

@Generated(value="lombok")
public java.lang.String getOrigin()

By default, the origin is pointing directly to PubNub servers. If a proxy origin is needed, set a custom origin using this parameter.

getSubscribeTimeout

@Generated(value="lombok")
public int getSubscribeTimeout()

getPresenceTimeout

@Generated(value="lombok")
public int getPresenceTimeout()

In seconds, how long the server will consider this client to be online before issuing a leave event.

getHeartbeatInterval

@Generated(value="lombok")
public int getHeartbeatInterval()

In seconds, How often the client should announce it's existence via heartbeating.

isSecure

@Generated(value="lombok")
public boolean isSecure()

set to true to switch the client to HTTPS:// based communications.

getSubscribeKey

@Generated(value="lombok")
public java.lang.String getSubscribeKey()

Subscribe Key provided by PubNub

getPublishKey

@Generated(value="lombok")
public java.lang.String getPublishKey()

Publish Key provided by PubNub.

getSecretKey

@Generated(value="lombok")
public java.lang.String getSecretKey()

getCipherKey

@Generated(value="lombok")
public java.lang.String getCipherKey()

getAuthKey

@Generated(value="lombok")
public java.lang.String getAuthKey()

getUuid

@Generated(value="lombok")
public java.lang.String getUuid()

isCacheBusting

@Deprecated
 @Generated(value="lombok")
public boolean isCacheBusting()

Deprecated.

If proxies are forcefully caching requests, set to true to allow the client to randomize the subdomain. This configuration is not supported if custom origin is enabled.

getLogVerbosity

@Generated(value="lombok")
public PNLogVerbosity getLogVerbosity()

toggle to enable verbose logging.

getConnectTimeout

@Generated(value="lombok")
public int getConnectTimeout()

Stores the maximum number of seconds which the client should wait for connection before timing out.

getNonSubscribeRequestTimeout

@Generated(value="lombok")
public int getNonSubscribeRequestTimeout()

Reference on number of seconds which is used by client during non-subscription operations to check whether response potentially failed with 'timeout' or not.

isSupressLeaveEvents

@Generated(value="lombok")
public boolean isSupressLeaveEvents()

Supress leave events when a channel gets disconnected

getHeartbeatNotificationOptions

@Generated(value="lombok")
public PNHeartbeatNotificationOptions getHeartbeatNotificationOptions()

verbosity of heartbeat configuration, by default only alerts on failed heartbeats

getFilterExpression

@Generated(value="lombok")
public java.lang.String getFilterExpression()

filterExpression used as part of PSV2 specification.

getReconnectionPolicy

@Generated(value="lombok")
public PNReconnectionPolicy getReconnectionPolicy()

Reconnection policy which will be used if/when networking goes down

getMaximumReconnectionRetries

@Generated(value="lombok")
public int getMaximumReconnectionRetries()

Set how many times the reconneciton manager will try to connect before giving app

getProxy

@Generated(value="lombok")
public java.net.Proxy getProxy()

Proxy configuration which will be passed to the networking layer.

getProxySelector

@Generated(value="lombok")
public java.net.ProxySelector getProxySelector()

getProxyAuthenticator

@Generated(value="lombok")
public okhttp3.Authenticator getProxyAuthenticator()

getCertificatePinner

@Generated(value="lombok")
public okhttp3.CertificatePinner getCertificatePinner()

getMaximumConnections

@Generated(value="lombok")
public java.lang.Integer getMaximumConnections()

getHttpLoggingInterceptor

@Generated(value="lombok")
public okhttp3.logging.HttpLoggingInterceptor getHttpLoggingInterceptor()

getRequestMessageCountThreshold

@Generated(value="lombok")
public java.lang.Integer getRequestMessageCountThreshold()

if set, the SDK will alert once the number of messages arrived in one call equal to the threshold

isGoogleAppEngineNetworking

@Generated(value="lombok")
public boolean isGoogleAppEngineNetworking()

Use Google App Engine based networking configuration

isStartSubscriberThread

@Generated(value="lombok")
public boolean isStartSubscriberThread()

isDedupOnSubscribe

@Generated(value="lombok")
public boolean isDedupOnSubscribe()

getMaximumMessagesCacheSize

@Generated(value="lombok")
public java.lang.Integer getMaximumMessagesCacheSize()

setSslSocketFactory

@Generated(value="lombok")
public PNConfiguration setSslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)

setX509ExtendedTrustManager

@Generated(value="lombok")
public PNConfiguration setX509ExtendedTrustManager(javax.net.ssl.X509ExtendedTrustManager x509ExtendedTrustManager)

setConnectionSpec

@Generated(value="lombok")
public PNConfiguration setConnectionSpec(okhttp3.ConnectionSpec connectionSpec)

setHostnameVerifier

@Generated(value="lombok")
public PNConfiguration setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)

setIncludeInstanceIdentifier

@Generated(value="lombok")
public PNConfiguration setIncludeInstanceIdentifier(boolean includeInstanceIdentifier)

Set to true to send a UUID for PubNub instance

Returns:

this

setIncludeRequestIdentifier

@Generated(value="lombok")
public PNConfiguration setIncludeRequestIdentifier(boolean includeRequestIdentifier)

Set to true to send a UUID on each request

Returns:

this

setOrigin

@Generated(value="lombok")
public PNConfiguration setOrigin(java.lang.String origin)

By default, the origin is pointing directly to PubNub servers. If a proxy origin is needed, set a custom origin using this parameter.

Returns:

this

setSubscribeTimeout

@Generated(value="lombok")
public PNConfiguration setSubscribeTimeout(int subscribeTimeout)

setSecure

@Generated(value="lombok")
public PNConfiguration setSecure(boolean secure)

set to true to switch the client to HTTPS:// based communications.

Returns:

this

setSubscribeKey

@Generated(value="lombok")
public PNConfiguration setSubscribeKey(java.lang.String subscribeKey)

Subscribe Key provided by PubNub

Returns:

this

setPublishKey

@Generated(value="lombok")
public PNConfiguration setPublishKey(java.lang.String publishKey)

Publish Key provided by PubNub.

Returns:

this

setSecretKey

@Generated(value="lombok")
public PNConfiguration setSecretKey(java.lang.String secretKey)

setCipherKey

@Generated(value="lombok")
public PNConfiguration setCipherKey(java.lang.String cipherKey)

setAuthKey

@Generated(value="lombok")
public PNConfiguration setAuthKey(java.lang.String authKey)

setUuid

@Generated(value="lombok")
public PNConfiguration setUuid(java.lang.String uuid)

setCacheBusting

@Deprecated
 @Generated(value="lombok")
public PNConfiguration setCacheBusting(boolean cacheBusting)

Deprecated.

If proxies are forcefully caching requests, set to true to allow the client to randomize the subdomain. This configuration is not supported if custom origin is enabled.

Returns:

this

setLogVerbosity

@Generated(value="lombok")
public PNConfiguration setLogVerbosity(PNLogVerbosity logVerbosity)

toggle to enable verbose logging.

Returns:

this

setConnectTimeout

@Generated(value="lombok")
public PNConfiguration setConnectTimeout(int connectTimeout)

Stores the maximum number of seconds which the client should wait for connection before timing out.

Returns:

this

setNonSubscribeRequestTimeout

@Generated(value="lombok")
public PNConfiguration setNonSubscribeRequestTimeout(int nonSubscribeRequestTimeout)

Reference on number of seconds which is used by client during non-subscription operations to check whether response potentially failed with 'timeout' or not.

Returns:

this

setSupressLeaveEvents

@Generated(value="lombok")
public PNConfiguration setSupressLeaveEvents(boolean supressLeaveEvents)

Supress leave events when a channel gets disconnected

Returns:

this

setHeartbeatNotificationOptions

@Generated(value="lombok")
public PNConfiguration setHeartbeatNotificationOptions(PNHeartbeatNotificationOptions heartbeatNotificationOptions)

verbosity of heartbeat configuration, by default only alerts on failed heartbeats

Returns:

this

setRequestMessageCountThreshold

@Generated(value="lombok")
public PNConfiguration setRequestMessageCountThreshold(java.lang.Integer requestMessageCountThreshold)

if set, the SDK will alert once the number of messages arrived in one call equal to the threshold

Returns:

this

getSslSocketFactory

@Generated(value="lombok")
public javax.net.ssl.SSLSocketFactory getSslSocketFactory()

getX509ExtendedTrustManager

@Generated(value="lombok")
public javax.net.ssl.X509ExtendedTrustManager getX509ExtendedTrustManager()

getConnectionSpec

@Generated(value="lombok")
public okhttp3.ConnectionSpec getConnectionSpec()

getHostnameVerifier

@Generated(value="lombok")
public javax.net.ssl.HostnameVerifier getHostnameVerifier()

isIncludeInstanceIdentifier

@Generated(value="lombok")
public boolean isIncludeInstanceIdentifier()

Set to true to send a UUID for PubNub instance

isIncludeRequestIdentifier

@Generated(value="lombok")
public boolean isIncludeRequestIdentifier()

Set to true to send a UUID on each request

setFilterExpression

@Generated(value="lombok")
public PNConfiguration setFilterExpression(java.lang.String filterExpression)

filterExpression used as part of PSV2 specification.

Returns:

this

setReconnectionPolicy

@Generated(value="lombok")
public PNConfiguration setReconnectionPolicy(PNReconnectionPolicy reconnectionPolicy)

Reconnection policy which will be used if/when networking goes down

Returns:

this

setMaximumReconnectionRetries

@Generated(value="lombok")
public PNConfiguration setMaximumReconnectionRetries(int maximumReconnectionRetries)

Set how many times the reconneciton manager will try to connect before giving app

Returns:

this

setProxy

@Generated(value="lombok")
public PNConfiguration setProxy(java.net.Proxy proxy)

Proxy configuration which will be passed to the networking layer.

Returns:

this

setProxySelector

@Generated(value="lombok")
public PNConfiguration setProxySelector(java.net.ProxySelector proxySelector)

setProxyAuthenticator

@Generated(value="lombok")
public PNConfiguration setProxyAuthenticator(okhttp3.Authenticator proxyAuthenticator)

setCertificatePinner

@Generated(value="lombok")
public PNConfiguration setCertificatePinner(okhttp3.CertificatePinner certificatePinner)

setMaximumConnections

@Generated(value="lombok")
public PNConfiguration setMaximumConnections(java.lang.Integer maximumConnections)

setHttpLoggingInterceptor

@Generated(value="lombok")
public PNConfiguration setHttpLoggingInterceptor(okhttp3.logging.HttpLoggingInterceptor httpLoggingInterceptor)

setGoogleAppEngineNetworking

@Generated(value="lombok")
public PNConfiguration setGoogleAppEngineNetworking(boolean googleAppEngineNetworking)

Use Google App Engine based networking configuration

Returns:

this

setStartSubscriberThread

@Generated(value="lombok")
public PNConfiguration setStartSubscriberThread(boolean startSubscriberThread)

setDedupOnSubscribe

@Generated(value="lombok")
public PNConfiguration setDedupOnSubscribe(boolean dedupOnSubscribe)

setMaximumMessagesCacheSize

@Generated(value="lombok")
public PNConfiguration setMaximumMessagesCacheSize(java.lang.Integer maximumMessagesCacheSize)