01: /*
02: * Copyright 1998-2004 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun in the LICENSE file that accompanied this code.
10: *
11: * This code is distributed in the hope that it will be useful, but WITHOUT
12: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14: * version 2 for more details (a copy is included in the LICENSE file that
15: * accompanied this code).
16: *
17: * You should have received a copy of the GNU General Public License version
18: * 2 along with this work; if not, write to the Free Software Foundation,
19: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20: *
21: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package java.security;
27:
28: /**
29: * A computation to be performed with privileges enabled. The computation is
30: * performed by invoking <code>AccessController.doPrivileged</code> on the
31: * <code>PrivilegedAction</code> object. This interface is used only for
32: * computations that do not throw checked exceptions; computations that
33: * throw checked exceptions must use <code>PrivilegedExceptionAction</code>
34: * instead.
35: *
36: * @see AccessController
37: * @see AccessController#doPrivileged(PrivilegedAction)
38: * @see PrivilegedExceptionAction
39: */
40:
41: public interface PrivilegedAction<T> {
42: /**
43: * Performs the computation. This method will be called by
44: * <code>AccessController.doPrivileged</code> after enabling privileges.
45: *
46: * @return a class-dependent value that may represent the results of the
47: * computation. Each class that implements
48: * <code>PrivilegedAction</code>
49: * should document what (if anything) this value represents.
50: * @see AccessController#doPrivileged(PrivilegedAction)
51: * @see AccessController#doPrivileged(PrivilegedAction,
52: * AccessControlContext)
53: */
54: T run();
55: }
|