View Javadoc

1   /* 
2    * Copyright (c) 2007, Fraunhofer-Gesellschaft
3    * All rights reserved.
4    * 
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions are
7    * met:
8    * 
9    * (1) Redistributions of source code must retain the above copyright
10   *     notice, this list of conditions and the disclaimer at the end.
11   *     Redistributions in binary form must reproduce the above copyright
12   *     notice, this list of conditions and the following disclaimer in
13   *     the documentation and/or other materials provided with the
14   *     distribution.
15   * 
16   * (2) Neither the name of Fraunhofer nor the names of its
17   *     contributors may be used to endorse or promote products derived
18   *     from this software without specific prior written permission.
19   * 
20   * DISCLAIMER
21   * 
22   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33   *  
34   */
35  package org.ogf.graap.wsag.server.monitoring;
36  
37  import java.util.Map;
38  
39  import org.ogf.graap.wsag.server.accounting.IAccountingSystem;
40  import org.ogf.graap.wsag4j.types.engine.GuaranteeEvaluationResultType;
41  import org.ogf.schemas.graap.wsAgreement.GuaranteeTermType;
42  
43  /**
44   * The guarantee evaluator assesses the state of each guarantee defined in an agreement based on the agreement
45   * properties. The evaluator is invoked as part of the agreement monitoring process that is implemented by the
46   * {@link MonitorableAgreement} class, after the service term states of the agreement were updated.
47   * 
48   * As a result of the guarantee evaluation process, the appropriate accounting events are propagated to an
49   * accounting system.
50   * 
51   * @see MonitorableAgreement
52   * @see IServiceTermMonitoringHandler
53   * @see IAccountingSystem
54   * 
55   * @author Oliver Waeldrich
56   * 
57   */
58  public interface IGuaranteeEvaluator
59  {
60  
61      /**
62       * Evaluates a given guarantee. The variables used in the qualifying condition and service level objective
63       * of the guarantee are passes a a map.
64       * 
65       * @param guarantee
66       *            the guarantee to evaluate
67       * 
68       * @param variables
69       *            a name/value map containing the variables
70       * 
71       * @return the evaluated guarantee term state
72       * 
73       * @throws Exception
74       *             indicates an error while evaluating the guarantee term
75       */
76      GuaranteeEvaluationResultType evaluate( GuaranteeTermType guarantee, Map<String, Object> variables )
77          throws Exception;
78  
79      /**
80       * 
81       * @param accountingSystem
82       *            the accounting system to use
83       *            
84       * @deprecated
85       */
86      void setAccountingSystem( IAccountingSystem accountingSystem );
87  
88      /**
89       * 
90       * @return the accounting system to use
91       * 
92       * @deprecated
93       */
94      IAccountingSystem getAccountingSystem();
95  
96  }