← Back to branch summary

~ubuntu-branches/ubuntu/trusty/netbeans/trusty

« back to all changes in this revision

Viewing changes to openide/execution/src/org/openide/execution/ExecutionEngine.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
openide/execution/src/org/openide/execution/ExecutionEngine.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
 
 
42
package org.openide.execution;
 
43
 
 
44
import java.security.AllPermission;
 
45
import java.security.CodeSource;
 
46
import java.security.PermissionCollection;
 
47
import java.security.Permissions;
 
48
import org.openide.util.Lookup;
 
49
import org.openide.util.RequestProcessor;
 
50
import org.openide.windows.IOProvider;
 
51
import org.openide.windows.InputOutput;
 
52
 
 
53
/**
 
54
 * Engine providing the environment necessary to run long-lived processes.
 
55
 * May perform tasks such as setting up thread groups, etc.
 
56
 * Modules should not implement this class.
 
57
 * @author Jaroslav Tulach, Ales Novak
 
58
 */
 
59
public abstract class ExecutionEngine extends Object {
 
60
 
 
61
    /**
 
62
     * Run some task in the execution engine.
 
63
     * @param name a name of the new process
 
64
     * @param run a runnable to execute
 
65
     * @param io an I/O handle to automatically redirect system I/O streams in the dynamic scope of the task to,
 
66
     *           or null if no such redirection is required
 
67
     * @return an executor task that can control the execution
 
68
     */
 
69
    public abstract ExecutorTask execute(String name, Runnable run, InputOutput io);
 
70
 
 
71
    /**
 
72
     * Users that want to link their classes with NetBeans module classes should do this through
 
73
     * internal execution. The {@link NbClassLoader} used in internal execution will assume that calling
 
74
     * this method and giving the permission collection to the class being defined will
 
75
     * trigger automatic redirection of system output, input, and error streams into the given I/O tab.
 
76
     * Implementations of the engine should bind the tab and returned permissions.
 
77
     * Since the permission collection is on the stack when calling methods on {@link System#out} etc.,
 
78
     * it is possible to find the appropriate tab for redirection.
 
79
     * @param cs code source to construct the permission collection for
 
80
     * @param io an I/O tab
 
81
     * @return a permission collection
 
82
     */
 
83
    protected abstract PermissionCollection createPermissions(CodeSource cs, InputOutput io);
 
84
 
 
85
    /** Method that allows implementor of the execution engine to provide
 
86
    * class path to all libraries that one could find useful for development
 
87
    * in the system.
 
88
    *
 
89
    * @return class path to libraries
 
90
     * @deprecated There are generally no excuses to be using this method as part of a normal module;
 
91
     * its exact meaning is vague, and probably not what you want.
 
92
    */
 
93
    protected abstract NbClassPath createLibraryPath ();
 
94
    
 
95
    /**
 
96
     * Obtains default instance of the execution engine.
 
97
     * If default {@link Lookup} contains an instance of {@link ExecutionEngine},
 
98
     * that is used. Otherwise, a trivial basic implementation is returned with
 
99
     * the following behavior:
 
100
     * <ul>
 
101
     * <li>{@link #execute} just runs the runnable immediately and pretends to be done.
 
102
     * <li>{@link #createPermissions} just uses {@link AllPermission}. No I/O redirection
 
103
     *     or {@link System#exit} trapping is done.
 
104
     * <li>{@link #createLibraryPath} produces an empty path.
 
105
     * </ul>
 
106
     * This basic implementation is helpful in unit tests and perhaps in standalone usage
 
107
     * of other libraries.
 
108
     * @return some execution engine implementation (never null)
 
109
     * @since 2.16
 
110
     */
 
111
    public static ExecutionEngine getDefault() {
 
112
        ExecutionEngine ee = (ExecutionEngine) Lookup.getDefault().lookup(ExecutionEngine.class);
 
113
        if (ee == null) {
 
114
            ee = new Trivial();
 
115
        }
 
116
        return ee;
 
117
    }
 
118
    
 
119
    /**
 
120
     * Dummy fallback implementation, useful for unit tests.
 
121
     */
 
122
    static final class Trivial extends ExecutionEngine {
 
123
        
 
124
        public Trivial() {}
 
125
 
 
126
        protected NbClassPath createLibraryPath() {
 
127
            return new NbClassPath(new String[0]);
 
128
        }
 
129
 
 
130
        protected PermissionCollection createPermissions(CodeSource cs, InputOutput io) {
 
131
            PermissionCollection allPerms = new Permissions();
 
132
            allPerms.add(new AllPermission());
 
133
            allPerms.setReadOnly();
 
134
            return allPerms;
 
135
        }
 
136
 
 
137
        public ExecutorTask execute(String name, Runnable run, InputOutput io) {
 
138
            return new ET(run, name, io);
 
139
        }
 
140
        
 
141
        private static final class ET extends ExecutorTask {
 
142
            private RequestProcessor.Task task;
 
143
            private int resultValue;
 
144
            private final String name;
 
145
            private InputOutput io;
 
146
            
 
147
            public ET(Runnable run, String name, InputOutput io) {
 
148
                super(run);
 
149
                this.resultValue = resultValue;
 
150
                this.name = name;
 
151
                task = RequestProcessor.getDefault().post(this);
 
152
            }
 
153
            
 
154
            public void stop() {
 
155
                task.cancel();
 
156
            }
 
157
            
 
158
            public int result() {
 
159
                waitFinished();
 
160
                return resultValue;
 
161
            }
 
162
            
 
163
            public InputOutput getInputOutput() {
 
164
                return io;
 
165
            }
 
166
            
 
167
            public void run() {
 
168
                try {
 
169
                    super.run();
 
170
                } catch (RuntimeException x) {
 
171
                    x.printStackTrace();
 
172
                    resultValue = 1;
 
173
                }
 
174
            }
 
175
            
 
176
        }
 
177
        
 
178
    }
 
179
 
 
180
}