/*
* 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.
*
* Contributions from 2013-2017 where performed either by US government
* employees, or under US Veterans Health Administration contracts.
*
* US Veterans Health Administration contributions by government employees
* are work of the U.S. Government and are not subject to copyright
* protection in the United States. Portions contributed by government
* employees are USGovWork (17USC ยง105). Not subject to copyright.
*
* Contribution by contractors to the US Veterans Health Administration
* during this period are contractually contributed under the
* Apache License, Version 2.0.
*
* See: https://www.usa.gov/government-works
*
* Contributions prior to 2013:
*
* Copyright (C) International Health Terminology Standards Development Organisation.
* Licensed under the Apache License, Version 2.0.
*
*/
package sh.isaac.api;
//~--- JDK imports ------------------------------------------------------------
import java.util.List;
import java.util.Optional;
//~--- non-JDK imports --------------------------------------------------------
import javafx.util.Pair;
import org.jvnet.hk2.annotations.Contract;
//~--- interfaces -------------------------------------------------------------
/**
* The Interface SystemStatusService.
*/
@Contract
public interface SystemStatusService {
/**
* Services which fail to start up correctly should call this to store the details of the failure.
*
* @param serviceName The name of the service that failed to start
* @param failureDetails The reason the service failed to start
*/
public void notifyServiceConfigurationFailure(String serviceName, Exception failureDetails);
//~--- get methods ---------------------------------------------------------
/**
* Gets the service configuration failures.
*
* @return The services (if any) that failed to start correctly.
*/
public Optional<List<Pair<String, Exception>>> getServiceConfigurationFailures();
}