< prev index next >

src/java.xml.ws/share/classes/javax/xml/ws/handler/soap/SOAPHandler.java

Print this page


   1 /*
   2  * Copyright (c) 2005, 2012, 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.handler.soap;
  27 
  28 import javax.xml.namespace.QName;
  29 import javax.xml.ws.handler.Handler;
  30 import java.util.Set;
  31 
  32 /** The <code>SOAPHandler</code> class extends <code>Handler</code>
  33  *  to provide typesafety for the message context parameter and add a method
  34  *  to obtain access to the headers that may be processed by the handler.
  35  *
  36  *  @since 1.6, JAX-WS 2.0
  37 **/
  38 public interface SOAPHandler<T extends SOAPMessageContext>
  39     extends Handler<T> {
  40 
  41   /** Gets the header blocks that can be processed by this Handler
  42    *  instance.
  43    *
  44    *  @return Set of <code>QNames</code> of header blocks processed by this
  45    *           handler instance. <code>QName</code> is the qualified
  46    *           name of the outermost element of the Header block.
  47   **/
  48   Set<QName> getHeaders();
  49 }
   1 /*
   2  * Copyright (c) 2005, 2015, 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.handler.soap;
  27 
  28 import javax.xml.namespace.QName;
  29 import javax.xml.ws.handler.Handler;
  30 import java.util.Set;
  31 
  32 /** The {@code SOAPHandler} class extends {@code Handler}
  33  *  to provide typesafety for the message context parameter and add a method
  34  *  to obtain access to the headers that may be processed by the handler.
  35  *
  36  *  @since 1.6, JAX-WS 2.0
  37 **/
  38 public interface SOAPHandler<T extends SOAPMessageContext>
  39     extends Handler<T> {
  40 
  41   /** Gets the header blocks that can be processed by this Handler
  42    *  instance.
  43    *
  44    *  @return Set of {@code QNames} of header blocks processed by this
  45    *           handler instance. {@code QName} is the qualified
  46    *           name of the outermost element of the Header block.
  47   **/
  48   Set<QName> getHeaders();
  49 }
< prev index next >