information-coordinator-service/src/main/java/org/oransc/ics/controllers/r1consumer/ConsumerConsts.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2020 Nordix Foundation
   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.oransc.ics.controllers.r1consumer;
  22
  23 public class ConsumerConsts {
  24
  25     public static final String API_ROOT = "/data-consumer/v1";
  26
  27     public static final String CONSUMER_API_NAME = "Data consumer";
  28     public static final String CONSUMER_API_CALLBACKS_NAME = "Data consumer (callbacks)";
  29     public static final String CONSUMER_API_DESCRIPTION = "API for data consumers";
  30
  31     public static final String OWNER_PARAM = "owner";
  32     public static final String OWNER_PARAM_DESCRIPTION = "selects result for one owner";
  33
  34     public static final String INDIVIDUAL_JOB = "Individual data subscription job";
  35
  36     public static final String PUT_INDIVIDUAL_JOB_DESCRIPTION = "The job will be enabled when a producer is available";
  37
  38     public static final String INFO_TYPE_ID_PARAM = "infoTypeId";
  39     public static final String INFO_TYPE_ID_PARAM_DESCRIPTION =
  40         "selects subscription jobs of matching information type";
  41     public static final String INFO_TYPE_ID_PATH = "infoTypeId";
  42
  43     public static final String INFO_JOB_ID_PATH = "infoJobId";
  44
  45     public static final String SUBSCRIPTION_ID_PATH = "subscriptionId";
  46
  47     public static final String PERFORM_TYPE_CHECK_PARAM = "typeCheck";
  48     public static final String PERFORM_TYPE_CHECK_PARAM_DESCRIPTION =
  49         "when true, a validation of that the type exists and that the job matches the type schema.";
  50
  51     public static final String INDIVIDUAL_TYPE_SUBSCRIPTION =
  52         "Individual subscription for information types (registration/deregistration)";
  53
  54     public static final String TYPE_SUBSCRIPTION_DESCRIPTION =
  55         "This service operation is used to subscribe to notifications for changes in the availability of data types.";
  56
  57     private ConsumerConsts() {
  58     }
  59 }