org.ops4j.pax.configmanager
Interface IConfigurationFileHandler

All Known Implementing Classes:

PropertiesFileConfigurationHandler

public interface IConfigurationFileHandler

Method Summary

boolean	canHandle(java.io.File file) Returns true if the specified file can be handled by this IConfigurationFileHandler.
java.lang.String	getServicePID(java.lang.String fileName) Returns the configuration name of the specified fileName.
java.util.Properties	handle(java.io.File file) Returns the properties after loading the specified file.

Method Detail

getServicePID

java.lang.String getServicePID(java.lang.String fileName)

Returns the configuration name of the specified fileName. The specified fileName must not have file path prefix. Returns null if the file name can not be handled by this handler.

Parameters:

fileName - The file name. This argument must not be null.

Returns:

Returns the service pid given the fileName argument.

handle

java.util.Properties handle(java.io.File file)

Returns the properties after loading the specified file. Returns empty properties if the specified file does not have any configuration properties.

Parameters:

file - The configuration file to be loaded. This argument must not be null.

Returns:

Returns the Properties of the specified file.

canHandle

boolean canHandle(java.io.File file)

Returns true if the specified file can be handled by this IConfigurationFileHandler.

Parameters:

file - The file to be handled. This argument must not be null.

Returns:

A boolean indicator whether this IConfigurationFileHandler able to handle file.