325N/A/*
325N/A * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage javax.xml.ws.handler;
325N/A
325N/Aimport javax.xml.ws.ProtocolException;
325N/Aimport javax.xml.ws.handler.MessageContext;
325N/A
325N/A/** The <code>Handler</code> interface
325N/A * is the base interface for JAX-WS handlers.
325N/A *
325N/A * @since JAX-WS 2.0
325N/A**/
325N/Apublic interface Handler<C extends MessageContext> {
325N/A
325N/A /** The <code>handleMessage</code> method is invoked for normal processing
325N/A * of inbound and outbound messages. Refer to the description of the handler
325N/A * framework in the JAX-WS specification for full details.
325N/A *
325N/A * @param context the message context.
325N/A * @return An indication of whether handler processing should continue for
325N/A * the current message
325N/A * <ul>
325N/A * <li>Return <code>true</code> to continue
325N/A * processing.</li>
325N/A * <li>Return <code>false</code> to block
325N/A * processing.</li>
325N/A * </ul>
325N/A * @throws RuntimeException Causes the JAX-WS runtime to cease
325N/A * handler processing and generate a fault.
325N/A * @throws ProtocolException Causes the JAX-WS runtime to switch to
325N/A * fault message processing.
325N/A **/
325N/A public boolean handleMessage(C context);
325N/A
325N/A /** The <code>handleFault</code> method is invoked for fault message
325N/A * processing. Refer to the description of the handler
325N/A * framework in the JAX-WS specification for full details.
325N/A *
325N/A * @param context the message context
325N/A * @return An indication of whether handler fault processing should continue
325N/A * for the current message
325N/A * <ul>
325N/A * <li>Return <code>true</code> to continue
325N/A * processing.</li>
325N/A * <li>Return <code>false</code> to block
325N/A * processing.</li>
325N/A * </ul>
325N/A * @throws RuntimeException Causes the JAX-WS runtime to cease
325N/A * handler fault processing and dispatch the fault.
325N/A * @throws ProtocolException Causes the JAX-WS runtime to cease
325N/A * handler fault processing and dispatch the fault.
325N/A **/
325N/A public boolean handleFault(C context);
325N/A
325N/A /**
325N/A * Called at the conclusion of a message exchange pattern just prior to
325N/A * the JAX-WS runtime disptaching a message, fault or exception. Refer to
325N/A * the description of the handler
325N/A * framework in the JAX-WS specification for full details.
325N/A *
325N/A * @param context the message context
325N/A **/
325N/A public void close(MessageContext context);
325N/A}