1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact tma@netspace.net.au.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2001-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: AbstractMessageTestCase.java,v 1.8 2004/01/31 13:44:24 tanderson Exp $
44 */
45 package org.exolab.jmscts.core;
46
47 import org.apache.log4j.Category;
48
49
50 /***
51 * This class provides a default implementation of the {@link MessageTestCase}
52 * interface.
53 *
54 * @version $Revision: 1.8 $ $Date: 2004/01/31 13:44:24 $
55 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
56 * @see MessageTestCase
57 * @see MessageTestRunner
58 */
59 public abstract class AbstractMessageTestCase extends AbstractSessionTestCase
60 implements MessageTestCase {
61
62 /***
63 * The logger
64 */
65 private static final Category log =
66 Category.getInstance(AbstractMessageTestCase.class.getName());
67
68
69 /***
70 * Construct an instance of this class for a specific test case.
71 *
72 * @param name the name of test case
73 */
74 public AbstractMessageTestCase(String name) {
75 super(name);
76 }
77
78 /***
79 * Returns the message types to test against
80 * This implementation returns the values of any
81 * <code>jmscts.message</code> javadoc tags associated with the test
82 * case. If none are specified, it defaults to {@link MessageTypes#ALL}
83 *
84 * @return the message types to test against
85 */
86 public MessageTypes getMessageTypes() {
87 MessageTypes result = null;
88 String test = getName();
89 String[] types = types = AttributeHelper.getAttributes(
90 getClass(), test, "jmscts.message", false);
91
92 if (types.length == 0) {
93 result = MessageTypes.ALL;
94 } else {
95 result = MessageTypes.fromString(types);
96 }
97 return result;
98 }
99
100 /***
101 * Determines if messages should be pre-created and populated for the test.
102 *
103 * @return <code>true</code>
104 */
105 public boolean shouldCreateMessage() {
106 return true;
107 }
108
109 /***
110 * Get the message populator. This may be used to populate a message
111 * with data prior to {@link #setContext} being invoked.
112 *
113 * @return an instance of {@link BasicMessagePopulator}
114 */
115 public MessagePopulator getMessagePopulator() {
116 return new BasicMessagePopulator();
117 }
118
119 /***
120 * Returns true if the connection should be started prior to running the
121 * test.
122 *
123 * @return this implementation always returns <code>true</code>
124 */
125 public boolean startConnection() {
126 return true;
127 }
128
129 }
This page was automatically generated by Maven