org.apache.hadoop.gateway.ha.provider

Interface HaProvider

All Known Implementing Classes:

DefaultHaProvider

public interface HaProvider

Method Summary

Methods

Modifier and Type	Method and Description
void	addHaService(String serviceName, List<String> urls) Add a service name (role) as a HA service with the URLs that it is configured for
String	getActiveURL(String serviceName) Returns the current URL that is known to be active for the service
HaDescriptor	getHaDescriptor()
boolean	isHaEnabled(String serviceName) Returns whether the service is enabled for HA
void	markFailedURL(String serviceName, String url) Mark the URL for the service as one that has failed.

Method Detail

getHaDescriptor

HaDescriptor getHaDescriptor()

addHaService

void addHaService(String serviceName,
                List<String> urls)

Add a service name (role) as a HA service with the URLs that it is configured for

Parameters:

serviceName - the name of the service

urls - the list of urls that can be used for that service

isHaEnabled

boolean isHaEnabled(String serviceName)

Returns whether the service is enabled for HA

Parameters:

serviceName - the name of the service

Returns:

true if the service is enabled; false otherwise

getActiveURL

String getActiveURL(String serviceName)

Returns the current URL that is known to be active for the service

Parameters:

serviceName - the name of the service

Returns:

the URL as a string or null if the service name is not found

markFailedURL

void markFailedURL(String serviceName,
                 String url)

Mark the URL for the service as one that has failed. This method puts changes the active URL to the next available URL for the service.

Parameters:

serviceName - the name of the service

url - the URL that has failed in some way