• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/ws/api/client/ClientPipelineHook.java@9c07ef4934dd (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/api/client/ClientPipelineHook.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.client;
aoqi@0	27
aoqi@0	28	import com.sun.istack.internal.NotNull;
aoqi@0	29	import com.sun.xml.internal.ws.api.pipe.Pipe;
aoqi@0	30	import com.sun.xml.internal.ws.api.pipe.ClientPipeAssemblerContext;
aoqi@0	31
aoqi@0	32	/**
aoqi@0	33	* Allow the container (primarily Glassfish) to inject
aoqi@0	34	* their own pipes into the client pipeline.
aoqi@0	35	*
aoqi@0	36	* <p>
aoqi@0	37	* This interface has a rather ad-hoc set of methods, because
aoqi@0	38	* we didn't want to define an autonomous pipe-assembly process.
aoqi@0	39	* (We thought this is a smaller evil compared to that.)
aoqi@0	40	*
aoqi@0	41	* <p>
aoqi@0	42	* JAX-WS obtains this through {@link com.sun.xml.internal.ws.api.server.Container#getSPI(Class)}.
aoqi@0	43	*
aoqi@0	44	* @author Jitendra Kotamraju
aoqi@0	45	*/
aoqi@0	46	public abstract class ClientPipelineHook {
aoqi@0	47
aoqi@0	48	/**
aoqi@0	49	* Called during the pipeline construction process once to allow a container
aoqi@0	50	* to register a pipe for security.
aoqi@0	51	*
aoqi@0	52	* This pipe will be injected to a point very close to the transport, allowing
aoqi@0	53	* it to do some security operations.
aoqi@0	54	*
aoqi@0	55	* @param ctxt
aoqi@0	56	* Represents abstraction of SEI, WSDL abstraction etc. Context can be used
aoqi@0	57	* whether add a new pipe to the head or not.
aoqi@0	58	*
aoqi@0	59	* @param tail
aoqi@0	60	* Head of the partially constructed pipeline. If the implementation
aoqi@0	61	* wishes to add new pipes, it should do so by extending
aoqi@0	62	* {@link com.sun.xml.internal.ws.api.pipe.helper.AbstractFilterPipeImpl} and making sure that this {@link com.sun.xml.internal.ws.api.pipe.Pipe}
aoqi@0	63	* eventually processes messages.
aoqi@0	64	*
aoqi@0	65	* @return
aoqi@0	66	* The default implementation just returns <tt>tail</tt>, which means
aoqi@0	67	* no additional pipe is inserted. If the implementation adds
aoqi@0	68	* new pipes, return the new head pipe.
aoqi@0	69	*/
aoqi@0	70	public @NotNull Pipe createSecurityPipe(ClientPipeAssemblerContext ctxt, @NotNull Pipe tail) {
aoqi@0	71	return tail;
aoqi@0	72	}
aoqi@0	73	}