01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.api.client;
38:
39: import com.sun.istack.NotNull;
40: import com.sun.xml.ws.api.pipe.Pipe;
41: import com.sun.xml.ws.api.pipe.ClientPipeAssemblerContext;
42:
43: /**
44: * Allow the container (primarily Glassfish) to inject
45: * their own pipes into the client pipeline.
46: *
47: * <p>
48: * This interface has a rather ad-hoc set of methods, because
49: * we didn't want to define an autonomous pipe-assembly process.
50: * (We thought this is a smaller evil compared to that.)
51: *
52: * <p>
53: * JAX-WS obtains this through {@link com.sun.xml.ws.api.server.Container#getSPI(Class)}.
54: *
55: * @author Jitendra Kotamraju
56: */
57: public abstract class ClientPipelineHook {
58:
59: /**
60: * Called during the pipeline construction process once to allow a container
61: * to register a pipe for security.
62: *
63: * This pipe will be injected to a point very close to the transport, allowing
64: * it to do some security operations.
65: *
66: * @param ctxt
67: * Represents abstraction of SEI, WSDL abstraction etc. Context can be used
68: * whether add a new pipe to the head or not.
69: *
70: * @param tail
71: * Head of the partially constructed pipeline. If the implementation
72: * wishes to add new pipes, it should do so by extending
73: * {@link com.sun.xml.ws.api.pipe.helper.AbstractFilterPipeImpl} and making sure that this {@link com.sun.xml.ws.api.pipe.Pipe}
74: * eventually processes messages.
75: *
76: * @return
77: * The default implementation just returns <tt>tail</tt>, which means
78: * no additional pipe is inserted. If the implementation adds
79: * new pipes, return the new head pipe.
80: */
81: public @NotNull
82: Pipe createSecurityPipe(ClientPipeAssemblerContext ctxt, @NotNull
83: Pipe tail) {
84: return tail;
85: }
86: }
|