org.jboss.aerogear.unifiedpush.message.configuration

Class SenderConfiguration

java.lang.Object

org.jboss.aerogear.unifiedpush.message.configuration.SenderConfiguration

public class SenderConfiguration
extends Object

Push Network specific configuration for UPS message sending mechanism. Allows to configure how are messages loaded and treated inside of UPS messaging system. Configurations for Push Networks are loaded by SenderConfigurationProvider.

See Also:

SenderConfigurationProvider

Constructor Summary

Constructors

Constructor and Description
SenderConfiguration()
SenderConfiguration(int batchesToLoad, int batchSize) Creates a new configuration with the configuration values provided

Method Summary

Modifier and Type	Method and Description
int	batchesToLoad() Specifies how many batches should be loaded in one token-loading transaction.
int	batchSize() Batch size specifies how many devices will be loaded and delivered in one batch.
int	tokensToLoad() This is a derived property, computed as a product of batchesToLoad() and batchSize().

Methods inherited from class java.lang.Object

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

Constructor Detail

SenderConfiguration

public SenderConfiguration()

SenderConfiguration

public SenderConfiguration(int batchesToLoad,
                           int batchSize)

Creates a new configuration with the configuration values provided

Parameters:

batchesToLoad - specifies how many batches should be loaded in one transaction (see batchesToLoad()

batchSize - specifies how many devices will be loaded and delivered in one batch (see batchSize()

Method Detail

batchesToLoad

public int batchesToLoad()

Specifies how many batches should be loaded in one token-loading transaction. UPS splits device tokens loaded from database into batches and loads at most batchesToLoad() in one transaction. This avoids long transactions and enables fail-over procedures.

Returns:

the number of batches to load

batchSize

public int batchSize()

Batch size specifies how many devices will be loaded and delivered in one batch. One batch is a unit of work for the final PushNotificationSender implementation. Smaller batches allows better fail-over, but can be unfriendly to the Push Network, since it has to allow UPS establish more connections. Larger batches allows for more effective communication, however you must be aware of memory limits configured for UPS message queues. One device token theoretically requires 2 * (upper-bound limit of its length) bytes of memory. The minimum or maximum lengths of specific push networks are partially listed in DeviceTokenValidator.

Returns:

the size (number of device tokens) of the batch

tokensToLoad

public int tokensToLoad()

This is a derived property, computed as a product of batchesToLoad() and batchSize(). It configures how many tokens will be loaded in one token-loading transaction.

Returns:

int value, computed as a product of batchesToLoad() and batchSize().