common/src/main/java/org/onap/so/client/cds/CDSProperties.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 - 2019 Bell Canada.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.client.cds;
  22
  23 import java.util.concurrent.TimeUnit;
  24 import org.onap.so.client.RestProperties;
  25
  26 public interface CDSProperties extends RestProperties {
  27
  28     String getHost();
  29
  30     int getPort();
  31
  32     String getBasicAuth();
  33
  34     int getTimeout();
  35
  36     boolean getUseSSL();
  37
  38     boolean getUseBasicAuth();
  39
  40     /**
  41      * Gets grpc keep alive ping interval, which is useful for detecting connection issues when the server dies
  42      * abruptly. If the value is set lower than what is allowed by the server (default 5 min), the connection will be
  43      * closed after a few pings.
  44      *
  45      * If no value is set this method will default to 6 min (server default minimum + 1)
  46      *
  47      * @see io.grpc.netty.NettyChannelBuilder#keepAliveTime(long, TimeUnit)
  48      * @return
  49      */
  50     long getKeepAlivePingMinutes();
  51 }