com.hp.autonomy.frontend.configuration.WriteableConfigService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of configuration-api Show documentation

Java Configuration API

There is a newer version: 2.1.0

/*
 * Copyright 2013-2015 Open Text.
 *
 * Licensed under the MIT License (the "License"); you may not use this file
 * except in compliance with the License.
 *
 * The only warranties for products and services of Open Text and its affiliates
 * and licensors ("Open Text") are as may be set forth in the express warranty
 * statements accompanying such products and services. Nothing herein should be
 * construed as constituting an additional warranty. Open Text shall not be
 * liable for technical or editorial errors or omissions contained herein. The
 * information contained herein is subject to change without notice.
 */

package com.hp.autonomy.frontend.configuration;

/**
 * A {@link ConfigService} which allows the config to be updated.
 * @param 
 */
public interface WriteableConfigService extends ConfigService {

    /**
     * Updates the configuration to the given config.
     *
     * This method should be thread safe.
     *
     * @param config The new config
     * @throws Exception If an error occurs while saving the config
     */
    @SuppressWarnings("ProhibitedExceptionDeclared")
    void updateConfig(final T config) throws Exception;

    /**
     * Must be called before the config is updated to allow properties to be added or removed. This method can be
     * implemented as an identity method.
     *
     * @param config The config to be modified.
     * @return A new config where the changes have been applied.
     */
    T preUpdate(final T config);

    /**
     * Must be called by the updateConfig method after the config object has been updated successfully. This method can
     * be implemented as a no-op.
     *
     * @param config The newly updated config object
     * @throws Exception
     */
    void postUpdate(final T config) throws Exception;

}