Undertow 2.3.12.Final · io.undertow.client.ajp.AjpClientConnection

Modifier and Type	Class and Description
pack-priv class	AjpClientConnection.ClientReceiveListener

Field Summary

Modifier and Type	Field and Description
private final ByteBufferPool	bufferPool
private final ClientStatistics	clientStatistics
private static final int	CLOSE_REQ
private static final int	CLOSED
private final List<ChannelListener<ClientConnection>>	closeListeners
private final ChannelListener.SimpleSetter<AjpClientConnection>	closeSetter
private final AjpClientChannel	connection
private AjpClientExchange	currentRequest
private static final Logger	log
private final OptionMap	options
private final Deque<AjpClientExchange>	pendingQueue
public final ChannelListener<AjpClientRequestClientStreamSinkChannel>	requestFinishListener
public final ChannelListener<AjpClientResponseStreamSourceChannel>	responseFinishedListener
private int	state
private static final int	UPGRADE_REQUESTED
private static final int	UPGRADED

Access	Constructor and Description
pack-priv	AjpClientConnection(final AjpClientChannel connection, final OptionMap options, final ByteBufferPool bufferPool, ClientStatistics clientStatistics)

Method Summary

Modifier and Type	Method and Description
public void	addCloseListener(ChannelListener<ClientConnection> The close listener listener) Implements io.undertow.client.ClientConnection.addCloseListener. Adds a close listener, than will be invoked with the connection is closed
public void	close() Implements java.io.Closeable.close, java.nio.channels.Channel.close. Closes this stream and releases any system resources associated with it.
public ByteBufferPool	getBufferPool() Implements io.undertow.client.ClientConnection.getBufferPool.
public ChannelListener.Setter<? extends AjpClientConnection>	getCloseSetter() Implements io.undertow.client.ClientConnection.getCloseSetter.
public XnioIoThread	getIoThread() Implements io.undertow.client.ClientConnection.getIoThread.
public SocketAddress	getLocalAddress() Implements io.undertow.client.ClientConnection.getLocalAddress.
public <A extends SocketAddress> A	getLocalAddress(Class<A> type) Implements io.undertow.client.ClientConnection.getLocalAddress.
public <T> T	getOption(Option<T> option) Implements io.undertow.client.ClientConnection.getOption.
public SocketAddress	getPeerAddress() Implements io.undertow.client.ClientConnection.getPeerAddress.
public <A extends SocketAddress> A	getPeerAddress(Class<A> type) Implements io.undertow.client.ClientConnection.getPeerAddress.
public ClientStatistics	getStatistics() Implements io.undertow.client.ClientConnection.getStatistics.
public XnioWorker	getWorker() Implements io.undertow.client.ClientConnection.getWorker.
private void	handleError(IOException exception)
private void	handleFailedFlush(AjpClientRequestClientStreamSinkChannel sinkChannel)
private void	initiateRequest(AjpClientExchange AjpClientExchange)
public boolean	isMultiplexingSupported() Implements io.undertow.client.ClientConnection.isMultiplexingSupported.
public boolean	isOpen() Implements io.undertow.client.ClientConnection.isOpen. Tells whether or not this channel is open.
public boolean	isPingSupported() Overrides default io.undertow.client.ClientConnection.isPingSupported.
public boolean	isPushSupported() Implements io.undertow.client.ClientConnection.isPushSupported.
public boolean	isUpgraded() Implements io.undertow.client.ClientConnection.isUpgraded.
public boolean	isUpgradeSupported() Implements io.undertow.client.ClientConnection.isUpgradeSupported.
public StreamConnection	performUpgrade() Implements io.undertow.client.ClientConnection.performUpgrade. Upgrade the connection, if the underlying protocol supports it.
public void	requestClose()
public void	requestDone() Notification that the current request is finished
public void	sendPing(ClientConnection.PingListener listener, long timeout, TimeUnit timeUnit) Overrides default io.undertow.client.ClientConnection.sendPing.
public void	sendRequest(final ClientRequest The request to send. request, final ClientCallback<ClientExchange> clientCallback) Implements io.undertow.client.ClientConnection.sendRequest. Sends a client request.
public <T> T	setOption(Option<T> option, T value) Implements io.undertow.client.ClientConnection.setOption.
public boolean	supportsOption(Option<?> option) Implements io.undertow.client.ClientConnection.supportsOption.

Inherited from io.undertow.util.AbstractAttachable:: addToAttachmentList createAttachmentMap getAttachment getAttachmentList putAttachment removeAttachment

Field Detail

bufferPool	back to summary
private final ByteBufferPool bufferPool

clientStatistics	back to summary
private final ClientStatistics clientStatistics

CLOSE_REQ	back to summary
private static final int CLOSE_REQ

CLOSED	back to summary
private static final int CLOSED

closeListeners	back to summary
private final List<ChannelListener<ClientConnection>> closeListeners

closeSetter	back to summary
private final ChannelListener.SimpleSetter<AjpClientConnection> closeSetter

connection	back to summary
private final AjpClientChannel connection

currentRequest	back to summary
private AjpClientExchange currentRequest

log	back to summary
private static final Logger log

options	back to summary
private final OptionMap options

pendingQueue	back to summary
private final Deque<AjpClientExchange> pendingQueue

requestFinishListener	back to summary
public final ChannelListener<AjpClientRequestClientStreamSinkChannel> requestFinishListener

responseFinishedListener	back to summary
public final ChannelListener<AjpClientResponseStreamSourceChannel> responseFinishedListener

state	back to summary
private int state

UPGRADE_REQUESTED	back to summary
private static final int UPGRADE_REQUESTED

UPGRADED	back to summary
private static final int UPGRADED

Constructor Detail

AjpClientConnection	back to summary
pack-priv AjpClientConnection(final AjpClientChannel connection, final OptionMap options, final ByteBufferPool bufferPool, ClientStatistics clientStatistics)

Method Detail

addCloseListener	back to summary
public void addCloseListener(ChannelListener<ClientConnection> listener) Implements io.undertow.client.ClientConnection.addCloseListener. Doc from io.undertow.client.ClientConnection.addCloseListener. Adds a close listener, than will be invoked with the connection is closed Parameters listener:ChannelListener<ClientConnection> The close listener Annotations @Override

addCloseListener

back to summary

public void addCloseListener(ChannelListener<ClientConnection> listener)

Implements io.undertow.client.ClientConnection.addCloseListener.

Doc from io.undertow.client.ClientConnection.addCloseListener.

Adds a close listener, than will be invoked with the connection is closed

Parameters

listener:ChannelListener<ClientConnection>: The close listener

Annotations

@Override

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close, java.nio.channels.Channel.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close, java.nio.channels.Channel.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Exceptions

IOException:: if an I/O error occurs

getBufferPool	back to summary
public ByteBufferPool getBufferPool() Implements io.undertow.client.ClientConnection.getBufferPool. Returns:ByteBufferPool Doc from io.undertow.client.ClientConnection.getBufferPool. The buffer pool used by the client Annotations @Override

getBufferPool

back to summary

public ByteBufferPool getBufferPool()

Implements io.undertow.client.ClientConnection.getBufferPool.

Returns:ByteBufferPool

Doc from io.undertow.client.ClientConnection.getBufferPool.

The buffer pool used by the client

Annotations

@Override

getCloseSetter	back to summary
public ChannelListener.Setter<? extends AjpClientConnection> getCloseSetter() Implements io.undertow.client.ClientConnection.getCloseSetter. Annotations @Override

getCloseSetter

back to summary

public ChannelListener.Setter<? extends AjpClientConnection> getCloseSetter()

Implements io.undertow.client.ClientConnection.getCloseSetter.

Annotations

@Override

getIoThread	back to summary
public XnioIoThread getIoThread() Implements io.undertow.client.ClientConnection.getIoThread. Annotations @Override

getIoThread

back to summary

public XnioIoThread getIoThread()

Implements io.undertow.client.ClientConnection.getIoThread.

Annotations

@Override

getLocalAddress	back to summary
public SocketAddress getLocalAddress() Implements io.undertow.client.ClientConnection.getLocalAddress. Annotations @Override

getLocalAddress

back to summary

public SocketAddress getLocalAddress()

Implements io.undertow.client.ClientConnection.getLocalAddress.

Annotations

@Override

getLocalAddress	back to summary
public <A extends SocketAddress> A getLocalAddress(Class<A> type) Implements io.undertow.client.ClientConnection.getLocalAddress. Annotations @Override

getLocalAddress

back to summary

public <A extends SocketAddress> A getLocalAddress(Class<A> type)

Implements io.undertow.client.ClientConnection.getLocalAddress.

Annotations

@Override

getOption	back to summary
public <T> T getOption(Option<T> option) throws IOException Implements io.undertow.client.ClientConnection.getOption. Annotations @Override

getOption

back to summary

public <T> T getOption(Option<T> option) throws IOException

Implements io.undertow.client.ClientConnection.getOption.

Annotations

@Override

getPeerAddress	back to summary
public SocketAddress getPeerAddress() Implements io.undertow.client.ClientConnection.getPeerAddress. Annotations @Override

getPeerAddress

back to summary

public SocketAddress getPeerAddress()

Implements io.undertow.client.ClientConnection.getPeerAddress.

Annotations

@Override

getPeerAddress	back to summary
public <A extends SocketAddress> A getPeerAddress(Class<A> type) Implements io.undertow.client.ClientConnection.getPeerAddress. Annotations @Override

getPeerAddress

back to summary

public <A extends SocketAddress> A getPeerAddress(Class<A> type)

Implements io.undertow.client.ClientConnection.getPeerAddress.

Annotations

@Override

getStatistics back to summary

getStatistics	back to summary
public ClientStatistics getStatistics() Implements io.undertow.client.ClientConnection.getStatistics. Returns:ClientStatistics Doc from io.undertow.client.ClientConnection.getStatistics. the statistics information, or `null` if statistics are not supported or disabled Annotations @Override

public ClientStatistics getStatistics()

Implements io.undertow.client.ClientConnection.getStatistics.

Returns:ClientStatistics

Doc from io.undertow.client.ClientConnection.getStatistics.

the statistics information, or null if statistics are not supported or disabled

Annotations

@Override

getWorker	back to summary
public XnioWorker getWorker() Implements io.undertow.client.ClientConnection.getWorker. Annotations @Override

getWorker

back to summary

public XnioWorker getWorker()

Implements io.undertow.client.ClientConnection.getWorker.

Annotations

@Override

handleError	back to summary
private void handleError(IOException exception)

handleFailedFlush	back to summary
private void handleFailedFlush(AjpClientRequestClientStreamSinkChannel sinkChannel)

initiateRequest	back to summary
private void initiateRequest(AjpClientExchange AjpClientExchange)

isMultiplexingSupported back to summary

isMultiplexingSupported	back to summary
public boolean isMultiplexingSupported() Implements io.undertow.client.ClientConnection.isMultiplexingSupported. Returns:boolean Doc from io.undertow.client.ClientConnection.isMultiplexingSupported. `true` if this client supports multiplexing Annotations @Override

public boolean isMultiplexingSupported()

Implements io.undertow.client.ClientConnection.isMultiplexingSupported.

Returns:boolean

Doc from io.undertow.client.ClientConnection.isMultiplexingSupported.

true if this client supports multiplexing

Annotations

@Override

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements io.undertow.client.ClientConnection.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public boolean isOpen()

Implements io.undertow.client.ClientConnection.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

isPingSupported back to summary

isPingSupported	back to summary
public boolean isPingSupported() Overrides default io.undertow.client.ClientConnection.isPingSupported. Returns:boolean Doc from io.undertow.client.ClientConnection.isPingSupported. `true` if the underlying protocol supports sending a ping Annotations @Override

public boolean isPingSupported()

Overrides default io.undertow.client.ClientConnection.isPingSupported.

Returns:boolean

Doc from io.undertow.client.ClientConnection.isPingSupported.

true if the underlying protocol supports sending a ping

Annotations

@Override

isPushSupported back to summary

isPushSupported	back to summary
public boolean isPushSupported() Implements io.undertow.client.ClientConnection.isPushSupported. Returns:boolean Doc from io.undertow.client.ClientConnection.isPushSupported. `true` if this connection support server push Annotations @Override

public boolean isPushSupported()

Implements io.undertow.client.ClientConnection.isPushSupported.

Returns:boolean

Doc from io.undertow.client.ClientConnection.isPushSupported.

true if this connection support server push

Annotations

@Override

isUpgraded	back to summary
public boolean isUpgraded() Implements io.undertow.client.ClientConnection.isUpgraded. Annotations @Override

isUpgraded

back to summary

public boolean isUpgraded()

Implements io.undertow.client.ClientConnection.isUpgraded.

Annotations

@Override

isUpgradeSupported	back to summary
public boolean isUpgradeSupported() Implements io.undertow.client.ClientConnection.isUpgradeSupported. Annotations @Override

isUpgradeSupported

back to summary

public boolean isUpgradeSupported()

Implements io.undertow.client.ClientConnection.isUpgradeSupported.

Annotations

@Override

performUpgrade	back to summary
public StreamConnection performUpgrade() throws IOException Implements io.undertow.client.ClientConnection.performUpgrade. Doc from io.undertow.client.ClientConnection.performUpgrade. Upgrade the connection, if the underlying protocol supports it. This should only be called after an upgrade request has been submitted and the target server has accepted the upgrade. Returns:StreamConnection The resulting StreamConnection

performUpgrade

back to summary

public StreamConnection performUpgrade() throws IOException

Implements io.undertow.client.ClientConnection.performUpgrade.

Doc from io.undertow.client.ClientConnection.performUpgrade.

Upgrade the connection, if the underlying protocol supports it. This should only be called after an upgrade request has been submitted and the target server has accepted the upgrade.

Returns:StreamConnection: The resulting StreamConnection

requestClose	back to summary
public void requestClose()

requestDone	back to summary
public void requestDone() Notification that the current request is finished

sendPing	back to summary
public void sendPing(ClientConnection.PingListener listener, long timeout, TimeUnit timeUnit) Overrides default io.undertow.client.ClientConnection.sendPing. Annotations @Override

sendPing

back to summary

public void sendPing(ClientConnection.PingListener listener, long timeout, TimeUnit timeUnit)

Overrides default io.undertow.client.ClientConnection.sendPing.

Annotations

@Override

sendRequest back to summary

sendRequest	back to summary
public void sendRequest(final ClientRequest request, final ClientCallback<ClientExchange> clientCallback) Implements io.undertow.client.ClientConnection.sendRequest. Doc from io.undertow.client.ClientConnection.sendRequest. Sends a client request. The request object should not be modified after it has been submitted to the connection. Request objects can be queued. Once the request is in a state that it is ready to be sent the `clientCallback` is invoked to provide the caller with the `ClientExchange` If `isMultiplexingSupported()` returns true then multiple requests may be active at the same time, and a later request may complete before an earlier one. Note that the request header may not be written out until after the callback has been invoked. This allows the client to write out a header with a gathering write if the request contains content. Parameters request:ClientRequest The request to send. Annotations @Override

public void sendRequest(final ClientRequest request, final ClientCallback<ClientExchange> clientCallback)

Implements io.undertow.client.ClientConnection.sendRequest.

Doc from io.undertow.client.ClientConnection.sendRequest.

Sends a client request. The request object should not be modified after it has been submitted to the connection.

Request objects can be queued. Once the request is in a state that it is ready to be sent the clientCallback is invoked to provide the caller with the ClientExchange

If isMultiplexingSupported() returns true then multiple requests may be active at the same time, and a later request may complete before an earlier one.

Note that the request header may not be written out until after the callback has been invoked. This allows the client to write out a header with a gathering write if the request contains content.

Parameters

request:ClientRequest: The request to send.

Annotations

@Override

setOption	back to summary
public <T> T setOption(Option<T> option, T value) throws IllegalArgumentException, IOException Implements io.undertow.client.ClientConnection.setOption. Annotations @Override

setOption

back to summary

public <T> T setOption(Option<T> option, T value) throws IllegalArgumentException, IOException

Implements io.undertow.client.ClientConnection.setOption.

Annotations

@Override

supportsOption	back to summary
public boolean supportsOption(Option<?> option) Implements io.undertow.client.ClientConnection.supportsOption. Annotations @Override

supportsOption

back to summary

public boolean supportsOption(Option<?> option)

Implements io.undertow.client.ClientConnection.supportsOption.

Annotations

@Override

Access	Constructor and Description
pack-priv	ClientReceiveListener()

Method Summary

Modifier and Type	Method and Description
public void	handleEvent(AjpClientChannel the channel event channel) Implements org.xnio.ChannelListener.handleEvent. Handle the event on this channel.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ClientReceiveListener	back to summary
pack-priv ClientReceiveListener()

Method Detail

handleEvent

back to summary

public void handleEvent(AjpClientChannel channel)

Implements org.xnio.ChannelListener.handleEvent.

Doc from org.xnio.ChannelListener.handleEvent.

Handle the event on this channel.

Parameters

channel:AjpClientChannel: the channel event

pack-priv Class AjpClientConnection

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class AjpClientConnection.ClientReceiveListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail