| /* |
| * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package com.sun.xml.internal.ws.api.client; |
| |
| import com.sun.istack.internal.NotNull; |
| import com.sun.xml.internal.ws.api.pipe.Pipe; |
| import com.sun.xml.internal.ws.api.pipe.ClientPipeAssemblerContext; |
| |
| /** |
| * Allow the container (primarily Glassfish) to inject |
| * their own pipes into the client pipeline. |
| * |
| * <p> |
| * This interface has a rather ad-hoc set of methods, because |
| * we didn't want to define an autonomous pipe-assembly process. |
| * (We thought this is a smaller evil compared to that.) |
| * |
| * <p> |
| * JAX-WS obtains this through {@link com.sun.xml.internal.ws.api.server.Container#getSPI(Class)}. |
| * |
| * @author Jitendra Kotamraju |
| */ |
| public abstract class ClientPipelineHook { |
| |
| /** |
| * Called during the pipeline construction process once to allow a container |
| * to register a pipe for security. |
| * |
| * This pipe will be injected to a point very close to the transport, allowing |
| * it to do some security operations. |
| * |
| * @param ctxt |
| * Represents abstraction of SEI, WSDL abstraction etc. Context can be used |
| * whether add a new pipe to the head or not. |
| * |
| * @param tail |
| * Head of the partially constructed pipeline. If the implementation |
| * wishes to add new pipes, it should do so by extending |
| * {@link com.sun.xml.internal.ws.api.pipe.helper.AbstractFilterPipeImpl} and making sure that this {@link com.sun.xml.internal.ws.api.pipe.Pipe} |
| * eventually processes messages. |
| * |
| * @return |
| * The default implementation just returns {@code tail}, which means |
| * no additional pipe is inserted. If the implementation adds |
| * new pipes, return the new head pipe. |
| */ |
| public @NotNull Pipe createSecurityPipe(ClientPipeAssemblerContext ctxt, @NotNull Pipe tail) { |
| return tail; |
| } |
| } |