ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/service/ConsulHealthService.java

   1 /*-
   2  * ============LICENSE_START==========================================
   3  * ONAP Portal
   4  * ===================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ===================================================================
   7  *
   8  * Unless otherwise specified, all software contained herein is licensed
   9  * under the Apache License, Version 2.0 (the "License");
  10  * you may not use this software except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *             http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * Unless otherwise specified, all documentation contained herein is licensed
  22  * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
  23  * you may not use this documentation except in compliance with the License.
  24  * You may obtain a copy of the License at
  25  *
  26  *             https://creativecommons.org/licenses/by/4.0/
  27  *
  28  * Unless required by applicable law or agreed to in writing, documentation
  29  * distributed under the License is distributed on an "AS IS" BASIS,
  30  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  31  * See the License for the specific language governing permissions and
  32  * limitations under the License.
  33  *
  34  * ============LICENSE_END============================================
  35  *
  36  *
  37  */
  38 package org.onap.portalapp.portal.service;
  39
  40 import java.util.List;
  41
  42 import org.onap.portalapp.portal.exceptions.NoHealthyServiceException;
  43
  44 import com.ecwid.consul.ConsulException;
  45 import com.orbitz.consul.model.health.ServiceHealth;
  46
  47 public interface ConsulHealthService {
  48         /**
  49          * This method returns the location of one healthy node if found in Consul -
  50          * If not found in / by Consul, it falls back to 'localhost'
  51          *
  52          * @param service
  53          * @param fallbackPortOnLocalhost
  54          *            value provided by the calling service
  55          * @return Service location
  56          */
  57         public String getServiceLocation(String service, String fallbackPortOnLocalhost) throws NoHealthyServiceException;
  58
  59         public List<ServiceHealth> getAllHealthyNodes(String service) throws ConsulException;
  60
  61         public List<ServiceHealth> getAllNodes(String service) throws ConsulException;
  62 }