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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.apex.service.engine.event;
23 import java.util.List;
25 import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
28 * The Interface ApexEventConverter is used for applications that want to convert arbitrary event
29 * types to and from Apex events. Application implement this interface to convert their events to
30 * and from Apex events.The Apex service can then use this interface to transparently transfer
31 * events into and out of an Apex system.
33 * @author Liam Fallon (liam.fallon@ericsson.com)
35 public interface ApexEventConverter {
38 * Convert an event of arbitrary type into an Apex event.
40 * @param name the name of the incoming event
41 * @param eventOfOtherType the event of some other type to convert
42 * @return the apex event
43 * @throws ApexException thrown on conversion errors
45 List<ApexEvent> toApexEvent(String name, Object eventOfOtherType) throws ApexException;
48 * Convert an Apex event into an event of arbitrary type {@code OTHER_EVENT_TYPE}.
50 * @param apexEvent the apex event to convert
51 * @return the event converted into the other type
52 * @throws ApexException thrown on conversion errors
54 Object fromApexEvent(ApexEvent apexEvent) throws ApexException;