001 /******************************************************************************
002 * Copyright (C) MActor Developers. All rights reserved. *
003 * ---------------------------------------------------------------------------*
004 * This file is part of MActor. *
005 * *
006 * MActor is free software; you can redistribute it and/or modify *
007 * it under the terms of the GNU General Public License as published by *
008 * the Free Software Foundation; either version 2 of the License, or *
009 * (at your option) any later version. *
010 * *
011 * MActor is distributed in the hope that it will be useful, *
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
014 * GNU General Public License for more details. *
015 * *
016 * You should have received a copy of the GNU General Public License *
017 * along with MActor; if not, write to the Free Software *
018 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
019 ******************************************************************************/
020 package org.mactor.framework.extensioninterface;
021
022 import java.util.List;
023
024 import org.mactor.brokers.Message;
025 import org.mactor.framework.MactorException;
026 import org.mactor.framework.TestContext;
027
028 /**
029 * The interface that must be must be implemented by message builder commands
030 * <p>
031 * From a testspec: <message-builder name="MyMessageBuilder" command="java:<i>class
032 * that implements the MessageBuilderCommand interface</i>"/>
033 * </p>
034 *
035 * @author Lars Ivar Almli
036 */
037 public interface MessageBuilderCommand {
038 /**
039 * The method invoked by the testrunner to build the message
040 *
041 * @param context
042 * contains information about the context of the test that might
043 * be useful (such as all messages sent/received so far in the
044 * test)
045 * @param params
046 * the list of parameteres specifed for the given node in the
047 * test-spec xml (after the ##{...} substitution has been
048 * performed)
049 * @return the built message
050 * @throws MactorException
051 * to indicate some problem (this will cause the test to fail)
052 */
053 Message buildMessage(TestContext context, String templatePath, List<String> params) throws MactorException;
054 }