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

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

src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/PipelineAssembler.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 com.sun.xml.internal.ws.api.WSBinding;
aoqi@0	29	import com.sun.xml.internal.ws.api.server.WSEndpoint;
aoqi@0	30	import com.sun.xml.internal.ws.api.WSService;
aoqi@0	31	import com.sun.xml.internal.ws.api.EndpointAddress;
aoqi@0	32	import com.sun.xml.internal.ws.api.model.SEIModel;
aoqi@0	33	import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort;
aoqi@0	34	import com.sun.istack.internal.NotNull;
aoqi@0	35	import com.sun.istack.internal.Nullable;
aoqi@0	36
aoqi@0	37	import javax.xml.ws.Dispatch;
aoqi@0	38	import javax.xml.ws.Provider;
aoqi@0	39	import javax.xml.ws.Service;
aoqi@0	40	import javax.xml.ws.WebServiceException;
aoqi@0	41
aoqi@0	42	/**
aoqi@0	43	* Creates a pipeline.
aoqi@0	44	*
aoqi@0	45	* <p>
aoqi@0	46	* This pluggability layer enables the upper layer to
aoqi@0	47	* control exactly how the pipeline is composed.
aoqi@0	48	*
aoqi@0	49	* <p>
aoqi@0	50	* JAX-WS is going to have its own default implementation
aoqi@0	51	* when used all by itself, but it can be substituted by
aoqi@0	52	* other implementations.
aoqi@0	53	*
aoqi@0	54	* <p>
aoqi@0	55	* See {@link PipelineAssemblerFactory} for how {@link PipelineAssembler}s
aoqi@0	56	* are located.
aoqi@0	57	*
aoqi@0	58	* <p>
aoqi@0	59	* TODO: the JAX-WS team felt that no {@link Pipe} should be relying
aoqi@0	60	* on the {@link SEIModel}, so it is no longer given to the assembler.
aoqi@0	61	* Talk to us if you need it.
aoqi@0	62	*
aoqi@0	63	* @see ClientPipeAssemblerContext
aoqi@0	64	*
aoqi@0	65	* @author Kohsuke Kawaguchi
aoqi@0	66	*/
aoqi@0	67	public interface PipelineAssembler {
aoqi@0	68	/**
aoqi@0	69	* Creates a new pipeline for clients.
aoqi@0	70	*
aoqi@0	71	* <p>
aoqi@0	72	* When a JAX-WS client creates a proxy or a {@link Dispatch} from
aoqi@0	73	* a {@link Service}, JAX-WS runtime internally uses this method
aoqi@0	74	* to create a new pipeline as a part of the initilization.
aoqi@0	75	*
aoqi@0	76	* @param context
aoqi@0	77	* Object that captures various contextual information
aoqi@0	78	* that can be used to determine the pipeline to be assembled.
aoqi@0	79	*
aoqi@0	80	* @return
aoqi@0	81	* non-null freshly created pipeline.
aoqi@0	82	*
aoqi@0	83	* @throws WebServiceException
aoqi@0	84	* if there's any configuration error that prevents the
aoqi@0	85	* pipeline from being constructed. This exception will be
aoqi@0	86	* propagated into the application, so it must have
aoqi@0	87	* a descriptive error.
aoqi@0	88	*/
aoqi@0	89	@NotNull Pipe createClient(@NotNull ClientPipeAssemblerContext context);
aoqi@0	90
aoqi@0	91	/**
aoqi@0	92	* Creates a new pipeline for servers.
aoqi@0	93	*
aoqi@0	94	* <p>
aoqi@0	95	* When a JAX-WS server deploys a new endpoint, it internally
aoqi@0	96	* uses this method to create a new pipeline as a part of the
aoqi@0	97	* initialization.
aoqi@0	98	*
aoqi@0	99	* <p>
aoqi@0	100	* Note that this method is called only once to set up a
aoqi@0	101	* 'master pipeline', and it gets {@link Pipe#copy(PipeCloner) copied}
aoqi@0	102	* from it.
aoqi@0	103	*
aoqi@0	104	* @param context
aoqi@0	105	* Object that captures various contextual information
aoqi@0	106	* that can be used to determine the pipeline to be assembled.
aoqi@0	107	*
aoqi@0	108	* @return
aoqi@0	109	* non-null freshly created pipeline.
aoqi@0	110	*
aoqi@0	111	* @throws WebServiceException
aoqi@0	112	* if there's any configuration error that prevents the
aoqi@0	113	* pipeline from being constructed. This exception will be
aoqi@0	114	* propagated into the container, so it must have
aoqi@0	115	* a descriptive error.
aoqi@0	116	*
aoqi@0	117	*/
aoqi@0	118	@NotNull Pipe createServer(@NotNull ServerPipeAssemblerContext context);
aoqi@0	119	}