Package org.opennms.features.geocoder

Interface GeocoderServiceManager

All Known Implementing Classes:

DefaultGeocoderServiceManager

public interface GeocoderServiceManager

Manager interface to the underlying GeocoderServices.

Author:

mvrueden

Method Summary

Modifier and Type	Method	Description
GeocoderService	getActiveGeocoderService()	Returns the current active GeocoderService or null if none is active.
GeocoderServiceManagerConfiguration	getConfiguration()	Returns the configuration for the service manager
GeocoderService	getGeocoderService(java.lang.String geocoderId)	Returns the GeocoderService identified by the provided geocoderId
java.util.List<GeocoderService>	getGeocoderServices()	Returns all registered GeocoderService.
void	resetConfiguration()	Deletes all configuration files related to the geocoder service.
void	updateConfiguration(GeocoderServiceManagerConfiguration configuration)	Updates the configuration for the service manager
void	updateGeocoderConfiguration(java.lang.String geocoderId, java.util.Map<java.lang.String,java.lang.Object> newProperties)	Updates the configuration for the GeocoderService with the provided id.

Method Detail

resetConfiguration

void resetConfiguration()
                 throws java.io.IOException

Deletes all configuration files related to the geocoder service. This results in falling back to the defaults

Throws:

java.io.IOException - when deleting the configuration files failed.

updateConfiguration

void updateConfiguration(GeocoderServiceManagerConfiguration configuration)
                  throws java.io.IOException

Updates the configuration for the service manager

Throws:

java.io.IOException - when writing the configuration file failed

getConfiguration

GeocoderServiceManagerConfiguration getConfiguration()

Returns the configuration for the service manager

Returns:

the configuration for the service manager

getActiveGeocoderService

GeocoderService getActiveGeocoderService()

Returns the current active GeocoderService or null if none is active.

Returns:

the current active GeocoderService or null if none is active.

updateGeocoderConfiguration

void updateGeocoderConfiguration(java.lang.String geocoderId,
                                 java.util.Map<java.lang.String,java.lang.Object> newProperties)
                          throws java.io.IOException,
                                 java.util.NoSuchElementException

Updates the configuration for the GeocoderService with the provided id.

Parameters:

geocoderId - The id of the GeocoderService to update

newProperties - The new configuration of the GeocoderService

Throws:

java.io.IOException - in case the configuration could not be persisted

java.util.NoSuchElementException - if a GeocoderService witht he provided geocoderId does not exist.

getGeocoderServices

java.util.List<GeocoderService> getGeocoderServices()

Returns all registered GeocoderService. None of those may be active

Returns:

all registered GeocoderService.

getGeocoderService

GeocoderService getGeocoderService(java.lang.String geocoderId)
                            throws java.util.NoSuchElementException

Returns the GeocoderService identified by the provided geocoderId

Parameters:

geocoderId - The id of the GeocoderService to return.

Returns:

the GeocoderService identified by the provided geocoderId

Throws:

java.util.NoSuchElementException - if the GeocoderService with the provided geocoderId does not exist.