appc-dg/appc-dg-shared/appc-dg-common/src/main/java/org/onap/appc/dg/common/IntermediateMessageSender.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.common;
  26
  27 import java.util.Map;
  28 import org.onap.ccsdk.sli.core.sli.SvcLogicContext;
  29 import org.onap.ccsdk.sli.core.sli.SvcLogicJavaPlugin;
  30
  31 /**
  32  * This interface provides api for sending intermediate messages from DG to initiator
  33  */
  34 @FunctionalInterface
  35 public interface IntermediateMessageSender extends SvcLogicJavaPlugin{
  36
  37     /**
  38      * DG plugin which sends intermediate messages generated from DG to the initiator
  39      * @param params expects 1. code, (mandatory)
  40      *                       2. message, (mandatory)
  41      *                       3. payload,
  42      *                       4. prefix
  43      * @param context expects 1. input.common-header.timestamp,
  44      *                2. input.common-header.api-ver,
  45      *                3. input.common-header.originator-id,
  46      *                4. input.common-header.request-id, (mandatory)
  47      *                5. input.common-header.sub-request-id,
  48      *                6. input.action
  49      */
  50     void sendMessage(Map<String, String> params, SvcLogicContext context);
  51 }