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

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