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

mercurial