net.rim.pushsdk.commons
Interface PushSDKProperties

All Known Implementing Classes:
PushSDKPropertiesImpl

public interface PushSDKProperties

Interface that defines operations to encapsulate access to the push SDK properties.

Author:
mdicesare

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. As of release 1.1, replaced by getPublicPpgAddress() or getEnterprisePpgAddress().
 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. 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.
 boolean isUsingXmlParserDtdValidation()
          Deprecated. As of release 1.1, DTD validation is not supported, and this method returns false.
 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. As of release 1.1, replaced by setPublicPpgAddress(String) or setEnterprisePpgAddress(String) .
 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. As of release 1.1, replaced by PapControl.setUsingPublicPush(boolean) if using the low-level PAP APIs, and PushApplication.setType(net.rim.pushsdk.pushappmgmt.PushApplicationType) or SubscriberPartial.setType(net.rim.pushsdk.subscription.SubscriberType) if using the high-level APIs.
 void setUsingXmlParserDtdValidation(boolean value)
          Deprecated. As of release 1.1, DTD validation is not supported, and this method has no effect.
 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.
 

Method Detail

getDatabaseType

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

Returns:
the database type

setDatabaseType

void setDatabaseType(String value)
Sets the type of database that the SDK is working with. The options are: mysql, oracle.

Parameters:
value - the database type

getMaxInClauseValues

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

Returns:
the max. number of SQL IN clause parameters

setMaxInClauseValues

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

Parameters:
value - the max. number of SQL IN clause parameters

isUsingPublicPush

@Deprecated
boolean isUsingPublicPush()
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).

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

setUsingPublicPush

@Deprecated
void setUsingPublicPush(boolean value)
Deprecated. As of release 1.1, replaced by PapControl.setUsingPublicPush(boolean) if using the low-level PAP APIs, and PushApplication.setType(net.rim.pushsdk.pushappmgmt.PushApplicationType) or SubscriberPartial.setType(net.rim.pushsdk.subscription.SubscriberType) if using the high-level APIs.

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

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

getPpgAddress

@Deprecated
String getPpgAddress()
Deprecated. As of release 1.1, replaced by getPublicPpgAddress() or getEnterprisePpgAddress().

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

Returns:
the PPG address

getPublicPpgAddress

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

Returns:
the public (BIS) PPG address

getEnterprisePpgAddress

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

Returns:
the enterprise (BES) PPG address

setPpgAddress

@Deprecated
void setPpgAddress(String value)
Deprecated. As of release 1.1, replaced by setPublicPpgAddress(String) or setEnterprisePpgAddress(String) .

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

Parameters:
value - the PPG address

setPublicPpgAddress

void setPublicPpgAddress(String value)
Sets the push submission URL of the public (BIS) PPG.

Parameters:
value - the public (BIS) PPG address

setEnterprisePpgAddress

void setEnterprisePpgAddress(String value)
Sets the push submission URL of the enterprise (BES) PPG.

Parameters:
value - the enterprise (BES) PPG address

getDefaultDeliverBeforeTimestampOffset

long getDefaultDeliverBeforeTimestampOffset()
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).

Returns:
the default deliver before timestamp offset

setDefaultDeliverBeforeTimestampOffset

void setDefaultDeliverBeforeTimestampOffset(long value)
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).

Parameters:
value - the default deliver before timestamp offset

isUsingXmlParserDtdValidation

@Deprecated
boolean isUsingXmlParserDtdValidation()
Deprecated. As of release 1.1, DTD validation is not supported, and this method returns false.

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.

Returns:
true if DTD validation should be done; false otherwise

setUsingXmlParserDtdValidation

@Deprecated
void setUsingXmlParserDtdValidation(boolean value)
Deprecated. As of release 1.1, DTD validation is not supported, and this method has no effect.

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.

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

getParserSpecialCharacters

char[] getParserSpecialCharacters()
Gets the parser special characters that should be avoided when specifying values of PAP message elements.

Returns:
the char array of parser special characters

setParserSpecialCharacters

void setParserSpecialCharacters(char[] value)
Sets the parser special characters that should be avoided when specifying values of PAP message elements.

Parameters:
value - the char array of parser special characters

getRegeneratePushIdMaxAttempts

int getRegeneratePushIdMaxAttempts()
Gets the maximum number of attempts to generate unique push ids before giving up.

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

setRegeneratePushIdMaxAttempts

void setRegeneratePushIdMaxAttempts(int value)
Sets the maximum number of attempts to generate unique push ids before giving up.

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

getPushRequestDetailFindMaxResults

int getPushRequestDetailFindMaxResults()
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.

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

setPushRequestDetailFindMaxResults

void setPushRequestDetailFindMaxResults(int value)
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.

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

getAcknowledgementMaxQueueSize

int getAcknowledgementMaxQueueSize()
Gets the maximum size of the result notification queue before it starts rejecting new notifications.

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

setAcknowledgementMaxQueueSize

void setAcknowledgementMaxQueueSize(int value)
Sets the maximum size of the result notification queue before it starts rejecting new notifications.

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

getAcknowledgementMaxThreads

int getAcknowledgementMaxThreads()
Gets the maximum number of threads for processing the result notification queue and notifying listeners.

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

setAcknowledgementMaxThreads

void setAcknowledgementMaxThreads(int value)
Sets the maximum number of threads for processing the result notification queue and notifying listeners.

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

getAcknowledgementBatchSize

int getAcknowledgementBatchSize()
Gets the maximum number of result notifications in a batch for processing.

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

setAcknowledgementBatchSize

void setAcknowledgementBatchSize(int value)
Sets the maximum number of result notifications in a batch for processing.

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

getAcknowledgementPushLookupRetryDelay

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. 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.

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

setAcknowledgementPushLookupRetryDelay

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. 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.

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

getSubscriptionValidationHighWaterMark

int getSubscriptionValidationHighWaterMark()
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.

Returns:
the subscription validation high water mark

setSubscriptionValidationHighWaterMark

void setSubscriptionValidationHighWaterMark(int value)
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.

Parameters:
value - the subscription validation high water mark

getSubscriptionValidationBatchSize

int getSubscriptionValidationBatchSize()
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.

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

setSubscriptionValidationBatchSize

void setSubscriptionValidationBatchSize(int value)
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.

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

getSubscriptionDeregistrationUrl

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

Returns:
the subscriber deregistration URL

setSubscriptionDeregistrationUrl

void setSubscriptionDeregistrationUrl(String value)
Sets the subscriber deregistration URL for public (BIS) pushes.

Parameters:
value - the subscriber deregistration URL

getSubscriptionSuspendUrl

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

Returns:
the suspend subscription URL

setSubscriptionSuspendUrl

void setSubscriptionSuspendUrl(String value)
Sets the suspend subscription URL for public (BIS) pushes.

Parameters:
value - the suspend subscription URL

getSubscriptionResumeUrl

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

Returns:
the resume subscription URL

setSubscriptionResumeUrl

void setSubscriptionResumeUrl(String value)
Sets the resume subscription URL for public (BIS) pushes.

Parameters:
value - the resume subscription URL

getSubscriptionMatchingMaxThreads

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

Returns:
the max. number of threads to use for subscription matching

setSubscriptionMatchingMaxThreads

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

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

getSubscriptionFindMaxResults

int getSubscriptionFindMaxResults()
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.

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

setSubscriptionFindMaxResults

void setSubscriptionFindMaxResults(int value)
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.

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

getHttpConnectionTimeout

int getHttpConnectionTimeout()
Gets the connection timeout for the HTTP client in milliseconds.

Returns:
the connection timeout

setHttpConnectionTimeout

void setHttpConnectionTimeout(int value)
Sets the connection timeout for the HTTP client in milliseconds.

Parameters:
value - the connection timeout

getHttpReadTimeout

int getHttpReadTimeout()
Gets the read timeout for the HTTP client in milliseconds.

Returns:
the read timeout

setHttpReadTimeout

void setHttpReadTimeout(int value)
Sets the read timeout for the HTTP client in milliseconds.

Parameters:
value - the read timeout

getHttpIsPersistent

boolean getHttpIsPersistent()
Gets whether persistent connections are used by the HTTP client.

Returns:
true if persistent connections are used; false otherwise

setHttpIsPersistent

void setHttpIsPersistent(boolean value)
Sets whether persistent connections are used by the HTTP client.

Parameters:
value - true if persistent connections are used; false otherwise

getPushAppDeleteUnsubscribeQueueSize

int getPushAppDeleteUnsubscribeQueueSize()
Gets the size of the queue for unsubscribes performed for a hard application delete.

Returns:
the queue size for unsubscribes

setPushAppDeleteUnsubscribeQueueSize

void setPushAppDeleteUnsubscribeQueueSize(int size)
Sets the size of the queue for unsubscribes performed for a hard application delete.

Parameters:
size - the queue size for unsubscribes

getPushAppDeleteUnsubscribeTimeout

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

Returns:
the amount of time to wait before throwing an exception

setPushAppDeleteUnsubscribeTimeout

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

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

getPushAppSubscriberDeleteTimeout

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

Returns:
the amount of time to wait before throwing an exception

setPushAppSubscriberDeleteTimeout

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

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

getSubscriptionMatchingQueueSize

int getSubscriptionMatchingQueueSize()
Gets the size of the queue for large subscription validation/subscription matching.

Returns:
the queue size

setSubscriptionMatchingQueueSize

void setSubscriptionMatchingQueueSize(int size)
Sets the size of the queue for large subscription validation/subscription matching.

Parameters:
size - the queue size

getSubscriptionPPGSyncBatchSize

int getSubscriptionPPGSyncBatchSize()
Gets the size of the batches for syncing subscription statuses with the PPG.

Returns:
the batch size

setSubscriptionPPGSyncBatchSize

void setSubscriptionPPGSyncBatchSize(int size)
Sets the size of the batches for syncing subscription statuses with the PPG.

Parameters:
size - the batch size

getSubscriptionQueryUrl

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

Returns:
the subscription query URL

setSubscriptionQueryUrl

void setSubscriptionQueryUrl(String url)
Sets the URL associated with subscription status queries for public (BIS) pushes.

Parameters:
url - the subscription query URL

getSubscriptionPPGSyncQueueSize

int getSubscriptionPPGSyncQueueSize()
Gets the size of the queue used in syncing subscription statuses with the PPG.

Returns:
the queue size

setSubscriptionPPGSyncQueueSize

void setSubscriptionPPGSyncQueueSize(int size)
Sets the size of the queue used in syncing subscription statuses with the PPG.

Parameters:
size - the queue size

getSubscriptionPPGSyncTimeout

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

Returns:
the processing time allowed for the sync

setSubscriptionPPGSyncTimeout

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

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

getSubscriptionPPGSyncMaxThreads

int getSubscriptionPPGSyncMaxThreads()
Gets the maximum number of threads to use in syncing subscription statuses with the PPG.

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

setSubscriptionPPGSyncMaxThreads

void setSubscriptionPPGSyncMaxThreads(int value)
Sets the maximum number of threads to use in syncing subscription statuses with the PPG.

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

getPushStatsUpdateFrequency

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

Returns:
the push stats update frequency

setPushStatsUpdateFrequency

void setPushStatsUpdateFrequency(int value)
Sets the time frequency (in seconds) with which push statistics are updated.

Parameters:
value - the push stats update frequency

getPushStatsUpdateQueueSize

int getPushStatsUpdateQueueSize()
Gets the maximum size of the queue used in batch updating of push statistics.

Returns:
the push stats queue size

setPushStatsUpdateQueueSize

void setPushStatsUpdateQueueSize(int value)
Sets the maximum size of the queue used in batch updating of push statistics.

Parameters:
value - the push stats queue size

getWebsignalsRegistrationUrl

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

Returns:
the Web Signals registration URL

setWebsignalsRegistrationUrl

void setWebsignalsRegistrationUrl(String websignalsRegistrationUrl)
Sets the Web Signals registration URL (a PPG URL).

Parameters:
websignalsRegistrationUrl - the Web Signals registration URL

getWebsignalsDeregistrationUrl

String getWebsignalsDeregistrationUrl()
Gets the subscriber deregistration URL for Web Signals.

Returns:
the Web Signals subscriber deregistration URL

setWebsignalsDeregistrationUrl

void setWebsignalsDeregistrationUrl(String value)
Sets the subscriber deregistration URL for Web Signals.

Parameters:
value - the Web Signals subscriber deregistration URL

getWebsignalsSuspendUrl

String getWebsignalsSuspendUrl()
Gets the suspend subscription URL for Web Signals.

Returns:
the Web Signals suspend subscription URL

setWebsignalsSuspendUrl

void setWebsignalsSuspendUrl(String value)
Sets the suspend subscription URL for Web Signals.

Parameters:
value - the Web Signals suspend subscription URL

getWebsignalsResumeUrl

String getWebsignalsResumeUrl()
Gets the resume subscription URL for Web Signals.

Returns:
the Web Signals resume subscription URL

setWebsignalsResumeUrl

void setWebsignalsResumeUrl(String value)
Sets the resume subscription URL for Web Signals.

Parameters:
value - the Web Signals resume subscription URL

getDtdDeclarationPublic

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).
Note: This property should not be changed unless the PPG changes it for some reason first!

Returns:
the DTD declaration

setDtdDeclarationPublic

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).
Note: This property should not be changed unless the PPG changes it for some reason first!

Parameters:
value - the DTD declaration

getDtdDeclarationEnterprise

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).
Note: This property should not be changed unless the PPG changes it for some reason first!

Returns:
the DTD declaration

setDtdDeclarationEnterprise

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).
Note: This property should not be changed unless the PPG changes it for some reason first!

Parameters:
value - the DTD declaration


Copyright © 2011 Research In Motion. All Rights Reserved.