1 /*
   2  * Copyright (c) 1997, 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 com.sun.xml.internal.ws.api.server;
  27 
  28 import com.sun.istack.internal.NotNull;
  29 import com.sun.istack.internal.Nullable;
  30 
  31 /**
  32  * Callback interface to signal JAX-WS RI that the processing of an asynchronous request is complete.
  33  *
  34  * <p>
  35  * The application is responsible for invoking one of the two defined methods to
  36  * indicate the result of the request processing.
  37  *
  38  * <p>
  39  * Both methods will return immediately, and the JAX-WS RI will
  40  * send out an actual response at some later point.
  41  *
  42  * @author Jitendra Kotamraju
  43  * @author Kohsuke Kawaguchi
  44  * @since 2.1
  45  * @see AsyncProvider
  46  */
  47 public interface AsyncProviderCallback<T> {
  48     /**
  49      * Indicates that a request was processed successfully.
  50      *
  51      * @param response
  52      *      Represents an object to be sent back to the client
  53      *      as a response. To indicate one-way, response needs to be null
  54      */
  55     void send(@Nullable T response);
  56 
  57     /**
  58      * Indicates that an error had occured while processing a request.
  59      *
  60      * @param t
  61      *      The error is propagated to the client. For example, if this is
  62      *      a SOAP-based web service, the server will send back a SOAP fault.
  63      */
  64     void sendError(@NotNull Throwable t);
  65 }