summaryrefslogtreecommitdiffstats
path: root/event-client-api/src/main/java/org/onap/aai/event/api/EventPublisher.java
blob: a5de0930c0875176955ef15d5aaf0e8f2d731368 (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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * Copyright © 2017 European Software Marketing Ltd.
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 *
 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 */
package org.onap.aai.event.api;

import java.util.Collection;

public interface EventPublisher {

    /**
     * Publishes a message using the supplied partition key, using the parameters from the constructor.
     *
     * @param partitionKey The partition to publish the message on.
     * @param message The String message to publish.
     * @return The number of messages successfully sent
     * @throws Exception
     */
    public int sendSync(String partitionKey, String message) throws Exception;

    /**
     * Publishes a message using the supplied partition key, using the parameters from the constructor.
     *
     * @param partitionKey The partition to publish the messages on.
     * @param messages A Collection of messages to publish.
     * @return The number of messages successfully sent
     * @throws Exception
     */
    public int sendSync(String partitionKey, Collection<String> messages) throws Exception;

    /**
     * Publishes a message using the parameters from the constructor.
     *
     * @param message The String message to publish.
     * @return The number of messages successfully sent
     * @throws Exception
     */
    public int sendSync(String message) throws Exception;

    /**
     * Publishes a message using the parameters from the constructor.
     *
     * @param messages A Collection of messages to publish.
     * @return The number of messages successfully sent
     * @throws Exception
     */
    public int sendSync(Collection<String> messages) throws Exception;

    /**
     * Publishes a message using the supplied partition key, using the parameters from the constructor. The Async method
     * returns immediately without caring if the message was properly published or not.
     *
     * @param partitionKey The partition to publish the message on.
     * @param message The String message to publish.
     * @throws Exception
     */
    public void sendAsync(String partitionKey, String message) throws Exception;

    /**
     * Publishes a message using the supplied partition key, using the parameters from the constructor. The Async method
     * returns immediately without caring if the message was properly published or not.
     *
     * @param partitionKey The partition to publish the messages on.
     * @param messages A Collection of messages to publish.
     * @throws Exception
     */
    public void sendAsync(String partitionKey, Collection<String> messages) throws Exception;

    /**
     * Publishes a message using the parameters from the constructor. The Async method returns immediately without
     * caring if the message was properly published or not.
     *
     * @param message The String message to publish.
     * @throws Exception
     */
    public void sendAsync(String message) throws Exception;

    /**
     * Publishes a message using the parameters from the constructor. The Async method returns immediately without
     * caring if the message was properly published or not.
     *
     * @param messages A Collection of messages to publish.
     * @throws Exception
     */
    public void sendAsync(Collection<String> messages) throws Exception;

    /**
     * Closes the publisher.
     */
    public void close() throws Exception;


}