services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/ApexEventConverter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   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.apex.service.engine.event;
  22
  23 import java.util.List;
  24 import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
  25
  26 /**
  27  * The Interface ApexEventConverter is used for applications that want to convert arbitrary event
  28  * types to and from Apex events. Application implement this interface to convert their events to
  29  * and from Apex events.The Apex service can then use this interface to transparently transfer
  30  * events into and out of an Apex system.
  31  *
  32  * @author Liam Fallon (liam.fallon@ericsson.com)
  33  */
  34 public interface ApexEventConverter {
  35
  36     /**
  37      * Convert an event of arbitrary type into an Apex event.
  38      *
  39      * @param name the name of the incoming event
  40      * @param eventOfOtherType the event of some other type to convert
  41      * @return the apex event
  42      * @throws ApexException thrown on conversion errors
  43      */
  44     List<ApexEvent> toApexEvent(String name, Object eventOfOtherType) throws ApexException;
  45
  46     /**
  47      * Convert an Apex event into an event of arbitrary type {@code OTHER_EVENT_TYPE}.
  48      *
  49      * @param apexEvent the apex event to convert
  50      * @return the event converted into the other type
  51      * @throws ApexException thrown on conversion errors
  52      */
  53     Object fromApexEvent(ApexEvent apexEvent) throws ApexException;
  54 }