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
027 /**
028 * The interface that must be implemented by message selector commands
029 * <p>
030 * From a testspec: <message-selector name="MyMessageSelector" command="java:<i>class
031 * that implements the MessageSelectorCommand interface</i>"/>
032 * </p>
033 *
034 * @author Lars Ivar Almli
035 */
036 public interface MessageSelectorCommand {
037 /**
038 * This method is ivoked by the test runner before selector is passed to the
039 * message broker during subscribe
040 *
041 * @param params
042 * the list of parameteres specifed for the given node in the
043 * test-spec xml (after the ##{...} substitution has been
044 * performed)
045 * @throws MactorException
046 * if some problem occured (this will cause the test to fail)
047 */
048 void setParams(List<String> params) throws MactorException;
049 /**
050 * The method invoked by the testrunner to build the messgte.
051 *
052 * @param context
053 * contains information about the context of the test that might
054 * be useful (such as all messages sent/received so far in the
055 * test)
056 * @return the built message
057 * @throws MactorException
058 * if some problem occured (this exception is logged and
059 * ignored)
060 */
061 boolean isAcceptableMessage(Message message) throws MactorException;
062 }