com.tangosol.net

Class CompositeSocketAddressProvider

java.lang.Object

com.tangosol.net.CompositeSocketAddressProvider

All Implemented Interfaces:

SocketAddressProvider

public class CompositeSocketAddressProvider
extends Object
implements SocketAddressProvider

CompositeSocketAddressProvider is a composite of one or more SocketAddressProviders. This SocketAddressProvider will provide addresses from all registered providers or addresses.

Since:

Coherence 12.1.2

Author:

phf 2012.03.05

Constructor Summary

Constructors

Constructor and Description
CompositeSocketAddressProvider(SocketAddress address) Construct a CompositeSocketAddressProvider from the specified SocketAddress.
CompositeSocketAddressProvider(SocketAddressProvider provider) Construct a CompositeSocketAddressProvider from the specified SocketAddressProvider.

Method Summary

Modifier and Type	Method and Description
void	accept() This method should be called by the client immediately after it determines that it can successfully use an address returned by the SocketAddressProvider.getNextAddress() method.
void	addAddress(SocketAddress address) Add a SocketAddress.
void	addProvider(SocketAddressProvider provider) Add a SocketAddressProvider.
SocketAddress	getNextAddress() Obtain a next available address to use.
void	reject(Throwable eCause) This method should be called by the client immediately after it determines that an attempt to use an address returned by the SocketAddressProvider.getNextAddress() method has failed.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.net.SocketAddressProvider

equals, hashCode

Constructor Detail

CompositeSocketAddressProvider

public CompositeSocketAddressProvider(SocketAddress address)

Construct a CompositeSocketAddressProvider from the specified SocketAddress.

Parameters:

address - the initial wrapped SocketAddress

CompositeSocketAddressProvider

public CompositeSocketAddressProvider(SocketAddressProvider provider)

Construct a CompositeSocketAddressProvider from the specified SocketAddressProvider.

Parameters:

provider - the initial wrapped SocketAddressProvider

Method Detail

addAddress

public void addAddress(SocketAddress address)

Add a SocketAddress.

Parameters:

address - the SocketAddress to add

addProvider

public void addProvider(SocketAddressProvider provider)

Add a SocketAddressProvider.

Parameters:

provider - the SocketAddressProvider to add

accept

public void accept()

This method should be called by the client immediately after it determines that it can successfully use an address returned by the SocketAddressProvider.getNextAddress() method.

Specified by:

accept in interface SocketAddressProvider

reject

public void reject(Throwable eCause)

This method should be called by the client immediately after it determines that an attempt to use an address returned by the SocketAddressProvider.getNextAddress() method has failed.

Specified by:

reject in interface SocketAddressProvider

Parameters:

eCause - (optional) an exception that carries the reason why the the caller rejected the previously returned address

getNextAddress

public SocketAddress getNextAddress()

Obtain a next available address to use. If the caller can successfully use the returned address (e.g. a connection was established), it should call the SocketAddressProvider's SocketAddressProvider.accept() method.

Specified by:

getNextAddress in interface SocketAddressProvider

Returns:

the next available address or null if the list of available addresses was exhausted

toString

public String toString()

Overrides:

toString in class Object