blob: 824edd70224adc4ad6db28597a214e09a60295e8 (
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
|
/*
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*
*/
package org.apache.qpid.test.framework;
import javax.jms.*;
/**
* A CircuitEnd is a pair consisting of one message producer and one message consumer, that represents one end of a
* test circuit. It is a standard unit of connectivity allowing a full-duplex conversation to be held, provided both
* the consumer and producer are instantiated and configured.
*
* <p/><table id="crc"><caption>CRC Card</caption>
* <tr><th> Responsibilities
* <tr><td> Provide a message producer for sending messages.
* <tr><td> Provide a message consumer for receiving messages.
* </table>
*
* @todo Update the {@link org.apache.qpid.test.utils.ConversationFactory} so that it accepts these as the basic conversation
* connection units.
*/
public interface CircuitEnd
{
/**
* Gets the message producer at this circuit end point.
*
* @return The message producer at with this circuit end point.
*/
public MessageProducer getProducer();
/**
* Gets the message consumer at this circuit end point.
*
* @return The message consumer at this circuit end point.
*/
public MessageConsumer getConsumer();
/**
* Send the specified message over the producer at this end point.
*
* @param message The message to send.
*
* @throws JMSException Any JMS exception occuring during the send is allowed to fall through.
*/
public void send(Message message) throws JMSException;
/**
* Gets the JMS Session associated with this circuit end point.
*
* @return The JMS Session associated with this circuit end point.
*/
public Session getSession();
/**
* Closes the message producers and consumers and the sessions, associated with this circuit end point.
*
* @throws JMSException Any JMSExceptions occurring during the close are allowed to fall through.
*/
public void close() throws JMSException;
/**
* Returns the message monitor for reporting on received messages on this circuit end.
*
* @return The message monitor for this circuit end.
*/
public MessageMonitor getMessageMonitor();
/**
* Returns the exception monitor for reporting on exceptions received on this circuit end.
*
* @return The exception monitor for this circuit end.
*/
public ExceptionMonitor getExceptionMonitor();
}
|
