gerrit.onap Code Review - dcaegen2/services/sdk.git/blob

   1 /*
   2  * ============LICENSE_START====================================
   3  * DCAEGEN2-SERVICES-SDK
   4  * =========================================================
   5  * Copyright (C) 2019 Nokia. All rights reserved.
   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 package org.onap.dcaegen2.services.sdk.model.streams.dmaap;
  21
  22
  23 import com.google.gson.annotations.SerializedName;
  24 import org.jetbrains.annotations.Nullable;
  25
  26 /**
  27  * @author <a href="mailto:piotr.jaszczyk@nokia.com">Piotr Jaszczyk</a>
  28  * @since 1.1.4
  29  */
  30 public interface DataRouter {
  31
  32     /**
  33      * DCAE location for the publisher, used to set up routing.
  34      */
  35     @SerializedName("location")
  36     @Nullable String location();
  37
  38     /**
  39      * Username
  40      * <ul>
  41      * <li>Data Router uses to authenticate to the subscriber when delivering files OR</li>
  42      * <li>the publisher uses to authenticate to Data Router.</li>
  43      * </ul>
  44      */
  45     @SerializedName("username")
  46     @Nullable String username();
  47
  48     /**
  49      * Password
  50      * <ul>
  51      * <li>Data Router uses to authenticate to the subscriber when delivering files OR</li>
  52      * <li>the publisher uses to authenticate to Data Router.</li>
  53      * </ul>
  54      */
  55     @SerializedName("password")
  56     @Nullable String password();
  57 }