View Javadoc

1   /*
2    * $Id: Probe.java 21549 2011-03-11 10:55:11Z pablo.kraan $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.tck.probe;
12  
13  /**
14   * A probe indicates whether the state of the system satisfies a given criteria
15   */
16  public interface Probe
17  {
18  
19      /**
20       * Indicates wheter or not the specified criteria was met or not.
21       *
22       * @return true if the criteria is satisfied.
23       */
24      boolean isSatisfied();
25  
26      /**
27       * Describes the cause of the criteria failure for further analysis.
28       *
29       * @return the error message.
30       */
31      String describeFailure();
32  }