001/*
002 * (C) Copyright 2017 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     dmetzler
018 */
019package org.nuxeo.launcher.config.backingservices;
020
021import org.nuxeo.launcher.config.ConfigurationException;
022import org.nuxeo.launcher.config.ConfigurationGenerator;
023
024/**
025 * A backing checker checks for the availability of a backing service.
026 *
027 * @since 9.2
028 */
029public interface BackingChecker {
030
031    /**
032     * Test if the check has to be done for the given configuration.
033     * @param cg The current configuration
034     * @return true if {@link BackingChecker#check(ConfigurationGenerator)} has to be called.
035     */
036    boolean accepts(ConfigurationGenerator cg);
037
038    /**
039     * Test the availbilty of the backing service.
040     * @param cg The current configuration
041     * @throws ConfigurationException if backing service is not available.
042     */
043    void check(ConfigurationGenerator cg) throws ConfigurationException;
044}