jakarta.xml.ws.Response Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package jakarta.xml.ws;

import java.util.Map;
import java.util.concurrent.Future;

/** The {@code 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 {@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.
 *
 * @param  The type of the response
 *  @since 1.6, JAX-WS 2.0
**/
public interface Response extends Future {
    /** Gets the contained response context.
     *
     * @return The contained response context. May be {@code null} if a
     * response is not yet available.
     *
    **/
    Map getContext();
}