org.ops4j.pax.configmanager.IConfigurationFileHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pax-confman-propsloader Show documentation

Pax Configuration Manger Service provides a framework to read files (default property files handling is supplied) from a directory and use ConfigurationAdmin to update the service with the properties loaded.

The newest version!

/*
 * Licensed  under the  Apache License,  Version 2.0  (the "License");
 * you may not use  this file  except in  compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed  under the  License is distributed on an "AS IS" BASIS,
 * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
 * implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ops4j.pax.configmanager;

import java.io.File;
import java.util.Properties;

public interface IConfigurationFileHandler
{

    /**
     * Returns the configuration name of the specified {@code fileName}. The specified {@code fileName} must not have
     * file path prefix. Returns {@code null} if the file name can not be handled by this handler.
     *
     * @param fileName The file name. This argument must not be {@code null}.
     *
     * @return Returns the service pid given the {@code fileName} argument.
     */
    String getServicePID( String fileName );

    /**
     * Returns the properties after loading the specified {@code file}. Returns {@code empty} properties if the
     * specified {@code file} does not have any configuration properties.
     *
     * @param file The configuration file to be loaded. This argument must not be {@code null}.
     *
     * @return Returns the {@code Properties} of the specified {@code file}.
     */
    Properties handle( File file );

    /**
     * Returns {@code true} if the specified {@code file} can be handled by this {@code IConfigurationFileHandler}.
     *
     * @param file The file to be handled. This argument must not be {@code null}.
     *
     * @return A {@code boolean} indicator whether this {@code IConfigurationFileHandler} able to handle {@code file}.
     */
    boolean canHandle( File file );
}