com.sun.xml.ws.api.server.TransportBackChannel Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2018 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 com.sun.xml.ws.api.server;
import com.sun.xml.ws.api.message.Packet;
import com.sun.xml.ws.api.server.WSEndpoint.PipeHead;
/**
* Represents a transport back-channel.
*
*
* When the JAX-WS runtime finds out that the request
* {@link Packet} being processed is known not to produce
* a response, it invokes the {@link #close()} method
* to indicate that the transport does not need to keep
* the channel for the response message open.
*
*
* This allows the transport to close down the communication
* channel sooner than wainting for
* {@link PipeHead#process}
* method to return, thereby improving the overall throughput
* of the system.
*
* @author Kohsuke Kawaguchi
* @author Jitu
*/
public interface TransportBackChannel {
/**
* See the class javadoc for the discussion.
*
*
* JAX-WS is not guaranteed to call this method for all
* operations that do not have a response. This is merely
* a hint.
*
*
* When the implementation of this method fails to close
* the connection successfuly, it should record the error,
* and return normally. Do not throw any exception.
*/
void close();
}