org.opennms.features.geocoder.service

Class DefaultGeocoderServiceManager

java.lang.Object

org.opennms.features.geocoder.service.DefaultGeocoderServiceManager

All Implemented Interfaces:

GeocoderServiceManager

public class DefaultGeocoderServiceManager
extends Object
implements GeocoderServiceManager

Constructor Summary

Constructors

Constructor and Description
DefaultGeocoderServiceManager(org.osgi.framework.BundleContext bundleContext, org.osgi.service.cm.ConfigurationAdmin configurationAdmin, GeocoderServiceManagerConfiguration configuration)

Method Summary

Modifier and Type	Method and 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(String geocoderId) Returns the GeocoderService identified by the provided geocoderId
List<GeocoderService>	getGeocoderServices() Returns all registered GeocoderService.
void	resetConfiguration() Deletes all configuration files related to the geocoder service.
void	updateConfiguration(GeocoderServiceManagerConfiguration newConfiguration) Updates the configuration for the service manager
void	updateGeocoderConfiguration(String geocoderId, Map<String,Object> newProperties) Updates the configuration for the GeocoderService with the provided id.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGeocoderServiceManager

public DefaultGeocoderServiceManager(org.osgi.framework.BundleContext bundleContext,
                                     org.osgi.service.cm.ConfigurationAdmin configurationAdmin,
                                     GeocoderServiceManagerConfiguration configuration)

Method Detail

resetConfiguration

public void resetConfiguration()
                        throws IOException

Description copied from interface: GeocoderServiceManager

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

Specified by:

resetConfiguration in interface GeocoderServiceManager

Throws:

IOException - when deleting the configuration files failed.

updateConfiguration

public void updateConfiguration(GeocoderServiceManagerConfiguration newConfiguration)
                         throws IOException

Description copied from interface: GeocoderServiceManager

Updates the configuration for the service manager

Specified by:

updateConfiguration in interface GeocoderServiceManager

Throws:

IOException - when writing the configuration file failed

getConfiguration

public GeocoderServiceManagerConfiguration getConfiguration()

Description copied from interface: GeocoderServiceManager

Returns the configuration for the service manager

Specified by:

getConfiguration in interface GeocoderServiceManager

Returns:

the configuration for the service manager

getActiveGeocoderService

public GeocoderService getActiveGeocoderService()

Description copied from interface: GeocoderServiceManager

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

Specified by:

getActiveGeocoderService in interface GeocoderServiceManager

Returns:

the current active GeocoderService or null if none is active.

getGeocoderServices

public List<GeocoderService> getGeocoderServices()

Description copied from interface: GeocoderServiceManager

Returns all registered GeocoderService. None of those may be active

Specified by:

getGeocoderServices in interface GeocoderServiceManager

Returns:

all registered GeocoderService.

updateGeocoderConfiguration

public void updateGeocoderConfiguration(String geocoderId,
                                        Map<String,Object> newProperties)
                                 throws IOException,
                                        GeocoderConfigurationException

Description copied from interface: GeocoderServiceManager

Updates the configuration for the GeocoderService with the provided id.

Specified by:

updateGeocoderConfiguration in interface GeocoderServiceManager

Parameters:

geocoderId - The id of the GeocoderService to update

newProperties - The new configuration of the GeocoderService

Throws:

IOException - in case the configuration could not be persisted

GeocoderConfigurationException

getGeocoderService

public GeocoderService getGeocoderService(String geocoderId)

Description copied from interface: GeocoderServiceManager

Returns the GeocoderService identified by the provided geocoderId

Specified by:

getGeocoderService in interface GeocoderServiceManager

Parameters:

geocoderId - The id of the GeocoderService to return.

Returns:

the GeocoderService identified by the provided geocoderId