Tue, 09 Apr 2013 14:51:13 +0100
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.server; |
ohair@286 | 27 | |
ohair@286 | 28 | import com.sun.istack.internal.NotNull; |
ohair@286 | 29 | import com.sun.xml.internal.ws.api.pipe.Pipe; |
ohair@286 | 30 | import com.sun.xml.internal.ws.api.pipe.ServerPipeAssemblerContext; |
ohair@286 | 31 | import com.sun.xml.internal.ws.api.pipe.helper.AbstractFilterPipeImpl; |
ohair@286 | 32 | |
ohair@286 | 33 | /** |
ohair@286 | 34 | * Allow the container (primarily Glassfish) to inject |
ohair@286 | 35 | * their own pipes into the pipeline. |
ohair@286 | 36 | * |
ohair@286 | 37 | * <p> |
ohair@286 | 38 | * This interface has a rather ad-hoc set of methods, because |
ohair@286 | 39 | * we didn't want to define an autonomous pipe-assembly process. |
ohair@286 | 40 | * (We thought this is a smaller evil compared to that.) |
ohair@286 | 41 | * |
ohair@286 | 42 | * <p> |
ohair@286 | 43 | * JAX-WS obtains this through {@link Container#getSPI(Class)}. |
ohair@286 | 44 | * |
ohair@286 | 45 | * @author Kohsuke Kawaguchi |
ohair@286 | 46 | */ |
ohair@286 | 47 | public abstract class ServerPipelineHook { |
ohair@286 | 48 | /** |
ohair@286 | 49 | * Called during the pipeline construction process once to allow a container |
ohair@286 | 50 | * to register a pipe for monitoring. |
ohair@286 | 51 | * |
ohair@286 | 52 | * This pipe will be injected to a point very close to the transport, allowing |
ohair@286 | 53 | * it to measure the time it takes for processing as well as detecting errors. |
ohair@286 | 54 | * |
ohair@286 | 55 | * @param ctxt |
ohair@286 | 56 | * Represents abstraction of SEI, WSDL abstraction etc. Context can be used |
ohair@286 | 57 | * whether add a new pipe to the head or not. |
ohair@286 | 58 | * |
ohair@286 | 59 | * @param tail |
ohair@286 | 60 | * Head of the partially constructed pipeline. If the implementation |
ohair@286 | 61 | * wishes to add new pipes, it should do so by extending |
ohair@286 | 62 | * {@link AbstractFilterPipeImpl} and making sure that this {@link Pipe} |
ohair@286 | 63 | * eventually processes messages. |
ohair@286 | 64 | * |
ohair@286 | 65 | * @return |
ohair@286 | 66 | * The default implementation just returns <tt>tail</tt>, which means |
ohair@286 | 67 | * no additional pipe is inserted. If the implementation adds |
ohair@286 | 68 | * new pipes, return the new head pipe. |
ohair@286 | 69 | */ |
ohair@286 | 70 | public @NotNull Pipe createMonitoringPipe(ServerPipeAssemblerContext ctxt, @NotNull Pipe tail) { |
ohair@286 | 71 | return tail; |
ohair@286 | 72 | } |
ohair@286 | 73 | |
ohair@286 | 74 | /** |
ohair@286 | 75 | * Called during the pipeline construction process once to allow a container |
ohair@286 | 76 | * to register a pipe for security. |
ohair@286 | 77 | * |
ohair@286 | 78 | * This pipe will be injected to a point very close to the transport, allowing |
ohair@286 | 79 | * it to do some security operations. |
ohair@286 | 80 | * |
ohair@286 | 81 | * @param ctxt |
ohair@286 | 82 | * Represents abstraction of SEI, WSDL abstraction etc. Context can be used |
ohair@286 | 83 | * whether add a new pipe to the head or not. |
ohair@286 | 84 | * |
ohair@286 | 85 | * @param tail |
ohair@286 | 86 | * Head of the partially constructed pipeline. If the implementation |
ohair@286 | 87 | * wishes to add new pipes, it should do so by extending |
ohair@286 | 88 | * {@link AbstractFilterPipeImpl} and making sure that this {@link Pipe} |
ohair@286 | 89 | * eventually processes messages. |
ohair@286 | 90 | * |
ohair@286 | 91 | * @return |
ohair@286 | 92 | * The default implementation just returns <tt>tail</tt>, which means |
ohair@286 | 93 | * no additional pipe is inserted. If the implementation adds |
ohair@286 | 94 | * new pipes, return the new head pipe. |
ohair@286 | 95 | */ |
ohair@286 | 96 | public @NotNull Pipe createSecurityPipe(ServerPipeAssemblerContext ctxt, @NotNull Pipe tail) { |
ohair@286 | 97 | return tail; |
ohair@286 | 98 | } |
ohair@286 | 99 | } |