models-tosca/src/main/java/org/onap/policy/models/tosca/simple/mapping/JpaToscaServiceTemplateMapper.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  *  Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.tosca.simple.mapping;
  23
  24 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
  25
  26 /**
  27  * This interface is used to map proprietary policies into and out of TOSCA service templates.
  28  *
  29  * @author Liam Fallon (liam.fallon@est.tech)
  30  * @param <I> the type for the incoming policy definition
  31  * @param <O> the type for the outgoing policy definition
  32  */
  33 public interface JpaToscaServiceTemplateMapper<I, O> {
  34
  35     /**
  36      * Translate from the other format to a TOSCA service template.
  37      *
  38      * @param otherPolicyType the other policy type
  39      * @return the TOSCA service template
  40      */
  41     public JpaToscaServiceTemplate toToscaServiceTemplate(final I otherPolicyType);
  42
  43     /**
  44      * Translate to the other format from a TOSCA service template.
  45      *
  46      * @param serviceTemplate the TOSCA service template
  47      * @return the policy in the other format
  48      */
  49     public O fromToscaServiceTemplate(final JpaToscaServiceTemplate serviceTemplate);
  50 }