src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/FiberContextSwitchInterceptor.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

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

mercurial