aboutsummaryrefslogtreecommitdiffstats
path: root/policy-endpoints/src/main/java/org/openecomp/policy/drools/event/comm/TopicSink.java
blob: 2250b1ea522fac48ab17f11549952bfea84dd79f (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
/*-
 * ============LICENSE_START=======================================================
 * policy-endpoints
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. 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.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.policy.drools.event.comm;

import org.openecomp.policy.drools.properties.Lockable;
import org.openecomp.policy.drools.properties.Startable;

/**
 * Marks a given Topic Endpoint as able to send messages over a topic
 */
public interface TopicSink extends Topic, Startable, Lockable {
	
	/**
	 * Sends a string message over this Topic Endpoint
	 * 
	 * @param message message to send
	 * @return true if the send operation succeeded, false otherwise
	 * @throws IllegalArgumentException an invalid message has been provided
	 * @throws IllegalStateException the entity is in an state that prevents
	 * it from sending messages, for example, locked or stopped.
	 */
	public boolean send(String message) throws IllegalArgumentException, IllegalStateException;

}