View Javadoc
1 /* ====================================================================
2 * The Apache Software License, Version 1.1
3 *
4 * Copyright (c) 2000 The Apache Software Foundation. All rights
5 * reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
17 * distribution.
18 *
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
25 *
26 * 4. The names "Apache" and "Apache Software Foundation" must
27 * not be used to endorse or promote products derived from this
28 * software without prior written permission. For written
29 * permission, please contact apache@apache.org.
30 *
31 * 5. Products derived from this software may not be called "Apache",
32 * nor may "Apache" appear in their name, without prior written
33 * permission of the Apache Software Foundation.
34 *
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 * SUCH DAMAGE.
47 * ====================================================================
48 *
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>;.
53 *
54 * Portions of this software are based upon public domain software
55 * originally written at the National Center for Supercomputing Applications,
56 * University of Illinois, Urbana-Champaign.
57 */
58
59 package org.troublescope.ui;
60
61 import java.net.URL;
62 import org.troublescope.*;
63 import org.troublescope.evaluation.EvaluationResults;
64
65 /***
66 * A automated troubleshooting client.
67 */
68 public abstract class TroubleshootingClient
69 {
70
71 private Troubleshoot troubleshoot;
72 private ApplicationContext ctx;
73 private UserInteractionHandler userInteractionHandler;
74 private EvaluationResults evalResults;
75
76 /***
77 * Create a new <code>TroubleshootingClient</code>.
78 */
79 public TroubleshootingClient(UserInteractionHandler userInteractionHandler)
80 {
81 this.userInteractionHandler = userInteractionHandler;
82 }
83
84 /***
85 * Initialize this client.
86 */
87 public void init()
88 throws TroubleScopeException
89 {
90 if (ctx == null) {
91 ctx = new ApplicationContext();
92 }
93 troubleshoot = loadTroubleshoot();
94 }
95
96 /***
97 * Perform the gathering of inputs.
98 */
99 public void performInputs()
100 throws TroubleScopeException
101 {
102 troubleshoot.gatherInputs(ctx, userInteractionHandler);
103 }
104
105 /***
106 * Perform the evaluation.
107 */
108 public void performEvaluation()
109 throws TroubleScopeException
110 {
111 evalResults = troubleshoot.evaluate(ctx, userInteractionHandler);
112 }
113
114 /***
115 * Perform the resolution.
116 */
117 public void performResolution()
118 {
119 }
120
121 /***
122 * Destroy the client.
123 */
124 public void destroy()
125 {
126 }
127
128 /***
129 * Load the configuration.
130 */
131 protected Troubleshoot loadTroubleshoot()
132 throws TroubleScopeException
133 {
134 URL url = getClass().getClassLoader().getResource("troubleshoot.xml");
135 if (url == null) {
136 throw new TroubleScopeException("Cannot find troubleshooting definition file");
137 }
138 return Troubleshoot.createInstance(url);
139 }
140
141 }
This page was automatically generated by Maven