Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/ws/handler/Handler.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/javax/xml/ws/handler/Handler.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 368
- 0989ad8c0860
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.xml.ws.handler; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import javax.xml.ws.ProtocolException; |
| aoqi@0 | 29 | import javax.xml.ws.handler.MessageContext; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** The <code>Handler</code> interface |
| aoqi@0 | 32 | * is the base interface for JAX-WS handlers. |
| aoqi@0 | 33 | * |
| aoqi@0 | 34 | * @since JAX-WS 2.0 |
| aoqi@0 | 35 | **/ |
| aoqi@0 | 36 | public interface Handler<C extends MessageContext> { |
| aoqi@0 | 37 | |
| aoqi@0 | 38 | /** The <code>handleMessage</code> method is invoked for normal processing |
| aoqi@0 | 39 | * of inbound and outbound messages. Refer to the description of the handler |
| aoqi@0 | 40 | * framework in the JAX-WS specification for full details. |
| aoqi@0 | 41 | * |
| aoqi@0 | 42 | * @param context the message context. |
| aoqi@0 | 43 | * @return An indication of whether handler processing should continue for |
| aoqi@0 | 44 | * the current message |
| aoqi@0 | 45 | * <ul> |
| aoqi@0 | 46 | * <li>Return <code>true</code> to continue |
| aoqi@0 | 47 | * processing.</li> |
| aoqi@0 | 48 | * <li>Return <code>false</code> to block |
| aoqi@0 | 49 | * processing.</li> |
| aoqi@0 | 50 | * </ul> |
| aoqi@0 | 51 | * @throws RuntimeException Causes the JAX-WS runtime to cease |
| aoqi@0 | 52 | * handler processing and generate a fault. |
| aoqi@0 | 53 | * @throws ProtocolException Causes the JAX-WS runtime to switch to |
| aoqi@0 | 54 | * fault message processing. |
| aoqi@0 | 55 | **/ |
| aoqi@0 | 56 | public boolean handleMessage(C context); |
| aoqi@0 | 57 | |
| aoqi@0 | 58 | /** The <code>handleFault</code> method is invoked for fault message |
| aoqi@0 | 59 | * processing. Refer to the description of the handler |
| aoqi@0 | 60 | * framework in the JAX-WS specification for full details. |
| aoqi@0 | 61 | * |
| aoqi@0 | 62 | * @param context the message context |
| aoqi@0 | 63 | * @return An indication of whether handler fault processing should continue |
| aoqi@0 | 64 | * for the current message |
| aoqi@0 | 65 | * <ul> |
| aoqi@0 | 66 | * <li>Return <code>true</code> to continue |
| aoqi@0 | 67 | * processing.</li> |
| aoqi@0 | 68 | * <li>Return <code>false</code> to block |
| aoqi@0 | 69 | * processing.</li> |
| aoqi@0 | 70 | * </ul> |
| aoqi@0 | 71 | * @throws RuntimeException Causes the JAX-WS runtime to cease |
| aoqi@0 | 72 | * handler fault processing and dispatch the fault. |
| aoqi@0 | 73 | * @throws ProtocolException Causes the JAX-WS runtime to cease |
| aoqi@0 | 74 | * handler fault processing and dispatch the fault. |
| aoqi@0 | 75 | **/ |
| aoqi@0 | 76 | public boolean handleFault(C context); |
| aoqi@0 | 77 | |
| aoqi@0 | 78 | /** |
| aoqi@0 | 79 | * Called at the conclusion of a message exchange pattern just prior to |
| aoqi@0 | 80 | * the JAX-WS runtime dispatching a message, fault or exception. Refer to |
| aoqi@0 | 81 | * the description of the handler |
| aoqi@0 | 82 | * framework in the JAX-WS specification for full details. |
| aoqi@0 | 83 | * |
| aoqi@0 | 84 | * @param context the message context |
| aoqi@0 | 85 | **/ |
| aoqi@0 | 86 | public void close(MessageContext context); |
| aoqi@0 | 87 | } |
