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.rest.services.cbs.client.model.streams.dmaap;
  21
  22 import com.google.gson.annotations.SerializedName;
  23 import org.jetbrains.annotations.Nullable;
  24 import org.onap.dcaegen2.services.sdk.rest.services.annotations.ExperimentalApi;
  25 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.streams.AafCredentials;
  26
  27 /**
  28  * @author <a href="mailto:piotr.jaszczyk@nokia.com">Piotr Jaszczyk</a>
  29  * @since 1.1.4
  30  */
  31 @ExperimentalApi
  32 public interface MessageRouter {
  33
  34     /**
  35      * URL for accessing the topic to publish or receive events.
  36      */
  37     @SerializedName("topic_url")
  38     String topicUrl();
  39
  40     /**
  41      * AAF client role that’s requesting publish or subscribe access to the topic.
  42      */
  43     @SerializedName("client_role")
  44     @Nullable String clientRole();
  45
  46     /**
  47      * Client id for given AAF client.
  48      */
  49     @SerializedName("client_id")
  50     @Nullable String clientId();
  51
  52     /**
  53      * DCAE location for the publisher or subscriber, used to set up routing.
  54      */
  55     @SerializedName("location")
  56     @Nullable String location();
  57
  58     /**
  59      * The AAF credentials.
  60      */
  61     @SerializedName("aaf_credentials")
  62     @Nullable AafCredentials aafCredentials();
  63 }