Package org.apache.qpid.protonj2.client.util

Class ReconnectLocationPool

java.lang.Object

org.apache.qpid.protonj2.client.util.ReconnectLocationPool

public class ReconnectLocationPool
extends java.lang.Object

Manages the list of available reconnect entries that are used to connect and recover a connection.

Constructor Summary

Constructors

Constructor	Description
ReconnectLocationPool()	Creates an empty ReconnectLocationPool.
ReconnectLocationPool(java.util.List<ReconnectLocation> backups)	Creates a new ReconnectLocationPool with the provided ReconnectLocation values.

Method Summary

Modifier and Type	Method	Description
void	add(ReconnectLocation entry)	Adds a new entry to the pool if not already contained within.
void	addAll(java.util.List<ReconnectLocation> additions)	Adds a list of new ReconnectLocation values to the pool if not already contained within.
void	addFirst(ReconnectLocation entry)	Adds a new ReconnectLocation to the pool if not already contained within.
java.util.List<ReconnectLocation>	getList()	Gets the current list of ReconnectLocation values.
ReconnectLocation	getNext()	Returns the next entry in the pool of entries.
boolean	isEmpty()
boolean	remove(ReconnectLocation entry)	Remove a ReconnectLocation from the pool if present, otherwise has no effect.
void	removeAll()	Removes all currently configured ReconnectLocation from the pool, no new ReconnectLocation values will be served from this pool until new ones are added.
void	replaceAll(java.util.List<ReconnectLocation> replacements)	Removes all currently configured ReconnectLocation values from the pool and replaces them with the new set given.
void	shuffle()	Randomizes the order of the list of entries contained within the pool.
int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReconnectLocationPool

public ReconnectLocationPool()

Creates an empty ReconnectLocationPool.

ReconnectLocationPool

public ReconnectLocationPool(java.util.List<ReconnectLocation> backups)

Creates a new ReconnectLocationPool with the provided ReconnectLocation values.

Parameters:

backups - a list of location where a reconnection attempt should be made.

Method Detail

size

public int size()

Returns:

the current size of the entry pool.

isEmpty

public boolean isEmpty()

Returns:

true if the entry pool is empty.

getNext

public ReconnectLocation getNext()

Returns the next entry in the pool of entries. The entry will be shifted to the end of the list and not be attempted again until the full list has been returned once.

Returns:

the next entry that should be used for a connection attempt.

shuffle

public void shuffle()

Randomizes the order of the list of entries contained within the pool.

add

public void add(ReconnectLocation entry)

Adds a new entry to the pool if not already contained within.

Parameters:

entry - The new ReconnectLocation to add to the pool.

addAll

public void addAll(java.util.List<ReconnectLocation> additions)

Adds a list of new ReconnectLocation values to the pool if not already contained within.

Parameters:

additions - The new list of ReconnectLocation to add to the pool.

addFirst

public void addFirst(ReconnectLocation entry)

Adds a new ReconnectLocation to the pool if not already contained within. The ReconnectLocation is added to the head of the pooled ReconnectLocation list and will be the next value that is returned from the pool.

Parameters:

entry - The new ReconnectLocation to add to the pool.

remove

public boolean remove(ReconnectLocation entry)

Remove a ReconnectLocation from the pool if present, otherwise has no effect.

Parameters:

entry - The ReconnectLocation to attempt to remove from the pool.

Returns:

true if the given ReconnectLocation was removed from the pool.

removeAll

public void removeAll()

Removes all currently configured ReconnectLocation from the pool, no new ReconnectLocation values will be served from this pool until new ones are added.

replaceAll

public void replaceAll(java.util.List<ReconnectLocation> replacements)

Removes all currently configured ReconnectLocation values from the pool and replaces them with the new set given.

Parameters:

replacements - The new set of reconnect ReconnectLocation values to serve from this pool.

getList

public java.util.List<ReconnectLocation> getList()

Gets the current list of ReconnectLocation values. The returned list is a copy.

Returns:

a copy of the current list of ReconnectLocation values in the pool.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object