blob: 414fbc9e3b1e5d3f18194477f333f0031067de6c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.apex.service.engine.event;
import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
/**
* This interface is used by technology specific producers and publishers that are handling events
* output by Apex. Users specify the producer technology to use in the Apex configuration and Apex
* uses a factory to start the appropriate producer plugin that implements this interface for its
* output. The technology specific implementation details are hidden behind this interface.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public interface ApexEventProducer {
/**
* Initialize the producer.
*
* @param name a name for this producer
* @param producerParameters the parameters to initialise this producer
* @throws ApexEventException exception on errors initializing an event producer
*/
void init(String name, EventHandlerParameters producerParameters) throws ApexEventException;
/**
* Get the peered reference object for this producer.
*
* @param peeredMode the peered mode for which to return the reference
* @return the peered reference object for this producer
*/
PeeredReference getPeeredReference(EventHandlerPeeredMode peeredMode);
/**
* Set the peered reference object for this producer.
*
* @param peeredMode the peered mode for which to return the reference
* @param peeredReference the peered reference object for this producer
*/
void setPeeredReference(EventHandlerPeeredMode peeredMode, PeeredReference peeredReference);
/**
* Send an event to the producer.
*
* @param executionId the unique ID that produced this event
* @param eventName The name of the event
* @param event The converted event as an object
*/
void sendEvent(long executionId, String eventName, Object event);
/**
* Get the name of this event producer.
*
* @return the event producer name
*/
String getName();
/**
* Stop the event producer.
*/
void stop();
}
|
