Package org.eclipse.jetty.server

Class ProxyConnectionFactory.ProxyEndPoint

java.lang.Object

org.eclipse.jetty.util.AttributesMap

org.eclipse.jetty.server.ProxyConnectionFactory.ProxyEndPoint

All Implemented Interfaces:

Closeable, AutoCloseable, EndPoint, EndPoint.Wrapper, Attributes, Dumpable

Enclosing class:

ProxyConnectionFactory

public static class ProxyConnectionFactory.ProxyEndPoint
extends AttributesMap
implements EndPoint, EndPoint.Wrapper

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Attributes

Attributes.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.EndPoint

EndPoint.Wrapper

Field Summary

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
ProxyEndPoint(EndPoint endPoint, InetSocketAddress remote, InetSocketAddress local)	Deprecated.
ProxyEndPoint(EndPoint endPoint, SocketAddress local, SocketAddress remote)

Method Summary

Modifier and Type	Method	Description
void	close(Throwable cause)	Close any backing stream associated with the endpoint, passing a cause
int	fill(ByteBuffer buffer)	Fill the passed buffer with data from this endpoint.
void	fillInterested(Callback callback)	Requests callback methods to be invoked when a call to EndPoint.fill(ByteBuffer) would return data or EOF.
boolean	flush(ByteBuffer... buffer)	Flush data from the passed header/buffer to this endpoint.
Connection	getConnection()
long	getCreatedTimeStamp()
long	getIdleTimeout()	Get the max idle time in ms.
InetSocketAddress	getLocalAddress()
SocketAddress	getLocalSocketAddress()
InetSocketAddress	getRemoteAddress()
SocketAddress	getRemoteSocketAddress()
byte[]	getTLV(int type)	Gets a TLV vector, see section 2.2.7 of the PROXY protocol specification.
Object	getTransport()
boolean	isFillInterested()
boolean	isInputShutdown()	Test if the input is shutdown.
boolean	isOpen()
boolean	isOutputShutdown()	Test if output is shutdown.
void	onClose(Throwable cause)	Callback method invoked when this EndPoint is closed.
void	onOpen()	Callback method invoked when this EndPoint is opened.
void	setConnection(Connection connection)
void	setIdleTimeout(long idleTimeout)	Set the idle timeout.
void	shutdownOutput()	Shutdown the output.
String	toString()
boolean	tryFillInterested(Callback callback)	Requests callback methods to be invoked when a call to EndPoint.fill(ByteBuffer) would return data or EOF.
EndPoint	unwrap()
void	upgrade(Connection newConnection)	Upgrades this EndPoint from the current connection to the given new connection.
void	write(Callback callback, ByteBuffer... buffers)	Writes the given buffers via EndPoint.flush(ByteBuffer...) and invokes callback methods when either all the data has been flushed or an error occurs.

Methods inherited from class org.eclipse.jetty.util.AttributesMap

addAll, clearAttributes, dump, dump, getAttribute, getAttributeEntrySet, getAttributeNames, getAttributeNamesCopy, getAttributeNameSet, removeAttribute, setAttribute, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.io.EndPoint

close

Constructor Details

ProxyEndPoint

@Deprecated
public ProxyEndPoint(EndPoint endPoint,
 InetSocketAddress remote,
 InetSocketAddress local)

Deprecated.

ProxyEndPoint

public ProxyEndPoint(EndPoint endPoint,
 SocketAddress local,
 SocketAddress remote)

Method Details

unwrap

public EndPoint unwrap()

Specified by:

unwrap in interface EndPoint.Wrapper

Returns:

The wrapped EndPoint

getTLV

public byte[] getTLV(int type)

Gets a TLV vector, see section 2.2.7 of the PROXY protocol specification.

Parameters:

type - the TLV type

Returns:

the TLV value or null if not present.

close

public void close(Throwable cause)

Description copied from interface: EndPoint

Close any backing stream associated with the endpoint, passing a cause

Specified by:

close in interface EndPoint

Parameters:

cause - the reason for the close or null

fill

public int fill(ByteBuffer buffer)
         throws IOException

Description copied from interface: EndPoint

Fill the passed buffer with data from this endpoint. The bytes are appended to any data already in the buffer by writing from the buffers limit up to it's capacity. The limit is updated to include the filled bytes.

Specified by:

fill in interface EndPoint

Parameters:

buffer - The buffer to fill. The position and limit are modified during the fill. After the operation, the position is unchanged and the limit is increased to reflect the new data filled.

Returns:

an int value indicating the number of bytes filled or -1 if EOF is read or the input is shutdown.

Throws:

IOException - if the endpoint is closed.

fillInterested

public void fillInterested(Callback callback)
                    throws ReadPendingException

Description copied from interface: EndPoint

Requests callback methods to be invoked when a call to EndPoint.fill(ByteBuffer) would return data or EOF.

Specified by:

fillInterested in interface EndPoint

Parameters:

callback - the callback to call when an error occurs or we are readable. The callback may implement the Invocable interface to self declare its blocking status. Non-blocking callbacks may be called more efficiently without dispatch delays.

Throws:

ReadPendingException - if another read operation is concurrent.

flush

public boolean flush(ByteBuffer... buffer)
              throws IOException

Description copied from interface: EndPoint

Flush data from the passed header/buffer to this endpoint. As many bytes as can be consumed are taken from the header/buffer position up until the buffer limit. The header/buffers position is updated to indicate how many bytes have been consumed.

Specified by:

flush in interface EndPoint

Parameters:

buffer - the buffers to flush

Returns:

True IFF all the buffers have been consumed and the endpoint has flushed the data to its destination (ie is not buffering any data).

Throws:

IOException - If the endpoint is closed or output is shutdown.

getConnection

public Connection getConnection()

Specified by:

getConnection in interface EndPoint

Returns:

the Connection associated with this EndPoint

See Also:

• EndPoint.setConnection(Connection)

setConnection

public void setConnection(Connection connection)

Specified by:

setConnection in interface EndPoint

Parameters:

connection - the Connection associated with this EndPoint

See Also:

• EndPoint.getConnection()
• EndPoint.upgrade(Connection)

getCreatedTimeStamp

public long getCreatedTimeStamp()

Specified by:

getCreatedTimeStamp in interface EndPoint

Returns:

the epoch time in milliseconds when this EndPoint was created

getIdleTimeout

public long getIdleTimeout()

Description copied from interface: EndPoint

Get the max idle time in ms.

The max idle time is the time the endpoint can be idle before extraordinary handling takes place.

Specified by:

getIdleTimeout in interface EndPoint

Returns:

the max idle time in ms or if ms <= 0 implies an infinite timeout

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

Description copied from interface: EndPoint

Set the idle timeout.

Specified by:

setIdleTimeout in interface EndPoint

Parameters:

idleTimeout - the idle timeout in MS. Timeout <= 0 implies an infinite timeout

getLocalAddress

public InetSocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface EndPoint

Returns:

The local InetSocketAddress to which this EndPoint is bound, or null if this EndPoint is not bound to a Socket address.

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Specified by:

getLocalSocketAddress in interface EndPoint

Returns:

the local SocketAddress to which this EndPoint is bound or null if this EndPoint is not bound to a Socket address.

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface EndPoint

Returns:

The remote InetSocketAddress to which this EndPoint is connected, or null if this EndPoint is not connected to a Socket address.

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Specified by:

getRemoteSocketAddress in interface EndPoint

Returns:

The remote SocketAddress to which this EndPoint is connected, or null if this EndPoint is not connected to a Socket address.

getTransport

public Object getTransport()

Specified by:

getTransport in interface EndPoint

Returns:

The underlying transport object (socket, channel, etc.)

isFillInterested

public boolean isFillInterested()

Specified by:

isFillInterested in interface EndPoint

Returns:

whether EndPoint.fillInterested(Callback) has been called, but EndPoint.fill(ByteBuffer) has not yet been called

isInputShutdown

public boolean isInputShutdown()

Description copied from interface: EndPoint

Test if the input is shutdown. The input is shutdown if an EOF has been read while doing a EndPoint.fill(ByteBuffer). Once the input is shutdown, all calls to EndPoint.fill(ByteBuffer) will return -1, until such time as the end point is close, when they will return EofException.

Specified by:

isInputShutdown in interface EndPoint

Returns:

True if the input is shutdown or the endpoint is closed.

isOpen

public boolean isOpen()

Specified by:

isOpen in interface EndPoint

Returns:

whether this EndPoint is open

isOutputShutdown

public boolean isOutputShutdown()

Description copied from interface: EndPoint

Test if output is shutdown. The output is shutdown by a call to EndPoint.shutdownOutput() or EndPoint.close().

Specified by:

isOutputShutdown in interface EndPoint

Returns:

true if the output is shutdown or the endpoint is closed.

onClose

public void onClose(Throwable cause)

Description copied from interface: EndPoint

Callback method invoked when this EndPoint is closed.

Specified by:

onClose in interface EndPoint

Parameters:

cause - The reason for the close, or null if a normal close.

See Also:

• EndPoint.onOpen()

onOpen

public void onOpen()

Description copied from interface: EndPoint

Callback method invoked when this EndPoint is opened.

Specified by:

onOpen in interface EndPoint

See Also:

• EndPoint.onClose(Throwable)

shutdownOutput

public void shutdownOutput()

Description copied from interface: EndPoint

Shutdown the output.

This call indicates that no more data will be sent on this endpoint that that the remote end should read an EOF once all previously sent data has been consumed. Shutdown may be done either at the TCP/IP level, as a protocol exchange (Eg TLS close handshake) or both.

If the endpoint has EndPoint.isInputShutdown() true, then this call has the same effect as EndPoint.close().

Specified by:

shutdownOutput in interface EndPoint

toString

public String toString()

Overrides:

toString in class AttributesMap

tryFillInterested

public boolean tryFillInterested(Callback callback)

Description copied from interface: EndPoint

Requests callback methods to be invoked when a call to EndPoint.fill(ByteBuffer) would return data or EOF.

Specified by:

tryFillInterested in interface EndPoint

Parameters:

callback - the callback to call when an error occurs or we are readable. The callback may implement the Invocable interface to self declare its blocking status. Non-blocking callbacks may be called more efficiently without dispatch delays.

Returns:

true if set

upgrade

public void upgrade(Connection newConnection)

Description copied from interface: EndPoint

Upgrades this EndPoint from the current connection to the given new connection.

Closes the current connection, links this EndPoint to the new connection and then opens the new connection.

If the current connection is an instance of Connection.UpgradeFrom then a buffer of unconsumed bytes is requested. If the buffer of unconsumed bytes is non-null and non-empty, then the new connection is tested: if it is an instance of Connection.UpgradeTo, then the unconsumed buffer is passed to the new connection; otherwise, an exception is thrown since there are unconsumed bytes that cannot be consumed by the new connection.

Specified by:

upgrade in interface EndPoint

Parameters:

newConnection - the connection to upgrade to

write

public void write(Callback callback,
 ByteBuffer... buffers)
           throws WritePendingException

Description copied from interface: EndPoint

Writes the given buffers via EndPoint.flush(ByteBuffer...) and invokes callback methods when either all the data has been flushed or an error occurs.

Specified by:

write in interface EndPoint

Parameters:

callback - the callback to call when an error occurs or the write completed. The callback may implement the Invocable interface to self declare its blocking status. Non-blocking callbacks may be called more efficiently without dispatch delays.

buffers - one or more ByteBuffers that will be flushed.

Throws:

WritePendingException - if another write operation is concurrent.