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;
60
61 import java.io.InputStream;
62 import java.net.URL;
63 import java.util.Iterator;
64 import java.util.List;
65 import java.util.LinkedList;
66
67 import org.apache.commons.betwixt.io.BeanReader;
68 import org.apache.commons.io.IOUtil;
69
70 import org.troublescope.evaluation.Evaluation;
71 import org.troublescope.evaluation.EvaluationResults;
72 import org.troublescope.util.BetwixtUtils;
73
74 /***
75 * A profile for a troubleshooting session.
76 */
77 public class Troubleshoot
78 {
79
80 private Evaluation evaluation;
81 private List inputs;
82
83 /***
84 * Create a new <code>Troubleshoot</code>.
85 */
86 public Troubleshoot()
87 {
88 inputs = new LinkedList();
89 }
90
91 /***
92 * Add an input.
93 */
94 public void addInput(Input input)
95 {
96 inputs.add(input);
97 }
98
99 /***
100 * Returns an iteration of inputs.
101 */
102 public Iterator getInputs()
103 {
104 return inputs.iterator();
105 }
106
107 /***
108 * Returns the evaluation to perform.
109 */
110 public Evaluation getEvaluation()
111 {
112 return evaluation;
113 }
114
115 /***
116 * Sets the evaluation.
117 */
118 public void setEvaluation(Evaluation anEval)
119 {
120 evaluation = anEval;
121 }
122
123 /***
124 * Gather inputs from the user.
125 */
126 public void gatherInputs(ApplicationContext ctx,
127 UserInteractionHandler userHandler)
128 throws TroubleScopeException
129 {
130 }
131
132 /***
133 * Evaluate the application.
134 */
135 public EvaluationResults evaluate(ApplicationContext ctx,
136 UserInteractionHandler userInteractionHandler)
137 throws TroubleScopeException
138 {
139 return getEvaluation().start(ctx);
140 }
141
142 /***
143 * Create a <code>Troubleshoot</code>
144 */
145 static public Troubleshoot createInstance(URL url)
146 throws TroubleScopeException
147 {
148 if (url == null) {
149 throw new NullPointerException("Configuration URL");
150 }
151 InputStream in = null;
152 try {
153 BeanReader reader = BetwixtUtils.createBeanReader();
154 in = url.openStream();
155 reader.registerBeanClass(Troubleshoot.class);
156 return (Troubleshoot) reader.parse(in);
157 } catch (Exception e) {
158 throw new TroubleScopeException(
159 "Error loading troubleshoot descriptor", e);
160 } finally {
161 IOUtil.shutdownStream(in);
162 }
163 }
164
165 }
This page was automatically generated by Maven