org.ice4j.ice.harvest

Class MappingCandidateHarvesters

java.lang.Object

org.ice4j.ice.harvest.MappingCandidateHarvesters

public class MappingCandidateHarvesters
extends Object

Manages a static list of MappingCandidateHarvester instances, created according to configuration provided as system properties. The instances in the set are safe to use by any Agents.

Author:

Damian Minkov, Boris Grozev

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLE_AWS_HARVESTER_PNAME The name of the property used to disable the AWS harvester.
static String	FORCE_AWS_HARVESTER_PNAME The name of the property which forces the use of the AWS harvester.
private static MappingCandidateHarvester[]	harvesters The list of already configured harvesters.
private static boolean	initialized Whether harvesters has been initialized.
private static Logger	logger The Logger used by the MappingCandidateHarvesters class for logging output.
static String	NAT_HARVESTER_LOCAL_ADDRESS_PNAME The name of the property that specifies the local address, if any, for the pre-configured NAT harvester.
static String	NAT_HARVESTER_PUBLIC_ADDRESS_PNAME The name of the property that specifies the public address, if any, for the pre-configured NAT harvester.
static String	STUN_MAPPING_HARVESTER_ADDRESSES_PNAME The name of the property which contains the addresses of the STUN servers to use for the STUN mapping harvester.
static boolean	stunDiscoveryFailed Whether the discovery of a public address via STUN has failed.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MappingCandidateHarvesters() Prevent instance creation.

Method Summary

Modifier and Type	Method and Description
private static List<StunMappingCandidateHarvester>	createStunHarvesters(String[] stunServers) Creates STUN mapping harvesters for each of the given STUN servers, and waits for address discovery to finish for all of them.
static MappingCandidateHarvester[]	getHarvesters()
static void	initialize() Initializes harvesters.
private static void	maybeAdd(MappingCandidateHarvester harvester, List<MappingCandidateHarvester> harvesters) Adds harvester to harvesters, if it has valid addresses and harvesters doesn't already contain a harvester with the same addresses.
private static List<MappingCandidateHarvester>	prune(List<MappingCandidateHarvester> harvesters) Prunes a list of mapping harvesters, removing the ones without valid addresses and those with duplicate addresses.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

The Logger used by the MappingCandidateHarvesters class for logging output.

NAT_HARVESTER_LOCAL_ADDRESS_PNAME

public static final String NAT_HARVESTER_LOCAL_ADDRESS_PNAME

The name of the property that specifies the local address, if any, for the pre-configured NAT harvester.

See Also:

Constant Field Values

NAT_HARVESTER_PUBLIC_ADDRESS_PNAME

public static final String NAT_HARVESTER_PUBLIC_ADDRESS_PNAME

The name of the property that specifies the public address, if any, for the pre-configured NAT harvester.

See Also:

Constant Field Values

DISABLE_AWS_HARVESTER_PNAME

public static final String DISABLE_AWS_HARVESTER_PNAME

The name of the property used to disable the AWS harvester.

See Also:

Constant Field Values

FORCE_AWS_HARVESTER_PNAME

public static final String FORCE_AWS_HARVESTER_PNAME

The name of the property which forces the use of the AWS harvester.

See Also:

Constant Field Values

STUN_MAPPING_HARVESTER_ADDRESSES_PNAME

public static final String STUN_MAPPING_HARVESTER_ADDRESSES_PNAME

The name of the property which contains the addresses of the STUN servers to use for the STUN mapping harvester. The property should contain a comma-separated list of addresses (pairs of IP address and port, separated by a colon). Example: stun1.example.com:12345,stun2.example.com:23456

See Also:

Constant Field Values

initialized

private static boolean initialized

Whether harvesters has been initialized.

harvesters

private static MappingCandidateHarvester[] harvesters

The list of already configured harvesters.

stunDiscoveryFailed

public static boolean stunDiscoveryFailed

Whether the discovery of a public address via STUN has failed. It is considered failed if the configuration included at least one STUN server, but we failed to receive at least one valid response. Note that this defaults to false and is only raised after we are certain we failed (i.e. after our STUN transactions timeout).

Constructor Detail

MappingCandidateHarvesters

private MappingCandidateHarvesters()

Prevent instance creation.

Method Detail

getHarvesters

public static MappingCandidateHarvester[] getHarvesters()

Returns:

the list of configured harvesters.

initialize

public static void initialize()

Initializes harvesters. First it reads the configuration and instantiates harvesters accordingly, waiting for their initialization (which may include network communication and thus take a long time). Then it removes harvesters which failed to initialize properly and remove any harvesters with duplicate addresses. Three types of mapping harvesters are supported: NAT (with pre-configured addresses), AWS and STUN.

prune

private static List<MappingCandidateHarvester> prune(List<MappingCandidateHarvester> harvesters)

Prunes a list of mapping harvesters, removing the ones without valid addresses and those with duplicate addresses.

Parameters:

harvesters - the list of harvesters.

Returns:

the pruned list.

maybeAdd

private static void maybeAdd(MappingCandidateHarvester harvester,
                             List<MappingCandidateHarvester> harvesters)

Adds harvester to harvesters, if it has valid addresses and harvesters doesn't already contain a harvester with the same addresses.

Parameters:

harvester - the harvester to add.

harvesters - the list to add to.

createStunHarvesters

private static List<StunMappingCandidateHarvester> createStunHarvesters(String[] stunServers)

Creates STUN mapping harvesters for each of the given STUN servers, and waits for address discovery to finish for all of them.

Parameters:

stunServers - an array of STUN server addresses (ip_address:port pairs).

Returns:

the list of those who were successful in discovering an address.