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  * ================================================================================
   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.models.tosca.simple.mapping;
  22
  23 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
  24
  25 /**
  26  * This interface is used to map legacy and proprietary policies into and out of TOSCA service templates.
  27  *
  28  * @author Liam Fallon (liam.fallon@est.tech)
  29  * @param <I> the type for the incoming policy definition
  30  * @param <O> the type for the outgoing policy definition
  31  */
  32 public interface JpaToscaServiceTemplateMapper<I, O> {
  33
  34     /**
  35      * Translate from the other format to a TOSCA service template.
  36      *
  37      * @param otherPolicyType the other policy type
  38      * @return the TOSCA service template
  39      */
  40     public JpaToscaServiceTemplate toToscaServiceTemplate(final I otherPolicyType);
  41
  42     /**
  43      * Translate to the other format from a TOSCA service template.
  44      *
  45      * @param serviceTemplate the TOSCA service template
  46      * @return the policy in the other format
  47      */
  48     public O fromToscaServiceTemplate(final JpaToscaServiceTemplate serviceTemplate);
  49 }