applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/ToscaDictionary.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2019-2020 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  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.pdp.xacml.application.common;
  24
  25 import com.att.research.xacml.api.Identifier;
  26 import com.att.research.xacml.api.XACML3;
  27 import com.att.research.xacml.std.IdentifierImpl;
  28
  29 public final class ToscaDictionary {
  30
  31     /*
  32      * These are the ID's for various TOSCA Policy Types we are supporting in the Applications.
  33      */
  34     public static final String URN_ONAP = "urn:org:onap";
  35     public static final Identifier ID_URN_ONAP =
  36             new IdentifierImpl(URN_ONAP);
  37
  38     public static final Identifier ID_RESOURCE_POLICY_ID =
  39             XACML3.ID_RESOURCE_RESOURCE_ID;
  40
  41     public static final Identifier ID_RESOURCE_POLICY_TYPE =
  42             new IdentifierImpl(ID_URN_ONAP, "policy-type");
  43
  44     public static final Identifier ID_RESOURCE_POLICY_TYPE_VERSION =
  45             new IdentifierImpl(ID_URN_ONAP, "policy-type-version");
  46
  47     /*
  48      * These ID's are for identifying Subjects
  49      */
  50
  51     public static final Identifier ID_SUBJECT_ONAP_NAME =
  52             XACML3.ID_SUBJECT_SUBJECT_ID;
  53
  54     public static final Identifier ID_SUBJECT_ONAP_COMPONENT =
  55             new IdentifierImpl(ID_URN_ONAP, "onap-component");
  56
  57     public static final Identifier ID_SUBJECT_ONAP_INSTANCE =
  58             new IdentifierImpl(ID_URN_ONAP, "onap-instance");
  59
  60     /*
  61      * These ID's are for Matchable Attributes
  62      */
  63
  64     public static final String ID_RESOURCE_MATCHABLE = URN_ONAP + ":matchable:";
  65
  66     /*
  67      * These ID's are for Legacy Guard Policies
  68      */
  69     public static final Identifier ID_RESOURCE_GUARD_ACTOR =
  70             new IdentifierImpl(ID_URN_ONAP, "guard:actor:actor-id");
  71     public static final Identifier ID_RESOURCE_GUARD_RECIPE =
  72             new IdentifierImpl(ID_URN_ONAP, "guard:operation:operation-id");
  73     public static final Identifier ID_RESOURCE_GUARD_CLNAME =
  74             new IdentifierImpl(ID_URN_ONAP, "guard:clname:clname-id");
  75     public static final Identifier ID_RESOURCE_GUARD_TARGETID =
  76             new IdentifierImpl(ID_URN_ONAP, "guard:target:target-id");
  77     public static final Identifier ID_SUBJECT_GUARD_REQUESTID =
  78             new IdentifierImpl(ID_URN_ONAP, "guard:request:request-id");
  79     public static final Identifier ID_RESOURCE_GUARD_VFCOUNT =
  80             new IdentifierImpl(ID_URN_ONAP, "guard:target:vf-count");
  81     public static final Identifier ID_RESOURCE_GUARD_MIN =
  82             new IdentifierImpl(ID_URN_ONAP, "guard:target:min");
  83     public static final Identifier ID_RESOURCE_GUARD_MAX =
  84             new IdentifierImpl(ID_URN_ONAP, "guard:target:max");
  85     public static final Identifier ID_RESOURCE_GUARD_TIMESTART =
  86             new IdentifierImpl(ID_URN_ONAP, "guard.target:timestart");
  87     public static final Identifier ID_RESOURCE_GUARD_TIMEEND =
  88             new IdentifierImpl(ID_URN_ONAP, "guard.target:timeend");
  89
  90     /*
  91      * This id specifically for guard is provided by the
  92      * operational history database PIP.
  93      */
  94     public static final String GUARD_OPERATIONCOUNT = "guard:operation:operation-count";
  95     public static final Identifier ID_RESOURCE_GUARD_OPERATIONCOUNT =
  96             new IdentifierImpl(ID_URN_ONAP, GUARD_OPERATIONCOUNT);
  97
  98     public static final String GUARD_OPERATIONOUTCOME = "guard:operation:operation-outcome";
  99     public static final Identifier ID_RESOURCE_GUARD_OPERATIONOUTCOME =
 100             new IdentifierImpl(ID_URN_ONAP, GUARD_OPERATIONOUTCOME);
 101
 102     public static final String GUARD_ISSUER_PREFIX = URN_ONAP + ":xacml:guard:";
 103
 104     /*
 105      * This id is specifically for advice returned from guard
 106      */
 107     public static final Identifier ID_ADVICE_GUARD =
 108             new IdentifierImpl(ID_URN_ONAP, "guard:advice");
 109     public static final Identifier ID_ADVICE_GUARD_REQUESTID =
 110             new IdentifierImpl(ID_URN_ONAP, "guard:advice:request-id");
 111
 112     /*
 113      * These id's are specifically for optimization subscriber policies
 114      */
 115     public static final Identifier ID_SUBJECT_OPTIMIZATION_SUBSCRIBER_NAME =
 116             new IdentifierImpl(ID_URN_ONAP, "optimization:subscriber:name");
 117
 118     /*
 119      * These ids are specifically for optimization advice
 120      */
 121     public static final Identifier ID_ADVICE_OPTIMIZATION_SUBSCRIBER =
 122             new IdentifierImpl(ID_URN_ONAP, "optimization:advice:subscriber");
 123     public static final Identifier ID_ADVICE_OPTIMIZATION_SUBSCRIBER_ROLE =
 124             new IdentifierImpl(ID_URN_ONAP, "optimization:advice:subscriber:role");
 125     public static final Identifier ID_ADVICE_OPTIMIZATION_SUBSCRIBER_STATUS =
 126             new IdentifierImpl(ID_URN_ONAP, "optimization:advice:subscriber:status");
 127
 128     /*
 129      * Obligation specific ID's
 130      */
 131
 132     public static final Identifier ID_OBLIGATION_REST_BODY =
 133             new IdentifierImpl(ID_URN_ONAP, "rest:body");
 134
 135     public static final Identifier ID_OBLIGATION_POLICY_CONTENT =
 136             new IdentifierImpl(ID_URN_ONAP, ":obligation:policycontent");
 137
 138     public static final Identifier ID_OBLIGATION_POLICY_CONTENT_CATEGORY =
 139             XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE;
 140
 141     public static final Identifier ID_OBLIGATION_POLICY_CONTENT_DATATYPE =
 142             XACML3.ID_DATATYPE_STRING;
 143
 144     public static final Identifier ID_OBLIGATION_POLICY_ID =
 145             new IdentifierImpl(ID_URN_ONAP, ":obligation:policyid");
 146
 147     public static final Identifier ID_OBLIGATION_POLICY_ID_CATEGORY =
 148             XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE;
 149
 150     public static final Identifier ID_OBLIGATION_POLICY_ID_DATATYPE =
 151             XACML3.ID_DATATYPE_STRING;
 152
 153     public static final Identifier ID_OBLIGATION_POLICY_WEIGHT =
 154             new IdentifierImpl(ID_URN_ONAP, ":obligation:weight");
 155
 156     public static final Identifier ID_OBLIGATION_POLICY_WEIGHT_CATEGORY =
 157             XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE;
 158
 159     public static final Identifier ID_OBLIGATION_POLICY_WEIGHT_DATATYPE =
 160             XACML3.ID_DATATYPE_INTEGER;
 161
 162     public static final Identifier ID_OBLIGATION_POLICY_TYPE =
 163             new IdentifierImpl(ID_URN_ONAP, ":obligation:policytype");
 164
 165     public static final Identifier ID_OBLIGATION_POLICY_TYPE_CATEGORY =
 166             XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE;
 167
 168     public static final Identifier ID_OBLIGATION_POLICY_TYPE_DATATYPE =
 169             XACML3.ID_DATATYPE_STRING;
 170
 171
 172
 173     private ToscaDictionary() {
 174         super();
 175     }
 176
 177 }