aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api/offered_consumed_apis.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/offered_consumed_apis.rst')
0 files changed, 0 insertions, 0 deletions
3 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 
/*-
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.pdp.xacml.application.common;

import com.att.research.xacml.api.Identifier;
import com.att.research.xacml.api.XACML3;
import com.att.research.xacml.std.IdentifierImpl;

public final class ToscaDictionary {

    /*
     * These are the ID's for various TOSCA Policy Types we are supporting in the Applications.
     */
    public static final Identifier URN_ONAP =
            new IdentifierImpl("urn:org:onap");

    public static final Identifier ID_RESOURCE_POLICY_ID =
            XACML3.ID_RESOURCE_RESOURCE_ID;

    public static final Identifier ID_RESOURCE_POLICY_TYPE =
            new IdentifierImpl(URN_ONAP, "policy-type");

    public static final Identifier ID_RESOURCE_POLICY_TYPE_VERSION =
            new IdentifierImpl(URN_ONAP, "policy-type-version");

    /*
     * These ID's are for identifying Subjects
     */

    public static final Identifier ID_SUBJECT_ONAP_NAME =
            XACML3.ID_SUBJECT_SUBJECT_ID;

    public static final Identifier ID_SUBJECT_ONAP_COMPONENT =
            new IdentifierImpl(URN_ONAP, "onap-component");

    public static final Identifier ID_SUBJECT_ONAP_INSTANCE =
            new IdentifierImpl(URN_ONAP, "onap-instance");

    /*
     * These 2 ID's are for Optimization policies
     */

    public static final Identifier ID_RESOURCE_POLICY_SCOPE_PROPERTY =
            new IdentifierImpl(URN_ONAP, "policy-scope-property");

    public static final Identifier ID_RESOURCE_POLICY_TYPE_PROPERTY =
            new IdentifierImpl(URN_ONAP, "policy-type-property");

    /*
     * These ID's are for Legacy Guard Policies
     */
    public static final Identifier ID_RESOURCE_GUARD_ACTOR =
            new IdentifierImpl(URN_ONAP, "guard:actor:actor-id");
    public static final Identifier ID_RESOURCE_GUARD_RECIPE =
            new IdentifierImpl(URN_ONAP, "guard:operation:operation-id");
    public static final Identifier ID_RESOURCE_GUARD_CLNAME =
            new IdentifierImpl(URN_ONAP, "guard:clname:clname-id");
    public static final Identifier ID_RESOURCE_GUARD_TARGETID =
            new IdentifierImpl(URN_ONAP, "guard:target:target-id");
    public static final Identifier ID_SUBJECT_GUARD_REQUESTID =
            new IdentifierImpl(URN_ONAP, "guard:request:request-id");
    public static final Identifier ID_RESOURCE_GUARD_VFCOUNT =
            new IdentifierImpl(URN_ONAP, "guard:target:vf-count");
    public static final Identifier ID_RESOURCE_GUARD_MIN =
            new IdentifierImpl(URN_ONAP, "guard:target:min");
    public static final Identifier ID_RESOURCE_GUARD_MAX =
            new IdentifierImpl(URN_ONAP, "guard:target:max");

    /*
     * This id specifically for guard is provided by the
     * operational history database PIP.
     */
    public static final Identifier ID_RESOURCE_GUARD_OPERATIONCOUNT =
            new IdentifierImpl(URN_ONAP, "guard:operation:operation-count");

    public static final String GUARD_ISSUER = URN_ONAP.stringValue() + "xacml:guard:historydb";

    /*
     * This id is specifically for advice returned from guard
     */
    public static final Identifier ID_ADVICE_GUARD =
            new IdentifierImpl(URN_ONAP, "guard:advice");
    public static final Identifier ID_ADVICE_GUARD_REQUESTID =
            new IdentifierImpl(URN_ONAP, "guard:advice:request-id");

    /*
     * Obligation specific ID's
     */

    public static final Identifier ID_OBLIGATION_REST_BODY =
            new IdentifierImpl(URN_ONAP, "rest:body");

    public static final Identifier ID_OBLIGATION_POLICY_MONITORING =
            new IdentifierImpl(URN_ONAP, ":obligation:monitoring");

    public static final Identifier ID_OBLIGATION_POLICY_MONITORING_CONTENTS =
            new IdentifierImpl(URN_ONAP, ":obligation:monitoring:contents");

    public static final Identifier ID_OBLIGATION_POLICY_MONITORING_CATEGORY =
            XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE;

    public static final Identifier ID_OBLIGATION_POLICY_MONITORING_DATATYPE =
            XACML3.ID_DATATYPE_STRING;

    public static final Identifier ID_OBLIGATION_MONITORING_ISSUER =
            new IdentifierImpl(URN_ONAP, "issuer:monitoring");



    private ToscaDictionary() {
        super();
    }

}