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 /**
38 * IServiceTermMonitor
39 *
40 * Implements a monitoring handler that updates the state of one or a set of service terms. The monitoring
41 * handler is invoked by the {@link MonitorableAgreement} for each monitoring interval. It implements the
42 * domain specific logic to retrieve the state of a particular service term.
43 *
44 * @see MonitorableAgreement
45 *
46 * @author Oliver Waeldrich
47 *
48 */
49 public interface IServiceTermMonitoringHandler
50 {
51
52 /**
53 * The monitoring handler implements the domain specific logic to retrieve the state of a particular
54 * service term (or a set of service terms). The service term states can be retrieved via the monitoring
55 * context. the monitoring context can also be used to store and access variables from different
56 * monitoring handlers and store the over multiple invocations.
57 *
58 * @param monitoringContext
59 * the monitoring context
60 *
61 * @throws Exception
62 * Indicates an error in the monitoring handler. The agreement states will not be updated
63 * during this monitoring cycle.
64 */
65 void monitor( IMonitoringContext monitoringContext ) throws Exception;
66
67 /*
68 * TODO the monitoring handler should have a method
69 * IServiceTermMonitoringHandler#initialize(IMonitoringContext)
70 */
71 }