artifactbroker/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/xacml/pdp/XacmlPdpPolicyAdapter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.distribution.forwarding.xacml.pdp;
  22
  23 import org.onap.policy.api.PolicyParameters;
  24 import org.onap.policy.api.PushPolicyParameters;
  25 import org.onap.policy.distribution.model.Policy;
  26
  27 /**
  28  * Adapts {@link Policy} objects to objects compatible with the XACML PDP API.
  29  */
  30 public interface XacmlPdpPolicyAdapter<T extends Policy> {
  31
  32     /**
  33      * Get the policy.
  34      *
  35      * @return the policy
  36      */
  37     T getPolicy();
  38
  39     /**
  40      * Get as a {@link PolicyParameters} object.
  41      *
  42      * @returna {@link PolicyParameters} object
  43      */
  44     PolicyParameters getAsPolicyParameters();
  45
  46     /**
  47      * Get as a {@link PushPolicyParameters} object.
  48      *
  49      * @returna {@link PushPolicyParameters} object
  50      */
  51     PushPolicyParameters getAsPushPolicyParameters(final String pdpGroups);
  52
  53 }