ONAP-XACML/src/main/java/org/onap/policy/xacml/api/pap/OnapPAPPolicy.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP-XACML
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. 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.policy.xacml.api.pap;
  21
  22 import java.net.URI;
  23 import java.util.List;
  24 import java.util.Map;
  25
  26 import org.onap.policy.xacml.std.pap.StdPAPPolicy;
  27
  28 import com.fasterxml.jackson.annotation.JsonSubTypes;
  29 import com.fasterxml.jackson.annotation.JsonTypeInfo;
  30 import com.fasterxml.jackson.annotation.JsonSubTypes.Type;
  31
  32 /*
  33  * The following allows us to use Jackson to convert sub-types of this type into JSON and back to objects.
  34  */
  35 @JsonTypeInfo(
  36             use = JsonTypeInfo.Id.NAME,
  37             include = JsonTypeInfo.As.PROPERTY,
  38             property = "PAPPolicyType")
  39 @JsonSubTypes({
  40             @Type(value = StdPAPPolicy.class, name = "StdPAPPolicy") })
  41 public interface OnapPAPPolicy {
  42
  43         public String getPolicyName();
  44         public String getOldPolicyFileName();
  45         public String getPolicyDescription();
  46         public String getOnapName();
  47         public String getConfigName();
  48         public Map<String, String> getDynamicFieldConfigAttributes();
  49         public Map<String, String> getTreatments();
  50         public Map<String, String> getDynamicSettingsMap();
  51         public List<String> getDynamicRuleAlgorithmLabels();
  52         public List<String> getDynamicRuleAlgorithmCombo();
  53         public List<String> getDynamicRuleAlgorithmField1();
  54         public List<String> getDynamicRuleAlgorithmField2();
  55         public List<Object> getDynamicVariableList();
  56         public List<String> getDataTypeList();
  57         public String getConfigBodyData();
  58         public String getPolicyID();
  59         public String getRuleID();
  60         public String getConfigType();
  61         public Boolean isEditPolicy();
  62         public Boolean isDraft();
  63         public String getVersion();
  64         public String getDomainDir();
  65         public String getConfigPolicyType();
  66         public String getJsonBody();
  67         public Integer getHighestVersion();
  68         public URI getLocation();
  69         public String getActionPerformer();
  70         public String getActionAttribute();
  71         public String getActionBody();
  72         public Map<String, String> getDropDownMap();
  73         public String getActionDictHeader();
  74         public String getActionDictType();
  75         public String getActionDictUrl();
  76         public String getActionDictMethod();
  77         public String getServiceType();
  78         public String getUuid();
  79         public String getMsLocation();
  80     public String getPriority();
  81     public String getDeleteCondition();
  82     public String getDictionaryType();
  83     public String getDictionary();
  84     public String getDictionaryFields();
  85         public String getRiskLevel();
  86         public String getGuard();
  87         public String getRiskType();
  88         public String getTTLDate();
  89 }