net.rim.pushsdk.commons
Class PushSDKPropertiesImpl

java.lang.Object
  net.rim.pushsdk.commons.PushSDKPropertiesImpl

All Implemented Interfaces:

PushSDKProperties

public class PushSDKPropertiesImpl
extends Object
implements PushSDKProperties

Default implementation of the PushSDKProperties interface.

Uses DefaultPropertyStore by default, which can be overridden by calling setPropertyStore(PropertyStore).

Dependencies that must be injected to properly initialize this object for use:
- propertyStore

Author:

mdicesare

Field Summary
static String	ACKNOWLEDGEMENT_BATCH_SIZE The max.
static String	ACKNOWLEDGEMENT_MAX_QUEUE_SIZE The max.
static String	ACKNOWLEDGEMENT_MAX_THREADS The max.
static String	ACKNOWLEDGEMENT_PUSH_LOOKUP_RETRY_DELAY Time in milliseconds to delay, after looking up and not finding the push request detail that corresponds to a result notification, before retrying the lookup.
static String	DATABASE_TYPE Gets the type of database that the SDK is working with.
static String	DEFAULT_DELIVER_BEFORE_TIMESTAMP_OFFSET The default deliver before timestamp offset in milliseconds.
static String	DTD_DECLARATION_ENTERPRISE DTD declaration used when constructing XML to send to the enterprise (BES) PPG.
static String	DTD_DECLARATION_PUBLIC DTD declaration used when constructing XML to send to the public (BIS) PPG.
static String	ENTERPRISE_PPG_ADDRESS Push submission URL of the enterprise (BES) central push server.
static String	HTTP_CONNECTION_TIMEOUT The connection timeout for the HTTP client.
static String	HTTP_IS_PERSISTENT_TIMEOUT Whether persistent connections are used by the HTTP client.
static String	HTTP_READ_TIMEOUT The read timeout for the HTTP client.
static String	MAX_IN_CLAUSE_VALUES The max.
static String	PARSER_SPECIAL_CHARACTERS List of parser special characters that should be avoided when specifying values of PAP message elements.
static String	PPG_ADDRESS Deprecated. As of release 1.1, use PUBLIC_PPG_ADDRESS or ENTERPRISE_PPG_ADDRESS instead.
static String	PUBLIC_PPG_ADDRESS Push submission URL of the public (BIS) push server.
static String	PUSH_REQUEST_DETAIL_FIND_MAX_RESULTS The max.
static String	PUSH_STATS_UPDATE_FREQUENCY The time frequency (in seconds) with which push statistics are updated.
static String	PUSH_STATS_UPDATE_QUEUESIZE The maximum size of the queue used in batch updating of push statistics.
static String	PUSHAPP_DELETE_UNSUBSCRIBE_QUEUESIZE The size of the queue to use for unsubscribes when performing a hard delete of a push application.
static String	PUSHAPP_DELETE_UNSUBSCRIBE_TIMEOUT The timeout to use for unsubscribes when performing a hard delete of a push application.
static String	PUSHAPP_SUBSCRIBER_DELETE_TIMEOUT The timeout to use for deletion of subscribers when performing a hard delete of a push application.
static String	REGENERATE_PUSHID_MAX_ATTEMPTS The max.
static String	SUBSCRIPTION_DEREGISTRATION_URL The subscriber deregistration URL for public (BIS) pushes.
static String	SUBSCRIPTION_MATCHING_MAX_THREADS The max.
static String	SUBSCRIPTION_MATCHING_QUEUESIZE The size of the queue to use for subscription validation/matching.
static String	SUBSCRIPTION_PPG_SYNC_BATCHSIZE The size of the batch to use for subscription status syncing with the PPG.
static String	SUBSCRIPTION_PPG_SYNC_MAX_THREADS The max.
static String	SUBSCRIPTION_PPG_SYNC_QUEUESIZE The size of the queue to use for subscription status syncing with the PPG.
static String	SUBSCRIPTION_PPG_SYNC_TIMEOUT The timeout to use for subscription status syncing with the PPG.
static String	SUBSCRIPTION_QUERY_URL The subscription query URL for public (BIS) pushes.
static String	SUBSCRIPTION_RESUME_URL The resume subscription URL for public (BIS) pushes.
static String	SUBSCRIPTION_SUSPEND_URL The suspend subscription URL for public (BIS) pushes.
static String	SUBSCRIPTION_VALIDATION_BATCH_SIZE The number of subscribers to load at once from the database to validate.
static String	SUBSCRIPTION_VALIDATION_HIGH_WATER_MARK When the number of subscribers to validate are below this water mark ,an optimized query for a small number of subscribers will be used.
static String	SUSBSCRIPTION_FIND_MAX_RESULTS The max.
static String	USE_PUBLIC_PUSH Deprecated. As of release 1.1, replaced by PapControl.isUsingPublicPush() if using the low-level PAP APIs, and PushApplication.getType() or SubscriberPartial.getType() if using the high-level APIs.
static String	WEBSIGNALS_DEREGISTRATION_URL The URL for Web Signals deregistration (unsubscribe) on the PPG.
static String	WEBSIGNALS_REGISTRATION_URL The URL for Web Signals registration on the PPG.
static String	WEBSIGNALS_RESUME_URL The URL for Web Signals resume on the PPG.
static String	WEBSIGNALS_SUSPEND_URL The URL for Web Signals suspend on the PPG.

Constructor Summary

PushSDKPropertiesImpl()

Method Summary
int	getAcknowledgementBatchSize() Gets the maximum number of result notifications in a batch for processing.
int	getAcknowledgementMaxQueueSize() Gets the maximum size of the result notification queue before it starts rejecting new notifications.
int	getAcknowledgementMaxThreads() Gets the maximum number of threads for processing the result notification queue and notifying listeners.
int	getAcknowledgementPushLookupRetryDelay() Gets the time in milliseconds to delay, after looking up and not finding the push request detail that corresponds to a result notification, before retrying the lookup.
String	getDatabaseType() Gets the type of database that the SDK is working with.
long	getDefaultDeliverBeforeTimestampOffset() Gets the default deliver before timestamp offset.
String	getDtdDeclarationEnterprise() Returns the DTD declaration to use when constructing XML to send to the enterprise (BES) PPG (this property is not related to parsing XML sent from the PPG).
String	getDtdDeclarationPublic() Returns the DTD declaration to use when constructing XML to send to the public (BIS) PPG (this property is not related to parsing XML sent from the PPG).
String	getEnterprisePpgAddress() Gets the push submission URL of the enterprise (BES) PPG.
int	getHttpConnectionTimeout() Gets the connection timeout for the HTTP client in milliseconds.
boolean	getHttpIsPersistent() Gets whether persistent connections are used by the HTTP client.
int	getHttpReadTimeout() Gets the read timeout for the HTTP client in milliseconds.
int	getMaxInClauseValues() Gets the maximum number of SQL IN clause parameters allowed by the DB implementation being used (e.g.
char[]	getParserSpecialCharacters() Gets the parser special characters that should be avoided when specifying values of PAP message elements.
String	getPpgAddress() Deprecated.
String	getPublicPpgAddress() Gets the push submission URL of the public (BIS) PPG.
int	getPushAppDeleteUnsubscribeQueueSize() Gets the size of the queue for unsubscribes performed for a hard application delete.
int	getPushAppDeleteUnsubscribeTimeout() Gets the timeout (in minutes) for unsubscribes performed for a hard application delete.
int	getPushAppSubscriberDeleteTimeout() Gets the timeout (in minutes) for subscriber deletions performed for a hard application delete.
int	getPushRequestDetailFindMaxResults() Gets the max.
int	getPushStatsUpdateFrequency() Gets the time frequency (in seconds) with which push statistics are updated.
int	getPushStatsUpdateQueueSize() Gets the maximum size of the queue used in batch updating of push statistics.
int	getRegeneratePushIdMaxAttempts() Gets the maximum number of attempts to generate unique push ids before giving up.
String	getSubscriptionDeregistrationUrl() Gets the subscriber deregistration URL for public (BIS) pushes.
int	getSubscriptionFindMaxResults() Gets the maximum number of results returned by a subscriber find operation.
int	getSubscriptionMatchingMaxThreads() Gets the maximum number of threads to use for subscription matching (used in subscription validation).
int	getSubscriptionMatchingQueueSize() Gets the size of the queue for large subscription validation/subscription matching.
int	getSubscriptionPPGSyncBatchSize() Gets the size of the batches for syncing subscription statuses with the PPG.
int	getSubscriptionPPGSyncMaxThreads() Gets the maximum number of threads to use in syncing subscription statuses with the PPG.
int	getSubscriptionPPGSyncQueueSize() Gets the size of the queue used in syncing subscription statuses with the PPG.
int	getSubscriptionPPGSyncTimeout() Gets the timeout (in minutes) used in syncing subscription statuses with the PPG.
String	getSubscriptionQueryUrl() Gets the URL associated with subscription status queries for public (BIS) pushes.
String	getSubscriptionResumeUrl() Gets the resume subscription URL for public (BIS) pushes.
String	getSubscriptionSuspendUrl() Gets the suspend subscription URL for public (BIS) pushes.
int	getSubscriptionValidationBatchSize() Gets the number of subscribers to load at once from the database to validate.
int	getSubscriptionValidationHighWaterMark() Gets the subscription validation high water mark.
String	getWebsignalsDeregistrationUrl() Gets the subscriber deregistration URL for Web Signals.
String	getWebsignalsRegistrationUrl() Gets the Web Signals registration URL (a PPG URL).
String	getWebsignalsResumeUrl() Gets the resume subscription URL for Web Signals.
String	getWebsignalsSuspendUrl() Gets the suspend subscription URL for Web Signals.
boolean	isUsingPublicPush() Deprecated.
boolean	isUsingXmlParserDtdValidation() Deprecated.
void	setAcknowledgementBatchSize(int value) Sets the maximum number of result notifications in a batch for processing.
void	setAcknowledgementMaxQueueSize(int value) Sets the maximum size of the result notification queue before it starts rejecting new notifications.
void	setAcknowledgementMaxThreads(int value) Sets the maximum number of threads for processing the result notification queue and notifying listeners.
void	setAcknowledgementPushLookupRetryDelay(int value) Sets the time in milliseconds to delay, after looking up and not finding the push request detail that corresponds to a result notification, before retrying the lookup.
void	setDatabaseType(String value) Sets the type of database that the SDK is working with.
void	setDefaultDeliverBeforeTimestampOffset(long value) Sets the default deliver before timestamp offset.
void	setDtdDeclarationEnterprise(String value) Sets the DTD declaration to use when constructing XML to send to the enterprise (BES) PPG (this property is not related to parsing XML sent from the PPG).
void	setDtdDeclarationPublic(String value) Sets the DTD declaration to use when constructing XML to send to the public (BIS) PPG (this property is not related to parsing XML sent from the PPG).
void	setEnterprisePpgAddress(String value) Sets the push submission URL of the enterprise (BES) PPG.
void	setHttpConnectionTimeout(int value) Sets the connection timeout for the HTTP client in milliseconds.
void	setHttpIsPersistent(boolean value) Sets whether persistent connections are used by the HTTP client.
void	setHttpReadTimeout(int value) Sets the read timeout for the HTTP client in milliseconds.
void	setMaxInClauseValues(int value) Sets the maximum number of SQL IN clause parameters allowed by the DB implementation being used (e.g.
void	setParserSpecialCharacters(char[] value) Sets the parser special characters that should be avoided when specifying values of PAP message elements.
void	setPpgAddress(String value) Deprecated.
void	setPropertyStore(PropertyStore propertyStore) Sets the property store to be used with the push SDK properties.
void	setPublicPpgAddress(String value) Sets the push submission URL of the public (BIS) PPG.
void	setPushAppDeleteUnsubscribeQueueSize(int size) Sets the size of the queue for unsubscribes performed for a hard application delete.
void	setPushAppDeleteUnsubscribeTimeout(int timeout) Sets the timeout (in minutes) for unsubscribes performed for a hard application delete.
void	setPushAppSubscriberDeleteTimeout(int timeout) Sets the timeout (in minutes) for subscriber deletions performed for a hard application delete.
void	setPushRequestDetailFindMaxResults(int value) Sets the max.
void	setPushStatsUpdateFrequency(int value) Sets the time frequency (in seconds) with which push statistics are updated.
void	setPushStatsUpdateQueueSize(int value) Sets the maximum size of the queue used in batch updating of push statistics.
void	setRegeneratePushIdMaxAttempts(int value) Sets the maximum number of attempts to generate unique push ids before giving up.
void	setSubscriptionDeregistrationUrl(String value) Sets the subscriber deregistration URL for public (BIS) pushes.
void	setSubscriptionFindMaxResults(int value) Sets the maximum number of results returned by a subscriber find operation.
void	setSubscriptionMatchingMaxThreads(int value) Sets the maximum number of threads to use for subscription matching (used in subscription validation).
void	setSubscriptionMatchingQueueSize(int size) Sets the size of the queue for large subscription validation/subscription matching.
void	setSubscriptionPPGSyncBatchSize(int size) Sets the size of the batches for syncing subscription statuses with the PPG.
void	setSubscriptionPPGSyncMaxThreads(int value) Sets the maximum number of threads to use in syncing subscription statuses with the PPG.
void	setSubscriptionPPGSyncQueueSize(int size) Sets the size of the queue used in syncing subscription statuses with the PPG.
void	setSubscriptionPPGSyncTimeout(int timeout) Sets the timeout (in minutes) used in syncing subscription statuses with the PPG.
void	setSubscriptionQueryUrl(String url) Sets the URL associated with subscription status queries for public (BIS) pushes.
void	setSubscriptionResumeUrl(String value) Sets the resume subscription URL for public (BIS) pushes.
void	setSubscriptionSuspendUrl(String value) Sets the suspend subscription URL for public (BIS) pushes.
void	setSubscriptionValidationBatchSize(int value) Sets the number of subscribers to load at once from the database to validate.
void	setSubscriptionValidationHighWaterMark(int value) Sets the subscription validation high water mark.
void	setUsingPublicPush(boolean value) Deprecated.
void	setUsingXmlParserDtdValidation(boolean value) Deprecated.
void	setWebsignalsDeregistrationUrl(String value) Sets the subscriber deregistration URL for Web Signals.
void	setWebsignalsRegistrationUrl(String websignalsRegistrationUrl) Sets the Web Signals registration URL (a PPG URL).
void	setWebsignalsResumeUrl(String value) Sets the resume subscription URL for Web Signals.
void	setWebsignalsSuspendUrl(String value) Sets the suspend subscription URL for Web Signals.

Methods inherited from class java.lang.Object

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

Field Detail

REGENERATE_PUSHID_MAX_ATTEMPTS

public static final String REGENERATE_PUSHID_MAX_ATTEMPTS

The max. number of attempts to generate unique push ids for.

See Also:

Constant Field Values

DEFAULT_DELIVER_BEFORE_TIMESTAMP_OFFSET

public static final String DEFAULT_DELIVER_BEFORE_TIMESTAMP_OFFSET

The default deliver before timestamp offset in milliseconds.

See Also:

Constant Field Values

PARSER_SPECIAL_CHARACTERS

public static final String PARSER_SPECIAL_CHARACTERS

List of parser special characters that should be avoided when specifying values of PAP message elements.

See Also:

Constant Field Values

MAX_IN_CLAUSE_VALUES

public static final String MAX_IN_CLAUSE_VALUES

The max. number of SQL IN clause parameters.

See Also:

Constant Field Values

USE_PUBLIC_PUSH

public static final String USE_PUBLIC_PUSH

Deprecated. As of release 1.1, replaced by PapControl.isUsingPublicPush() if using the low-level PAP APIs, and PushApplication.getType() or SubscriberPartial.getType() if using the high-level APIs.

Whether or not to use a public (BIS) push (as opposed to an enterprise (BES) push).

See Also:

Constant Field Values

PPG_ADDRESS

public static final String PPG_ADDRESS

Deprecated. As of release 1.1, use PUBLIC_PPG_ADDRESS or ENTERPRISE_PPG_ADDRESS instead.

The push submission URL of the PPG.

See Also:

Constant Field Values

PUBLIC_PPG_ADDRESS

public static final String PUBLIC_PPG_ADDRESS

Push submission URL of the public (BIS) push server. If you are not using the public (BIS) server, this value will not be used.

See Also:

Constant Field Values

ENTERPRISE_PPG_ADDRESS

public static final String ENTERPRISE_PPG_ADDRESS

Push submission URL of the enterprise (BES) central push server. If you are not using the enterprise (BES) server, this value will not be used.

See Also:

Constant Field Values

ACKNOWLEDGEMENT_MAX_QUEUE_SIZE

public static final String ACKNOWLEDGEMENT_MAX_QUEUE_SIZE

The max. size of the result notification queue before it starts rejecting new notifications.

See Also:

Constant Field Values

ACKNOWLEDGEMENT_MAX_THREADS

public static final String ACKNOWLEDGEMENT_MAX_THREADS

The max. number of threads processing the result notification queue and notifying listeners.

See Also:

Constant Field Values

ACKNOWLEDGEMENT_BATCH_SIZE

public static final String ACKNOWLEDGEMENT_BATCH_SIZE

The max. number of result notifications in a batch for processing.

See Also:

Constant Field Values

ACKNOWLEDGEMENT_PUSH_LOOKUP_RETRY_DELAY

public static final String ACKNOWLEDGEMENT_PUSH_LOOKUP_RETRY_DELAY

Time in milliseconds to delay, after looking up and not finding the push request detail that corresponds to a result notification, before retrying the lookup. This property is needed for the case where the result notification has come back before the push request detail has been committed to storage. Note: This property only applies to push applications that have the "store push requests" flag set to true.

See Also:

Constant Field Values

SUBSCRIPTION_VALIDATION_HIGH_WATER_MARK

public static final String SUBSCRIPTION_VALIDATION_HIGH_WATER_MARK

When the number of subscribers to validate are below this water mark ,an optimized query for a small number of subscribers will be used. Conversely, when above this number, a second optimized query for a large number of subscribers will be used.

See Also:

Constant Field Values

SUBSCRIPTION_VALIDATION_BATCH_SIZE

public static final String SUBSCRIPTION_VALIDATION_BATCH_SIZE

The number of subscribers to load at once from the database to validate.

See Also:

Constant Field Values

SUBSCRIPTION_DEREGISTRATION_URL

public static final String SUBSCRIPTION_DEREGISTRATION_URL

The subscriber deregistration URL for public (BIS) pushes.

See Also:

Constant Field Values

SUBSCRIPTION_SUSPEND_URL

public static final String SUBSCRIPTION_SUSPEND_URL

The suspend subscription URL for public (BIS) pushes.

See Also:

Constant Field Values

SUBSCRIPTION_RESUME_URL

public static final String SUBSCRIPTION_RESUME_URL

The resume subscription URL for public (BIS) pushes.

See Also:

Constant Field Values

SUBSCRIPTION_MATCHING_MAX_THREADS

public static final String SUBSCRIPTION_MATCHING_MAX_THREADS

The max. number of threads to use for subscription matching.

See Also:

Constant Field Values

SUSBSCRIPTION_FIND_MAX_RESULTS

public static final String SUSBSCRIPTION_FIND_MAX_RESULTS

The max. number of results returned by a subscriber find operation.

See Also:

Constant Field Values

PUSH_REQUEST_DETAIL_FIND_MAX_RESULTS

public static final String PUSH_REQUEST_DETAIL_FIND_MAX_RESULTS

The max. number of results returned by a push request detail find operation.

See Also:

Constant Field Values

DATABASE_TYPE

public static final String DATABASE_TYPE

Gets the type of database that the SDK is working with. The options are: mysql, oracle.

See Also:

Constant Field Values

DTD_DECLARATION_PUBLIC

public static final String DTD_DECLARATION_PUBLIC

DTD declaration used when constructing XML to send to the public (BIS) PPG.

See Also:

Constant Field Values

DTD_DECLARATION_ENTERPRISE

public static final String DTD_DECLARATION_ENTERPRISE

DTD declaration used when constructing XML to send to the enterprise (BES) PPG.

See Also:

Constant Field Values

HTTP_CONNECTION_TIMEOUT

public static final String HTTP_CONNECTION_TIMEOUT

The connection timeout for the HTTP client.

See Also:

Constant Field Values

HTTP_READ_TIMEOUT

public static final String HTTP_READ_TIMEOUT

The read timeout for the HTTP client.

See Also:

Constant Field Values

HTTP_IS_PERSISTENT_TIMEOUT

public static final String HTTP_IS_PERSISTENT_TIMEOUT

Whether persistent connections are used by the HTTP client.

See Also:

Constant Field Values

PUSHAPP_DELETE_UNSUBSCRIBE_QUEUESIZE

public static final String PUSHAPP_DELETE_UNSUBSCRIBE_QUEUESIZE

The size of the queue to use for unsubscribes when performing a hard delete of a push application.

See Also:

Constant Field Values

PUSHAPP_DELETE_UNSUBSCRIBE_TIMEOUT

public static final String PUSHAPP_DELETE_UNSUBSCRIBE_TIMEOUT

The timeout to use for unsubscribes when performing a hard delete of a push application.

See Also:

Constant Field Values

PUSHAPP_SUBSCRIBER_DELETE_TIMEOUT

public static final String PUSHAPP_SUBSCRIBER_DELETE_TIMEOUT

The timeout to use for deletion of subscribers when performing a hard delete of a push application.

See Also:

Constant Field Values

SUBSCRIPTION_MATCHING_QUEUESIZE

public static final String SUBSCRIPTION_MATCHING_QUEUESIZE

The size of the queue to use for subscription validation/matching.

See Also:

Constant Field Values

SUBSCRIPTION_PPG_SYNC_BATCHSIZE

public static final String SUBSCRIPTION_PPG_SYNC_BATCHSIZE

The size of the batch to use for subscription status syncing with the PPG.

See Also:

Constant Field Values

SUBSCRIPTION_QUERY_URL

public static final String SUBSCRIPTION_QUERY_URL

The subscription query URL for public (BIS) pushes.

See Also:

Constant Field Values

SUBSCRIPTION_PPG_SYNC_QUEUESIZE

public static final String SUBSCRIPTION_PPG_SYNC_QUEUESIZE

The size of the queue to use for subscription status syncing with the PPG.

See Also:

Constant Field Values

SUBSCRIPTION_PPG_SYNC_TIMEOUT

public static final String SUBSCRIPTION_PPG_SYNC_TIMEOUT

The timeout to use for subscription status syncing with the PPG.

See Also:

Constant Field Values

SUBSCRIPTION_PPG_SYNC_MAX_THREADS

public static final String SUBSCRIPTION_PPG_SYNC_MAX_THREADS

The max. number of threads to use for subscription status syncing with the PPG.

See Also:

Constant Field Values

PUSH_STATS_UPDATE_FREQUENCY

public static final String PUSH_STATS_UPDATE_FREQUENCY

The time frequency (in seconds) with which push statistics are updated.

See Also:

Constant Field Values

PUSH_STATS_UPDATE_QUEUESIZE

public static final String PUSH_STATS_UPDATE_QUEUESIZE

The maximum size of the queue used in batch updating of push statistics.

See Also:

Constant Field Values

WEBSIGNALS_REGISTRATION_URL

public static final String WEBSIGNALS_REGISTRATION_URL

The URL for Web Signals registration on the PPG.

See Also:

Constant Field Values

WEBSIGNALS_DEREGISTRATION_URL

public static final String WEBSIGNALS_DEREGISTRATION_URL

The URL for Web Signals deregistration (unsubscribe) on the PPG.

See Also:

Constant Field Values

WEBSIGNALS_SUSPEND_URL

public static final String WEBSIGNALS_SUSPEND_URL

The URL for Web Signals suspend on the PPG.

See Also:

Constant Field Values

WEBSIGNALS_RESUME_URL

public static final String WEBSIGNALS_RESUME_URL

The URL for Web Signals resume on the PPG.

See Also:

Constant Field Values

Constructor Detail

PushSDKPropertiesImpl

public PushSDKPropertiesImpl()

Method Detail

setPropertyStore

public void setPropertyStore(PropertyStore propertyStore)

Sets the property store to be used with the push SDK properties.

Parameters:

propertyStore - the property store

getAcknowledgementMaxQueueSize

public int getAcknowledgementMaxQueueSize()

Description copied from interface: PushSDKProperties

Gets the maximum size of the result notification queue before it starts rejecting new notifications.

Specified by:

getAcknowledgementMaxQueueSize in interface PushSDKProperties

Returns:

the max. size of the result notification queue before it starts rejecting new notifications

getAcknowledgementMaxThreads

public int getAcknowledgementMaxThreads()

Description copied from interface: PushSDKProperties

Gets the maximum number of threads for processing the result notification queue and notifying listeners.

Specified by:

getAcknowledgementMaxThreads in interface PushSDKProperties

Returns:

the max. number of threads for processing the result notification queue and notifying listeners

getAcknowledgementBatchSize

public int getAcknowledgementBatchSize()

Description copied from interface: PushSDKProperties

Gets the maximum number of result notifications in a batch for processing.

Specified by:

getAcknowledgementBatchSize in interface PushSDKProperties

Returns:

the max. number of result notifications in a batch for processing

getAcknowledgementPushLookupRetryDelay

public int getAcknowledgementPushLookupRetryDelay()

Description copied from interface: PushSDKProperties

Gets the time in milliseconds to delay, after looking up and not finding the push request detail that corresponds to a result notification, before retrying the lookup. This property is needed for the case where the result notification has come back before the push request detail has been committed to storage.
Note: This property only applies to push applications that have the "store push requests" flag set to true.

Specified by:

getAcknowledgementPushLookupRetryDelay in interface PushSDKProperties

Returns:

the time in milliseconds to delay before attempting to lookup a push request detail again

getDatabaseType

public String getDatabaseType()

Description copied from interface: PushSDKProperties

Gets the type of database that the SDK is working with. The options are: mysql, oracle.

Specified by:

getDatabaseType in interface PushSDKProperties

Returns:

the database type

getDefaultDeliverBeforeTimestampOffset

public long getDefaultDeliverBeforeTimestampOffset()

Description copied from interface: PushSDKProperties

Gets the default deliver before timestamp offset. The default deliver before timestamp is the current time plus this offset in milliseconds (used in the low-level PAP module if no expiry date is specified).

Specified by:

getDefaultDeliverBeforeTimestampOffset in interface PushSDKProperties

Returns:

the default deliver before timestamp offset

getMaxInClauseValues

public int getMaxInClauseValues()

Description copied from interface: PushSDKProperties

Gets the maximum number of SQL IN clause parameters allowed by the DB implementation being used (e.g. the Oracle limit is 1000).

Specified by:

getMaxInClauseValues in interface PushSDKProperties

Returns:

the max. number of SQL IN clause parameters

getPpgAddress

@Deprecated
public String getPpgAddress()

Deprecated.

Description copied from interface: PushSDKProperties

Gets the push submission URL of the PPG (this URL will differ for BIS and BES depending on the value of isUsingPublicPush()).

Specified by:

getPpgAddress in interface PushSDKProperties

Returns:

the PPG address

getPublicPpgAddress

public String getPublicPpgAddress()

Description copied from interface: PushSDKProperties

Gets the push submission URL of the public (BIS) PPG.

Specified by:

getPublicPpgAddress in interface PushSDKProperties

Returns:

the public (BIS) PPG address

getEnterprisePpgAddress

public String getEnterprisePpgAddress()

Description copied from interface: PushSDKProperties

Gets the push submission URL of the enterprise (BES) PPG.

Specified by:

getEnterprisePpgAddress in interface PushSDKProperties

Returns:

the enterprise (BES) PPG address

getPushRequestDetailFindMaxResults

public int getPushRequestDetailFindMaxResults()

Description copied from interface: PushSDKProperties

Gets the max. number of results returned by a push request detail find operation.
IMPORTANT: An IllegalArgumentException will be thrown if an attempt is made in these find methods to request results above this number.

Specified by:

getPushRequestDetailFindMaxResults in interface PushSDKProperties

Returns:

the max. number of results returned by a push request detail find operation

getRegeneratePushIdMaxAttempts

public int getRegeneratePushIdMaxAttempts()

Description copied from interface: PushSDKProperties

Gets the maximum number of attempts to generate unique push ids before giving up.

Specified by:

getRegeneratePushIdMaxAttempts in interface PushSDKProperties

Returns:

the max. number of attempts to generate unique push ids for

getSubscriptionDeregistrationUrl

public String getSubscriptionDeregistrationUrl()

Description copied from interface: PushSDKProperties

Gets the subscriber deregistration URL for public (BIS) pushes.

Specified by:

getSubscriptionDeregistrationUrl in interface PushSDKProperties

Returns:

the subscriber deregistration URL

getSubscriptionFindMaxResults

public int getSubscriptionFindMaxResults()

Description copied from interface: PushSDKProperties

Gets the maximum number of results returned by a subscriber find operation.
IMPORTANT: An IllegalArgumentException will be thrown if an attempt is made in these find methods to request results above this number.

Specified by:

getSubscriptionFindMaxResults in interface PushSDKProperties

Returns:

the max. number of results returned by a subscriber find operation

getSubscriptionMatchingMaxThreads

public int getSubscriptionMatchingMaxThreads()

Description copied from interface: PushSDKProperties

Gets the maximum number of threads to use for subscription matching (used in subscription validation).

Specified by:

getSubscriptionMatchingMaxThreads in interface PushSDKProperties

Returns:

the max. number of threads to use for subscription matching

getSubscriptionResumeUrl

public String getSubscriptionResumeUrl()

Description copied from interface: PushSDKProperties

Gets the resume subscription URL for public (BIS) pushes.

Specified by:

getSubscriptionResumeUrl in interface PushSDKProperties

Returns:

the resume subscription URL

getSubscriptionSuspendUrl

public String getSubscriptionSuspendUrl()

Description copied from interface: PushSDKProperties

Gets the suspend subscription URL for public (BIS) pushes.

Specified by:

getSubscriptionSuspendUrl in interface PushSDKProperties

Returns:

the suspend subscription URL

getSubscriptionValidationBatchSize

public int getSubscriptionValidationBatchSize()

Description copied from interface: PushSDKProperties

Gets the number of subscribers to load at once from the database to validate. Making this number too large may exceed available system memory. Making this number too small will decrease performance as more calls to the database will be required.
IMPORTANT: This number should never be zero! One must be the minimum value.

Specified by:

getSubscriptionValidationBatchSize in interface PushSDKProperties

Returns:

the number of subscribers to load at once from the database to validate

getSubscriptionValidationHighWaterMark

public int getSubscriptionValidationHighWaterMark()

Description copied from interface: PushSDKProperties

Gets the subscription validation high water mark. When the number of subscribers to validate are below this water mark, an optimized query for a small number of subscribers will be used. Conversely, when above this number, a second optimized query for a large number of subscribers will be used.

Specified by:

getSubscriptionValidationHighWaterMark in interface PushSDKProperties

Returns:

the subscription validation high water mark

isUsingPublicPush

@Deprecated
public boolean isUsingPublicPush()

Deprecated.

Description copied from interface: PushSDKProperties

Whether or not to use a public (BIS) push (as opposed to an enterprise (BES) push).

Specified by:

isUsingPublicPush in interface PushSDKProperties

Returns:

true if using a public (BIS) push; false otherwise

isUsingXmlParserDtdValidation

@Deprecated
public boolean isUsingXmlParserDtdValidation()

Deprecated.

Description copied from interface: PushSDKProperties

Whether or not the XML parser should perform external DTD validation. For production use (especially high volume push applications), it is highly recommended to set this value to false.

Specified by:

isUsingXmlParserDtdValidation in interface PushSDKProperties

Returns:

true if DTD validation should be done; false otherwise

setAcknowledgementMaxQueueSize

public void setAcknowledgementMaxQueueSize(int value)

Description copied from interface: PushSDKProperties

Sets the maximum size of the result notification queue before it starts rejecting new notifications.

Specified by:

setAcknowledgementMaxQueueSize in interface PushSDKProperties

Parameters:

value - the max. size of the result notification queue before it starts rejecting new notifications

setAcknowledgementMaxThreads

public void setAcknowledgementMaxThreads(int value)

Description copied from interface: PushSDKProperties

Sets the maximum number of threads for processing the result notification queue and notifying listeners.

Specified by:

setAcknowledgementMaxThreads in interface PushSDKProperties

Parameters:

value - the max. number of threads for processing the result notification queue and notifying listeners

setAcknowledgementBatchSize

public void setAcknowledgementBatchSize(int value)

Description copied from interface: PushSDKProperties

Sets the maximum number of result notifications in a batch for processing.

Specified by:

setAcknowledgementBatchSize in interface PushSDKProperties

Parameters:

value - the max. number of result notifications in a batch for processing

setAcknowledgementPushLookupRetryDelay

public void setAcknowledgementPushLookupRetryDelay(int value)

Description copied from interface: PushSDKProperties

Sets the time in milliseconds to delay, after looking up and not finding the push request detail that corresponds to a result notification, before retrying the lookup. This property is needed for the case where the result notification has come back before the push request detail has been committed to storage.
Note: This property only applies to push applications that have the "store push requests" flag set to true.

Specified by:

setAcknowledgementPushLookupRetryDelay in interface PushSDKProperties

Parameters:

value - the time in milliseconds to delay before attempting to lookup a push request detail again

setDatabaseType

public void setDatabaseType(String value)

Description copied from interface: PushSDKProperties

Sets the type of database that the SDK is working with. The options are: mysql, oracle.

Specified by:

setDatabaseType in interface PushSDKProperties

Parameters:

value - the database type

setDefaultDeliverBeforeTimestampOffset

public void setDefaultDeliverBeforeTimestampOffset(long value)

Description copied from interface: PushSDKProperties

Sets the default deliver before timestamp offset. The default deliver before timestamp is the current time plus this offset in milliseconds (used in the low-level PAP module if no expiry date is specified).

Specified by:

setDefaultDeliverBeforeTimestampOffset in interface PushSDKProperties

Parameters:

value - the default deliver before timestamp offset

setMaxInClauseValues

public void setMaxInClauseValues(int value)

Description copied from interface: PushSDKProperties

Sets the maximum number of SQL IN clause parameters allowed by the DB implementation being used (e.g. the Oracle limit is 1000).

Specified by:

setMaxInClauseValues in interface PushSDKProperties

Parameters:

value - the max. number of SQL IN clause parameters

setPpgAddress

@Deprecated
public void setPpgAddress(String value)

Deprecated.

Description copied from interface: PushSDKProperties

Sets the push submission URL of the PPG (this URL will differ for BIS and BES depending on the value of isUsingPublicPush()).

Specified by:

setPpgAddress in interface PushSDKProperties

Parameters:

value - the PPG address

setPublicPpgAddress

public void setPublicPpgAddress(String value)

Description copied from interface: PushSDKProperties

Sets the push submission URL of the public (BIS) PPG.

Specified by:

setPublicPpgAddress in interface PushSDKProperties

Parameters:

value - the public (BIS) PPG address

setEnterprisePpgAddress

public void setEnterprisePpgAddress(String value)

Description copied from interface: PushSDKProperties

Sets the push submission URL of the enterprise (BES) PPG.

Specified by:

setEnterprisePpgAddress in interface PushSDKProperties

Parameters:

value - the enterprise (BES) PPG address

setPushRequestDetailFindMaxResults

public void setPushRequestDetailFindMaxResults(int value)

Description copied from interface: PushSDKProperties

Sets the max. number of results returned by a push request detail find operation.
IMPORTANT: An IllegalArgumentException will be thrown if an attempt is made in these find methods to request results above this number.

Specified by:

setPushRequestDetailFindMaxResults in interface PushSDKProperties

Parameters:

value - the max. number of results returned by a push request detail find operation

setRegeneratePushIdMaxAttempts

public void setRegeneratePushIdMaxAttempts(int value)

Description copied from interface: PushSDKProperties

Sets the maximum number of attempts to generate unique push ids before giving up.

Specified by:

setRegeneratePushIdMaxAttempts in interface PushSDKProperties

Parameters:

value - the max. number of attempts to generate unique push ids for

setSubscriptionDeregistrationUrl

public void setSubscriptionDeregistrationUrl(String value)

Description copied from interface: PushSDKProperties

Sets the subscriber deregistration URL for public (BIS) pushes.

Specified by:

setSubscriptionDeregistrationUrl in interface PushSDKProperties

Parameters:

value - the subscriber deregistration URL

setSubscriptionFindMaxResults

public void setSubscriptionFindMaxResults(int value)

Description copied from interface: PushSDKProperties

Sets the maximum number of results returned by a subscriber find operation.
IMPORTANT: An IllegalArgumentException will be thrown if an attempt is made in these find methods to request results above this number.

Specified by:

setSubscriptionFindMaxResults in interface PushSDKProperties

Parameters:

value - the max. number of results returned by a subscriber find operation

setSubscriptionMatchingMaxThreads

public void setSubscriptionMatchingMaxThreads(int value)

Description copied from interface: PushSDKProperties

Sets the maximum number of threads to use for subscription matching (used in subscription validation).

Specified by:

setSubscriptionMatchingMaxThreads in interface PushSDKProperties

Parameters:

value - the max. number of threads to use for subscription matching

setSubscriptionResumeUrl

public void setSubscriptionResumeUrl(String value)

Description copied from interface: PushSDKProperties

Sets the resume subscription URL for public (BIS) pushes.

Specified by:

setSubscriptionResumeUrl in interface PushSDKProperties

Parameters:

value - the resume subscription URL

setSubscriptionSuspendUrl

public void setSubscriptionSuspendUrl(String value)

Description copied from interface: PushSDKProperties

Sets the suspend subscription URL for public (BIS) pushes.

Specified by:

setSubscriptionSuspendUrl in interface PushSDKProperties

Parameters:

value - the suspend subscription URL

setSubscriptionValidationBatchSize

public void setSubscriptionValidationBatchSize(int value)

Description copied from interface: PushSDKProperties

Sets the number of subscribers to load at once from the database to validate. Making this number too large may exceed available system memory. Making this number too small will decrease performance as more calls to the database will be required.
IMPORTANT: This number should never be zero! One must be the minimum value.

Specified by:

setSubscriptionValidationBatchSize in interface PushSDKProperties

Parameters:

value - the number of subscribers to load at once from the database to validate

setSubscriptionValidationHighWaterMark

public void setSubscriptionValidationHighWaterMark(int value)

Description copied from interface: PushSDKProperties

Sets the subscription validation high water mark. When the number of subscribers to validate are below this water mark, an optimized query for a small number of subscribers will be used. Conversely, when above this number, a second optimized query for a large number of subscribers will be used.

Specified by:

setSubscriptionValidationHighWaterMark in interface PushSDKProperties

Parameters:

value - the subscription validation high water mark

setUsingPublicPush

@Deprecated
public void setUsingPublicPush(boolean value)

Deprecated.

Description copied from interface: PushSDKProperties

Sets whether or not to use a public (BIS) push (as opposed to an enterprise (BES) push).

Specified by:

setUsingPublicPush in interface PushSDKProperties

Parameters:

value - true if using a public (BIS) push; false otherwise

setUsingXmlParserDtdValidation

@Deprecated
public void setUsingXmlParserDtdValidation(boolean value)

Deprecated.

Description copied from interface: PushSDKProperties

Sets whether the XML parser should perform external DTD validation. For production use (especially high volume push applications), it is highly recommended to set this value to false.

Specified by:

setUsingXmlParserDtdValidation in interface PushSDKProperties

Parameters:

value - true if DTD validation should be done; false otherwise

getHttpConnectionTimeout

public int getHttpConnectionTimeout()

Description copied from interface: PushSDKProperties

Gets the connection timeout for the HTTP client in milliseconds.

Specified by:

getHttpConnectionTimeout in interface PushSDKProperties

Returns:

the connection timeout

getHttpIsPersistent

public boolean getHttpIsPersistent()

Description copied from interface: PushSDKProperties

Gets whether persistent connections are used by the HTTP client.

Specified by:

getHttpIsPersistent in interface PushSDKProperties

Returns:

true if persistent connections are used; false otherwise

getHttpReadTimeout

public int getHttpReadTimeout()

Description copied from interface: PushSDKProperties

Gets the read timeout for the HTTP client in milliseconds.

Specified by:

getHttpReadTimeout in interface PushSDKProperties

Returns:

the read timeout

setHttpConnectionTimeout

public void setHttpConnectionTimeout(int value)

Description copied from interface: PushSDKProperties

Sets the connection timeout for the HTTP client in milliseconds.

Specified by:

setHttpConnectionTimeout in interface PushSDKProperties

Parameters:

value - the connection timeout

setHttpIsPersistent

public void setHttpIsPersistent(boolean value)

Description copied from interface: PushSDKProperties

Sets whether persistent connections are used by the HTTP client.

Specified by:

setHttpIsPersistent in interface PushSDKProperties

Parameters:

value - true if persistent connections are used; false otherwise

setHttpReadTimeout

public void setHttpReadTimeout(int value)

Description copied from interface: PushSDKProperties

Sets the read timeout for the HTTP client in milliseconds.

Specified by:

setHttpReadTimeout in interface PushSDKProperties

Parameters:

value - the read timeout

getPushAppDeleteUnsubscribeQueueSize

public int getPushAppDeleteUnsubscribeQueueSize()

Description copied from interface: PushSDKProperties

Gets the size of the queue for unsubscribes performed for a hard application delete.

Specified by:

getPushAppDeleteUnsubscribeQueueSize in interface PushSDKProperties

Returns:

the queue size for unsubscribes

setPushAppDeleteUnsubscribeQueueSize

public void setPushAppDeleteUnsubscribeQueueSize(int size)

Description copied from interface: PushSDKProperties

Sets the size of the queue for unsubscribes performed for a hard application delete.

Specified by:

setPushAppDeleteUnsubscribeQueueSize in interface PushSDKProperties

Parameters:

size - the queue size for unsubscribes

getPushAppDeleteUnsubscribeTimeout

public int getPushAppDeleteUnsubscribeTimeout()

Description copied from interface: PushSDKProperties

Gets the timeout (in minutes) for unsubscribes performed for a hard application delete.

Specified by:

getPushAppDeleteUnsubscribeTimeout in interface PushSDKProperties

Returns:

the amount of time to wait before throwing an exception

setPushAppDeleteUnsubscribeTimeout

public void setPushAppDeleteUnsubscribeTimeout(int timeout)

Description copied from interface: PushSDKProperties

Sets the timeout (in minutes) for unsubscribes performed for a hard application delete.

Specified by:

setPushAppDeleteUnsubscribeTimeout in interface PushSDKProperties

Parameters:

timeout - the amount of time to wait before throwing an exception

getPushAppSubscriberDeleteTimeout

public int getPushAppSubscriberDeleteTimeout()

Description copied from interface: PushSDKProperties

Gets the timeout (in minutes) for subscriber deletions performed for a hard application delete.

Specified by:

getPushAppSubscriberDeleteTimeout in interface PushSDKProperties

Returns:

the amount of time to wait before throwing an exception

setPushAppSubscriberDeleteTimeout

public void setPushAppSubscriberDeleteTimeout(int timeout)

Description copied from interface: PushSDKProperties

Sets the timeout (in minutes) for subscriber deletions performed for a hard application delete.

Specified by:

setPushAppSubscriberDeleteTimeout in interface PushSDKProperties

Parameters:

timeout - the amount of time to wait before throwing an exception

getSubscriptionMatchingQueueSize

public int getSubscriptionMatchingQueueSize()

Description copied from interface: PushSDKProperties

Gets the size of the queue for large subscription validation/subscription matching.

Specified by:

getSubscriptionMatchingQueueSize in interface PushSDKProperties

Returns:

the queue size

setSubscriptionMatchingQueueSize

public void setSubscriptionMatchingQueueSize(int size)

Description copied from interface: PushSDKProperties

Sets the size of the queue for large subscription validation/subscription matching.

Specified by:

setSubscriptionMatchingQueueSize in interface PushSDKProperties

Parameters:

size - the queue size

getSubscriptionPPGSyncBatchSize

public int getSubscriptionPPGSyncBatchSize()

Description copied from interface: PushSDKProperties

Gets the size of the batches for syncing subscription statuses with the PPG.

Specified by:

getSubscriptionPPGSyncBatchSize in interface PushSDKProperties

Returns:

the batch size

setSubscriptionPPGSyncBatchSize

public void setSubscriptionPPGSyncBatchSize(int size)

Description copied from interface: PushSDKProperties

Sets the size of the batches for syncing subscription statuses with the PPG.

Specified by:

setSubscriptionPPGSyncBatchSize in interface PushSDKProperties

Parameters:

size - the batch size

getSubscriptionQueryUrl

public String getSubscriptionQueryUrl()

Description copied from interface: PushSDKProperties

Gets the URL associated with subscription status queries for public (BIS) pushes.

Specified by:

getSubscriptionQueryUrl in interface PushSDKProperties

Returns:

the subscription query URL

setSubscriptionQueryUrl

public void setSubscriptionQueryUrl(String url)

Description copied from interface: PushSDKProperties

Sets the URL associated with subscription status queries for public (BIS) pushes.

Specified by:

setSubscriptionQueryUrl in interface PushSDKProperties

Parameters:

url - the subscription query URL

getSubscriptionPPGSyncQueueSize

public int getSubscriptionPPGSyncQueueSize()

Description copied from interface: PushSDKProperties

Gets the size of the queue used in syncing subscription statuses with the PPG.

Specified by:

getSubscriptionPPGSyncQueueSize in interface PushSDKProperties

Returns:

the queue size

setSubscriptionPPGSyncQueueSize

public void setSubscriptionPPGSyncQueueSize(int size)

Description copied from interface: PushSDKProperties

Sets the size of the queue used in syncing subscription statuses with the PPG.

Specified by:

setSubscriptionPPGSyncQueueSize in interface PushSDKProperties

Parameters:

size - the queue size

getSubscriptionPPGSyncTimeout

public int getSubscriptionPPGSyncTimeout()

Description copied from interface: PushSDKProperties

Gets the timeout (in minutes) used in syncing subscription statuses with the PPG.

Specified by:

getSubscriptionPPGSyncTimeout in interface PushSDKProperties

Returns:

the processing time allowed for the sync

setSubscriptionPPGSyncTimeout

public void setSubscriptionPPGSyncTimeout(int timeout)

Description copied from interface: PushSDKProperties

Sets the timeout (in minutes) used in syncing subscription statuses with the PPG.

Specified by:

setSubscriptionPPGSyncTimeout in interface PushSDKProperties

Parameters:

timeout - the processing time allowed before timing out and throwing an exception

getParserSpecialCharacters

public char[] getParserSpecialCharacters()

Description copied from interface: PushSDKProperties

Gets the parser special characters that should be avoided when specifying values of PAP message elements.

Specified by:

getParserSpecialCharacters in interface PushSDKProperties

Returns:

the char array of parser special characters

setParserSpecialCharacters

public void setParserSpecialCharacters(char[] value)

Description copied from interface: PushSDKProperties

Sets the parser special characters that should be avoided when specifying values of PAP message elements.

Specified by:

setParserSpecialCharacters in interface PushSDKProperties

Parameters:

value - the char array of parser special characters

getSubscriptionPPGSyncMaxThreads

public int getSubscriptionPPGSyncMaxThreads()

Description copied from interface: PushSDKProperties

Gets the maximum number of threads to use in syncing subscription statuses with the PPG.

Specified by:

getSubscriptionPPGSyncMaxThreads in interface PushSDKProperties

Returns:

the max. number of threads to use for subscription status syncing

setSubscriptionPPGSyncMaxThreads

public void setSubscriptionPPGSyncMaxThreads(int value)

Description copied from interface: PushSDKProperties

Sets the maximum number of threads to use in syncing subscription statuses with the PPG.

Specified by:

setSubscriptionPPGSyncMaxThreads in interface PushSDKProperties

Parameters:

value - the max. number of threads to use for subscription status syncing

getPushStatsUpdateFrequency

public int getPushStatsUpdateFrequency()

Description copied from interface: PushSDKProperties

Gets the time frequency (in seconds) with which push statistics are updated.

Specified by:

getPushStatsUpdateFrequency in interface PushSDKProperties

Returns:

the push stats update frequency

setPushStatsUpdateFrequency

public void setPushStatsUpdateFrequency(int value)

Description copied from interface: PushSDKProperties

Sets the time frequency (in seconds) with which push statistics are updated.

Specified by:

setPushStatsUpdateFrequency in interface PushSDKProperties

Parameters:

value - the push stats update frequency

getPushStatsUpdateQueueSize

public int getPushStatsUpdateQueueSize()

Description copied from interface: PushSDKProperties

Gets the maximum size of the queue used in batch updating of push statistics.

Specified by:

getPushStatsUpdateQueueSize in interface PushSDKProperties

Returns:

the push stats queue size

setPushStatsUpdateQueueSize

public void setPushStatsUpdateQueueSize(int value)

Description copied from interface: PushSDKProperties

Sets the maximum size of the queue used in batch updating of push statistics.

Specified by:

setPushStatsUpdateQueueSize in interface PushSDKProperties

Parameters:

value - the push stats queue size

getWebsignalsRegistrationUrl

public String getWebsignalsRegistrationUrl()

Description copied from interface: PushSDKProperties

Gets the Web Signals registration URL (a PPG URL).

Specified by:

getWebsignalsRegistrationUrl in interface PushSDKProperties

Returns:

the Web Signals registration URL

setWebsignalsRegistrationUrl

public void setWebsignalsRegistrationUrl(String websignalsRegistrationUrl)

Description copied from interface: PushSDKProperties

Sets the Web Signals registration URL (a PPG URL).

Specified by:

setWebsignalsRegistrationUrl in interface PushSDKProperties

Parameters:

websignalsRegistrationUrl - the Web Signals registration URL

getWebsignalsDeregistrationUrl

public String getWebsignalsDeregistrationUrl()

Description copied from interface: PushSDKProperties

Gets the subscriber deregistration URL for Web Signals.

Specified by:

getWebsignalsDeregistrationUrl in interface PushSDKProperties

Returns:

the Web Signals subscriber deregistration URL

setWebsignalsDeregistrationUrl

public void setWebsignalsDeregistrationUrl(String value)

Description copied from interface: PushSDKProperties

Sets the subscriber deregistration URL for Web Signals.

Specified by:

setWebsignalsDeregistrationUrl in interface PushSDKProperties

Parameters:

value - the Web Signals subscriber deregistration URL

getWebsignalsSuspendUrl

public String getWebsignalsSuspendUrl()

Description copied from interface: PushSDKProperties

Gets the suspend subscription URL for Web Signals.

Specified by:

getWebsignalsSuspendUrl in interface PushSDKProperties

Returns:

the Web Signals suspend subscription URL

setWebsignalsSuspendUrl

public void setWebsignalsSuspendUrl(String value)

Description copied from interface: PushSDKProperties

Sets the suspend subscription URL for Web Signals.

Specified by:

setWebsignalsSuspendUrl in interface PushSDKProperties

Parameters:

value - the Web Signals suspend subscription URL

getWebsignalsResumeUrl

public String getWebsignalsResumeUrl()

Description copied from interface: PushSDKProperties

Gets the resume subscription URL for Web Signals.

Specified by:

getWebsignalsResumeUrl in interface PushSDKProperties

Returns:

the Web Signals resume subscription URL

setWebsignalsResumeUrl

public void setWebsignalsResumeUrl(String value)

Description copied from interface: PushSDKProperties

Sets the resume subscription URL for Web Signals.

Specified by:

setWebsignalsResumeUrl in interface PushSDKProperties

Parameters:

value - the Web Signals resume subscription URL

getDtdDeclarationPublic

public String getDtdDeclarationPublic()

Description copied from interface: PushSDKProperties

Returns the DTD declaration to use when constructing XML to send to the public (BIS) PPG (this property is not related to parsing XML sent from the PPG).
Note: This property should not be changed unless the PPG changes it for some reason first!

Specified by:

getDtdDeclarationPublic in interface PushSDKProperties

Returns:

the DTD declaration

setDtdDeclarationPublic

public void setDtdDeclarationPublic(String value)

Description copied from interface: PushSDKProperties

Sets the DTD declaration to use when constructing XML to send to the public (BIS) PPG (this property is not related to parsing XML sent from the PPG).
Note: This property should not be changed unless the PPG changes it for some reason first!

Specified by:

setDtdDeclarationPublic in interface PushSDKProperties

Parameters:

value - the DTD declaration

getDtdDeclarationEnterprise

public String getDtdDeclarationEnterprise()

Description copied from interface: PushSDKProperties

Returns the DTD declaration to use when constructing XML to send to the enterprise (BES) PPG (this property is not related to parsing XML sent from the PPG).
Note: This property should not be changed unless the PPG changes it for some reason first!

Specified by:

getDtdDeclarationEnterprise in interface PushSDKProperties

Returns:

the DTD declaration

setDtdDeclarationEnterprise

public void setDtdDeclarationEnterprise(String value)

Description copied from interface: PushSDKProperties

Sets the DTD declaration to use when constructing XML to send to the enterprise (BES) PPG (this property is not related to parsing XML sent from the PPG).
Note: This property should not be changed unless the PPG changes it for some reason first!

Specified by:

setDtdDeclarationEnterprise in interface PushSDKProperties

Parameters:

value - the DTD declaration