org.asynchttpclient.extras.registry

Interface AsyncHttpClientRegistry

All Known Implementing Classes:

AsyncHttpClientRegistryImpl

public interface AsyncHttpClientRegistry

Method Summary

Modifier and Type	Method and Description
AsyncHttpClient	addOrReplace(String name, AsyncHttpClient client) Registers this instance of AsyncHttpClient with this name and returns back a null if an instance with the same name never existed but will return back the previous instance if there was another instance registered with the same name and has been replaced by this one.
void	clearAllInstances() Removes all instances from this registry.
AsyncHttpClient	get(String name) Returns back the AsyncHttpClient associated with this name
Set<String>	getAllRegisteredNames()
boolean	registerIfNew(String name, AsyncHttpClient client) Will register only if an instance with this name doesn't exist and if it does exist will not replace this instance and will return false.
boolean	unregister(String name) Remove the instance associate with this name

Method Detail

get

AsyncHttpClient get(String name)

Returns back the AsyncHttpClient associated with this name

Parameters:

name - the name of the client instance in the registry

Returns:

the client

addOrReplace

AsyncHttpClient addOrReplace(String name,
                             AsyncHttpClient client)

Registers this instance of AsyncHttpClient with this name and returns back a null if an instance with the same name never existed but will return back the previous instance if there was another instance registered with the same name and has been replaced by this one.

Parameters:

name - the name of the client instance in the registry

client - the client instance

Returns:

the previous instance

registerIfNew

boolean registerIfNew(String name,
                      AsyncHttpClient client)

Will register only if an instance with this name doesn't exist and if it does exist will not replace this instance and will return false. Use it in the following way:

      AsyncHttpClient ahc = AsyncHttpClientFactory.getAsyncHttpClient();      
      if(!AsyncHttpClientRegistryImpl.getInstance().registerIfNew(“MyAHC”,ahc)){
          //An instance with this name is already registered so close ahc 
          ahc.close(); 
          //and do necessary cleanup
      }
 

Parameters:

name - the name of the client instance in the registry

client - the client instance

Returns:

true is the client was indeed registered

unregister

boolean unregister(String name)

Remove the instance associate with this name

Parameters:

name - the name of the client instance in the registry

Returns:

true is the client was indeed unregistered

getAllRegisteredNames

Set<String> getAllRegisteredNames()

Returns:

all registered names

clearAllInstances

void clearAllInstances()

Removes all instances from this registry.