com.neeve.config

Interface IConfigProvider

All Known Implementing Classes:

ConfigProviderBase, MemConfigProvider, PftConfigProvider

public interface IConfigProvider

Represents a configuration provider.

This interface identifies a configuration provider. Each configuration provider plug-in implements this interface.

Threading:

A configuration provider is not safe for concurrent access by multiple threads.

Method Summary

Methods

Modifier and Type	Method and Description
IConfigRepository	createRepository(UtlAddressDescriptor descriptor) Create a configuration repository.
String	getName() Get the provider name
IConfigRepository	openRepository(UtlAddressDescriptor descriptor) Open a configuration repository.
boolean	repositoryExists(UtlAddressDescriptor descriptor) Check if a configuration repository exists.

Method Detail

getName

String getName()

Get the provider name

createRepository

IConfigRepository createRepository(UtlAddressDescriptor descriptor)
                                   throws EConfigException

Create a configuration repository.

Parameters:

descriptor - The repository descriptor used to describe the repository to create.

Throws:

EConfigException - Thrown in case an error occurs during the creation of the repository

Threading:

This method is not safe for concurrent access by multiple threads.

openRepository

IConfigRepository openRepository(UtlAddressDescriptor descriptor)
                                 throws EConfigException

Open a configuration repository.

Parameters:

descriptor - The repository descriptor used to describe the repository to open.

Throws:

EConfigException - Thrown in case an error occurs during the opening of the repository

Threading:

This method is not safe for concurrent access by multiple threads.

repositoryExists

boolean repositoryExists(UtlAddressDescriptor descriptor)

Check if a configuration repository exists.

Parameters:

descriptor - The repository descriptor used to describe the repository to check for.

Threading:

This method is not safe for concurrent access by multiple threads.