org.simplejavamail.api.mailer.config

Enum LoadBalancingStrategy

java.lang.Object

java.lang.Enum<LoadBalancingStrategy>

org.simplejavamail.api.mailer.config.LoadBalancingStrategy

All Implemented Interfaces:

Serializable, Comparable<LoadBalancingStrategy>

public enum LoadBalancingStrategy
extends Enum<LoadBalancingStrategy>

Defines the various types of load balancing modes supported by the connection pool ion the batch-module.

This is only relevant if you have multiple mail servers in one or more clusters. Currently, it is impossible to define different load balancing strategies for different clusters.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RANDOM_ACCESS Randomly choose a connection pool (server) to request a connection (Transport) object from.
ROUND_ROBIN Fixed sequence, looping through all available connection pools in a cluster.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RANDOM_ACCESS_REF
static String	ROUND_ROBIN_REF

Method Summary

Modifier and Type	Method and Description
static LoadBalancingStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static LoadBalancingStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ROUND_ROBIN

public static final LoadBalancingStrategy ROUND_ROBIN

Fixed sequence, looping through all available connection pools in a cluster.

RANDOM_ACCESS

public static final LoadBalancingStrategy RANDOM_ACCESS

Randomly choose a connection pool (server) to request a connection (Transport) object from.

Field Detail

ROUND_ROBIN_REF

public static final String ROUND_ROBIN_REF

See Also:

Constant Field Values

RANDOM_ACCESS_REF

public static final String RANDOM_ACCESS_REF

See Also:

Constant Field Values

Method Detail

values

public static LoadBalancingStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LoadBalancingStrategy c : LoadBalancingStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LoadBalancingStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null