001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.ws.api.pipe;
038:
039: import com.sun.xml.ws.api.WSBinding;
040: import com.sun.xml.ws.api.server.WSEndpoint;
041: import com.sun.xml.ws.api.WSService;
042: import com.sun.xml.ws.api.EndpointAddress;
043: import com.sun.xml.ws.api.model.SEIModel;
044: import com.sun.xml.ws.api.model.wsdl.WSDLPort;
045: import com.sun.istack.NotNull;
046: import com.sun.istack.Nullable;
047:
048: import javax.xml.ws.Dispatch;
049: import javax.xml.ws.Provider;
050: import javax.xml.ws.Service;
051: import javax.xml.ws.WebServiceException;
052:
053: /**
054: * Creates a pipeline.
055: *
056: * <p>
057: * This pluggability layer enables the upper layer to
058: * control exactly how the pipeline is composed.
059: *
060: * <p>
061: * JAX-WS is going to have its own default implementation
062: * when used all by itself, but it can be substituted by
063: * other implementations.
064: *
065: * <p>
066: * See {@link PipelineAssemblerFactory} for how {@link PipelineAssembler}s
067: * are located.
068: *
069: * <p>
070: * TODO: the JAX-WS team felt that no {@link Pipe} should be relying
071: * on the {@link SEIModel}, so it is no longer given to the assembler.
072: * Talk to us if you need it.
073: *
074: * @see ClientPipeAssemblerContext
075: *
076: * @author Kohsuke Kawaguchi
077: */
078: public interface PipelineAssembler {
079: /**
080: * Creates a new pipeline for clients.
081: *
082: * <p>
083: * When a JAX-WS client creates a proxy or a {@link Dispatch} from
084: * a {@link Service}, JAX-WS runtime internally uses this method
085: * to create a new pipeline as a part of the initilization.
086: *
087: * @param context
088: * Object that captures various contextual information
089: * that can be used to determine the pipeline to be assembled.
090: *
091: * @return
092: * non-null freshly created pipeline.
093: *
094: * @throws WebServiceException
095: * if there's any configuration error that prevents the
096: * pipeline from being constructed. This exception will be
097: * propagated into the application, so it must have
098: * a descriptive error.
099: */
100: @NotNull
101: Pipe createClient(@NotNull
102: ClientPipeAssemblerContext context);
103:
104: /**
105: * Creates a new pipeline for servers.
106: *
107: * <p>
108: * When a JAX-WS server deploys a new endpoint, it internally
109: * uses this method to create a new pipeline as a part of the
110: * initialization.
111: *
112: * <p>
113: * Note that this method is called only once to set up a
114: * 'master pipeline', and it gets {@link Pipe#copy(PipeCloner) copied}
115: * from it.
116: *
117: * @param context
118: * Object that captures various contextual information
119: * that can be used to determine the pipeline to be assembled.
120: *
121: * @return
122: * non-null freshly created pipeline.
123: *
124: * @throws WebServiceException
125: * if there's any configuration error that prevents the
126: * pipeline from being constructed. This exception will be
127: * propagated into the container, so it must have
128: * a descriptive error.
129: *
130: */
131: @NotNull
132: Pipe createServer(@NotNull
133: ServerPipeAssemblerContext context);
134: }
|