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.util.Map;
020
021/**
022 * Represents a Service.
023 *
024 * @see ServiceChooser
025 * @see ServiceDiscovery
026 */
027public interface ServiceDefinition {
028
029    /**
030     * Gets the service name.
031     */
032    String getName();
033
034    /**
035     * Gets the IP or hostname of the server hosting the service.
036     */
037    String getHost();
038
039    /**
040     * Gets the port number of the server hosting the service.
041     */
042    int getPort();
043
044    /**
045     * Gets the health.
046     */
047    ServiceHealth getHealth();
048
049    /**
050     * Gets a key/value metadata associated with the service.
051     */
052    Map<String, String> getMetadata();
053}