appc-dg/appc-dg-shared/appc-dg-license-manager/src/main/java/org/openecomp/appc/dg/licmgr/LicenseManagerPlugin.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : APP-C
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *                                              reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.openecomp.appc.dg.licmgr;
  23
  24 import java.util.Map;
  25
  26 import org.openecomp.appc.exceptions.APPCException;
  27 import org.openecomp.sdnc.sli.SvcLogicContext;
  28 import org.openecomp.sdnc.sli.SvcLogicJavaPlugin;
  29
  30
  31 public interface LicenseManagerPlugin extends SvcLogicJavaPlugin {
  32     /**
  33      * Retrieves license model from APPC database and populate flags into svc context
  34      * @param params map with parameters:
  35      *               org.openecomp.appc.vftype - the vnf type / service type;
  36      *               org.openecomp.appc.resource-version - the vnf version / service version
  37      * @param ctx service logic context
  38      *            1. supposed properties already in context:
  39      *            aai.input.data.entitlement-assignment-group-uuid - entitlement-group-uuid asset tag already stored in AAI
  40      *            aai.input.data.license-assignment-group-uuid - license-key-uuid asset tag already stored in AAI
  41      *            2. properties and flags stored in context after bean execution:
  42      *            model.entitlement.pool.uuid - entitlement-group-uuid from license model
  43      *            model.license.key.uuid - license-key-uuid from license model
  44      *            is.acquire-entitlement.require
  45      *            is.release-entitlement.require
  46      *            is.acquire-license.require
  47      *            is.release-license.require
  48      *
  49      * @throws APPCException throws in case of any error
  50      */
  51     void retrieveLicenseModel(Map<String, String> params, SvcLogicContext ctx) throws APPCException;
  52 }