/*
* Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.xml.ws;
import java.util.Map;
import java.util.concurrent.Future;
The Response
interface provides methods used to obtain the payload and context of a message sent in response to an operation invocation. For asynchronous operation invocations it provides additional methods to check the status of the request. The get(...)
methods may throw the standard set of exceptions and their cause may be a RemoteException
or a WebServiceException
that represents the error that occurred during the asynchronous method invocation.
Type parameters: - <T> – The type of the response
@since 1.6, JAX-WS 2.0
/** The {@code Response} interface provides methods used to obtain the
* payload and context of a message sent in response to an operation
* invocation.
*
* <p>For asynchronous operation invocations it provides additional methods
* to check the status of the request. The {@code get(...)} methods may
* throw the standard
* set of exceptions and their cause may be a {@code RemoteException} or a
* {@link WebServiceException} that represents the error that occurred during the
* asynchronous method invocation.</p>
*
* @param <T> The type of the response
* @since 1.6, JAX-WS 2.0
**/
public interface Response<T> extends Future<T> {
Gets the contained response context.
Returns: The contained response context. May be null
if a response is not yet available.
/** Gets the contained response context.
*
* @return The contained response context. May be {@code null} if a
* response is not yet available.
*
**/
Map<String,Object> getContext();
}