001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.cloud;
018
019import java.net.URI;
020import java.util.Collections;
021import java.util.Map;
022import java.util.Optional;
023
024public interface ServiceHealth {
025
026    /**
027     * Gets a key/value metadata associated with the service.
028     */
029    default Map<String, String> getMetadata() {
030        return Collections.EMPTY_MAP;
031    }
032
033    /**
034     * States if the service is healthy or not
035     */
036    default boolean isHealthy() {
037        return true;
038    }
039
040    /**
041     * The health enpoint exposed by the service.
042     */
043    default Optional<URI> getEndpoint() {
044        return Optional.empty();
045    }
046}