1 /*
   2  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.ws.api.client;
  27 
  28 import com.sun.istack.internal.NotNull;
  29 import com.sun.xml.internal.ws.api.pipe.Pipe;
  30 import com.sun.xml.internal.ws.api.pipe.ClientPipeAssemblerContext;
  31 
  32 /**
  33  * Allow the container (primarily Glassfish) to inject
  34  * their own pipes into the client pipeline.
  35  *
  36  * <p>
  37  * This interface has a rather ad-hoc set of methods, because
  38  * we didn't want to define an autonomous pipe-assembly process.
  39  * (We thought this is a smaller evil compared to that.)
  40  *
  41  * <p>
  42  * JAX-WS obtains this through {@link com.sun.xml.internal.ws.api.server.Container#getSPI(Class)}.
  43  *
  44  * @author Jitendra Kotamraju
  45  */
  46 public abstract class ClientPipelineHook {
  47 
  48     /**
  49      * Called during the pipeline construction process once to allow a container
  50      * to register a pipe for security.
  51      *
  52      * This pipe will be injected to a point very close to the transport, allowing
  53      * it to do some security operations.
  54      *
  55      * @param ctxt
  56      *      Represents abstraction of SEI, WSDL abstraction etc. Context can be used
  57      *      whether add a new pipe to the head or not.
  58      *
  59      * @param tail
  60      *      Head of the partially constructed pipeline. If the implementation
  61      *      wishes to add new pipes, it should do so by extending
  62      *      {@link com.sun.xml.internal.ws.api.pipe.helper.AbstractFilterPipeImpl} and making sure that this {@link com.sun.xml.internal.ws.api.pipe.Pipe}
  63      *      eventually processes messages.
  64      *
  65      * @return
  66      *      The default implementation just returns {@code tail}, which means
  67      *      no additional pipe is inserted. If the implementation adds
  68      *      new pipes, return the new head pipe.
  69      */
  70     public @NotNull Pipe createSecurityPipe(ClientPipeAssemblerContext ctxt, @NotNull Pipe tail) {
  71         return tail;
  72     }
  73 }