View Javadoc
1   /*
2    * Copyright (c) 2005, 2010, 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 javax.xml.ws;
27  
28  
29  /** The <code>Binding</code> interface is the base interface
30   *  for JAX-WS protocol bindings.
31   *
32   *  @since JAX-WS 2.0
33  **/
34  public interface Binding {
35  
36     /**
37      * Gets a copy of the handler chain for a protocol binding instance.
38      * If the returned chain is modified a call to <code>setHandlerChain</code>
39      * is required to configure the binding instance with the new chain.
40      *
41      *  @return java.util.List&lt;Handler> Handler chain
42      */
43      public java.util.List<javax.xml.ws.handler.Handler> getHandlerChain();
44  
45     /**
46      * Sets the handler chain for the protocol binding instance.
47      *
48      *  @param chain    A List of handler configuration entries
49      *  @throws WebServiceException On an error in the configuration of
50      *                  the handler chain
51      *  @throws java.lang.UnsupportedOperationException If this
52      *          operation is not supported. This may be done to
53      *          avoid any overriding of a pre-configured handler
54      *          chain.
55      */
56      public void setHandlerChain(java.util.List<javax.xml.ws.handler.Handler> chain);
57  
58      /**
59       * Get the URI for this binding instance.
60       *
61       * @return String The binding identifier for the port.
62       *    Never returns <code>null</code>
63       *
64       * @since JAX-WS 2.1
65       */
66      String getBindingID();
67  }