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