Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/FiberContextSwitchInterceptor.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/FiberContextSwitchInterceptor.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 368
- 0989ad8c0860
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.xml.internal.ws.api.pipe; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.security.AccessController; |
| aoqi@0 | 29 | import java.security.PrivilegedAction; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** |
| aoqi@0 | 32 | * Interception for {@link Fiber} context switch. |
| aoqi@0 | 33 | * |
| aoqi@0 | 34 | * <p> |
| aoqi@0 | 35 | * Even though pipeline runs asynchronously, sometimes it's desirable |
| aoqi@0 | 36 | * to bind some state to the current thread running a fiber. Such state |
| aoqi@0 | 37 | * may include security subject (in terms of {@link AccessController#doPrivileged}), |
| aoqi@0 | 38 | * or a transaction. |
| aoqi@0 | 39 | * |
| aoqi@0 | 40 | * <p> |
| aoqi@0 | 41 | * This mechanism makes it possible to do such things, by allowing |
| aoqi@0 | 42 | * some code to be executed before and after a thread executes a fiber. |
| aoqi@0 | 43 | * |
| aoqi@0 | 44 | * <p> |
| aoqi@0 | 45 | * The design also encapsulates the entire fiber execution in a single |
| aoqi@0 | 46 | * opaque method invocation {@link Work#execute}, allowing the use of |
| aoqi@0 | 47 | * <tt>finally</tt> block. |
| aoqi@0 | 48 | * |
| aoqi@0 | 49 | * |
| aoqi@0 | 50 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 51 | */ |
| aoqi@0 | 52 | public interface FiberContextSwitchInterceptor { |
| aoqi@0 | 53 | /** |
| aoqi@0 | 54 | * Allows the interception of the fiber execution. |
| aoqi@0 | 55 | * |
| aoqi@0 | 56 | * <p> |
| aoqi@0 | 57 | * This method needs to be implemented like this: |
| aoqi@0 | 58 | * |
| aoqi@0 | 59 | * <pre> |
| aoqi@0 | 60 | * <R,P> R execute( Fiber f, P p, Work<R,P> work ) { |
| aoqi@0 | 61 | * // do some preparation work |
| aoqi@0 | 62 | * ... |
| aoqi@0 | 63 | * try { |
| aoqi@0 | 64 | * // invoke |
| aoqi@0 | 65 | * return work.execute(p); |
| aoqi@0 | 66 | * } finally { |
| aoqi@0 | 67 | * // do some clean up work |
| aoqi@0 | 68 | * ... |
| aoqi@0 | 69 | * } |
| aoqi@0 | 70 | * } |
| aoqi@0 | 71 | * </pre> |
| aoqi@0 | 72 | * |
| aoqi@0 | 73 | * <p> |
| aoqi@0 | 74 | * While somewhat unintuitive, |
| aoqi@0 | 75 | * this interception mechanism enables the interceptor to wrap |
| aoqi@0 | 76 | * the whole fiber execution into a {@link AccessController#doPrivileged(PrivilegedAction)}, |
| aoqi@0 | 77 | * for example. |
| aoqi@0 | 78 | * |
| aoqi@0 | 79 | * @param f |
| aoqi@0 | 80 | * {@link Fiber} to be executed. |
| aoqi@0 | 81 | * @param p |
| aoqi@0 | 82 | * The opaque parameter value for {@link Work}. Simply pass this value to |
| aoqi@0 | 83 | * {@link Work#execute(Object)}. |
| aoqi@0 | 84 | * @return |
| aoqi@0 | 85 | * The opaque return value from the the {@link Work}. Simply return |
| aoqi@0 | 86 | * the value from {@link Work#execute(Object)}. |
| aoqi@0 | 87 | */ |
| aoqi@0 | 88 | <R,P> R execute( Fiber f, P p, Work<R,P> work ); |
| aoqi@0 | 89 | |
| aoqi@0 | 90 | /** |
| aoqi@0 | 91 | * Abstraction of the execution that happens inside the interceptor. |
| aoqi@0 | 92 | */ |
| aoqi@0 | 93 | interface Work<R,P> { |
| aoqi@0 | 94 | /** |
| aoqi@0 | 95 | * Have the current thread executes the current fiber, |
| aoqi@0 | 96 | * and returns when it stops doing so. |
| aoqi@0 | 97 | * |
| aoqi@0 | 98 | * <p> |
| aoqi@0 | 99 | * The parameter and the return value is controlled by the |
| aoqi@0 | 100 | * JAX-WS runtime, and interceptors should simply treat |
| aoqi@0 | 101 | * them as opaque values. |
| aoqi@0 | 102 | */ |
| aoqi@0 | 103 | R execute(P param); |
| aoqi@0 | 104 | } |
| aoqi@0 | 105 | } |
