/*
    * Copyright (c) 2004, RV Test Team
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions are met:
    *
    * Redistributions of source code must retain the above copyright notice, this
    * list of conditions and the following disclaimer.
   *
   * Redistributions in binary form must reproduce the above copyright notice,
   * this list of conditions and the following disclaimer in the documentation
   * and/or other materials provided with the distribution.
   *
   * Neither the name of the "RV Test Team" nor the names of its contributors may
   * be used to endorse or promote products derived from this software without
   * specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
   * THE POSSIBILITY OF SUCH DAMAGE.
   *
   */
  package com.reuters.msgtest.fixture;
  
  import com.reuters.msgtest.SubjectSubstitution;
  import com.reuters.msgtest.digester.RvMessage;
  import com.tibco.tibrv.TibrvMsg;
  import java.util.HashSet;
  import java.util.Iterator;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Set;
  
  
  /***
   * @author Michael Ward
   */
  public class Response {
      public final static int EQUALS = 0;
      public final static int EQUALSIGNORE = 1;
      public final static int NONE = 2;
      private List ignoredFields;
      private String name;
      private String uri;
      private String subject;
      private int minexpected;
      private int maxexpected;
      private int comparisonMethod = -1;
      private TibrvMsg tibrvMsg;
      private SubjectSubstitution subjectSubstitution;
  
      public Response(SubjectSubstitution subjectSubstitution) {
          ignoredFields = new LinkedList();
          this.subjectSubstitution = subjectSubstitution;
      }
  
      public void addIgnoredField(String field) {
          ignoredFields.add(field);
      }
  
      /***
      * Get the value of IgnoredFields.  These are the tibrvfields that will be
      * ignored when performing an equalsignore comparison operation.
      * @return value of IgnoredFields.
      */
      public Set getIgnoredFields() {
          return new HashSet(ignoredFields);
      }
  
      /***
      * Set the value of IgnoredFields.
      * @param ignoredFields The vector of field names in the message to ignore
      * when performing comparison operations.
      */
      public void setIgnoredFields(Set ignoredFields) {
          for (Iterator iter = ignoredFields.iterator(); iter.hasNext();) {
              this.ignoredFields.add(iter.next());
          }
      }
  
      public String getUri() {
          return uri;
      }
  
      public void setUri(String uri) {
          this.uri = uri;
      }
  
      public String getSubject() {
          return subject;
     }
 
     public void setSubject(String subject) {
         this.subject = subjectSubstitution.process(subject);
     }
 
     /***
     * Get the name of this response message.
     *
     * @return a <code>String</code> value
     */
     public String getName() {
         return name;
     }
 
     public void setName(String name) {
         this.name = name;
     }
 
     /***
     * Get the minimum number of messages expected on this subject.
     * @return value of MinExpected.
     */
     public int getMinexpected() {
         return minexpected;
     }
 
     /***
     * Set the minimum number of messages expected on this subject.
     * @param minexpected  Value to assign to MinExpected.
     */
     public void setMinexpected(int minexpected) {
         this.minexpected = minexpected;
     }
 
     /***
     * Get the maximum number of messages expected on this subject.
     * @return value of MaxExpected.
     */
     public int getMaxexpected() {
         return maxexpected;
     }
 
     /***
     * Set the maximum number of messages expected on this subject.
     * @param maxexpected  Value to assign to MaxExpected.
     */
     public void setMaxexpected(int maxexpected) {
         this.maxexpected = maxexpected;
     }
 
     /***
     * Get the value of comparisonMethod that will be used to
     * compare message contents.  This is either
     * EQUALS, all tibrvfields must match, EQUALSIGNORE ignore certain tibrvfields,
     * or NONE, meaning ingore all field values, just ensure a message
     * was received on the subject.
     * @return value of comparisonMethod.
     */
     public int getComparisonMethod() {
         return comparisonMethod;
     }
 
     /***
     * Set the value of comparisonMethod.
     * @param comparisonMethod  Value to assign to comparisonMethod.
     */
     public void setComparisonMethod(int comparisonMethod) {
         this.comparisonMethod = comparisonMethod;
     }
 
     /***
     * Get the expected TibrvMsg response message.
     *
     * @return The expected TibrvMsg.
     */
     public TibrvMsg getTibrvMsg() {
         return tibrvMsg;
     }
 
     /***
     * Set the expected TibrvMsg response message.
     *
     * @param tibrvMsg The expected TibrvMsg.
     */
     public void setTibrvMsg(TibrvMsg tibrvMsg) {
         this.tibrvMsg = tibrvMsg;
     }
 
     /***
      * todo should this be pulled to an interface? (m2ward)
      *
      * @see Stimulus
      */
     public void processRvMessage(RvMessage rvMessage) {
         setTibrvMsg(rvMessage.convert());
     }
 }