gerrit.onap Code Review - ccsdk/oran.git/blob

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   4  * ======================================================================
   5  * Copyright (C) 2019-2020 Nordix Foundation. 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
  21 package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2;
  22
  23 import com.fasterxml.jackson.annotation.JsonProperty;
  24 import com.google.gson.annotations.SerializedName;
  25
  26 import io.swagger.v3.oas.annotations.media.Schema;
  27 import io.swagger.v3.oas.annotations.media.Schema.RequiredMode;
  28
  29 @Schema(name = "policy_info_v2", description = "Information for one A1-P Policy")
  30 public class PolicyInfo {
  31
  32     @Schema(name = "policy_id", description = "identity of the policy", requiredMode = RequiredMode.REQUIRED)
  33     @JsonProperty(value = "policy_id", required = true)
  34     @SerializedName("policy_id")
  35     public String policyId;
  36
  37     @Schema(name = "policytype_id", description = "identity of the policy type", requiredMode = RequiredMode.REQUIRED)
  38     @JsonProperty(value = "policytype_id", required = true)
  39     @SerializedName("policytype_id")
  40     public String policyTypeId;
  41
  42     @Schema(name = "ric_id", description = "identity of the target Near-RT RIC", requiredMode = RequiredMode.REQUIRED)
  43     @JsonProperty(value = "ric_id", required = true)
  44     @SerializedName("ric_id")
  45     public String ricId;
  46
  47     @Schema(name = "policy_data", description = "the configuration of the policy", requiredMode = RequiredMode.REQUIRED)
  48     @JsonProperty(value = "policy_data", required = true)
  49     @SerializedName("policy_data")
  50     public Object policyData;
  51
  52     private static final String SERVICE_ID_DESCRIPTION = "the identity of the service owning the policy."
  53             + " This can be used to group the policies (it is possible to get all policies associated to a service)."
  54             + " Note that the service does not need to be registered.";
  55
  56     @Schema(name = "service_id", description = SERVICE_ID_DESCRIPTION, requiredMode = RequiredMode.NOT_REQUIRED,
  57             defaultValue = "")
  58     @JsonProperty(value = "service_id", required = false)
  59     @SerializedName("service_id")
  60     public String serviceId = "";
  61
  62     @Schema(name = "transient",
  63             description = "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.",
  64             requiredMode = RequiredMode.NOT_REQUIRED, defaultValue = "false", example = "false")
  65     @JsonProperty(value = "transient", required = false, defaultValue = "false")
  66     @SerializedName("transient")
  67     public boolean isTransient = false;
  68
  69     @Schema(name = "status_notification_uri", description = "Callback URI for policy status updates",
  70             requiredMode = RequiredMode.NOT_REQUIRED, defaultValue = "")
  71     @JsonProperty(value = "status_notification_uri", required = false)
  72     @SerializedName("status_notification_uri")
  73     public String statusNotificationUri = "";
  74
  75     PolicyInfo() {}
  76
  77     public boolean validate() {
  78         return policyId != null && policyTypeId != null && ricId != null && policyData != null && serviceId != null;
  79     }
  80
  81 }