org.eclipse.jetty.proxy

Class ConnectHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.proxy.ConnectHandler

All Implemented Interfaces:

Handler, HandlerContainer, Container, Destroyable, Dumpable, LifeCycle

public class ConnectHandler
extends HandlerWrapper

Implementation of a Handler that supports HTTP CONNECT.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ConnectHandler.ConnectContext
protected class	ConnectHandler.ConnectManager
class	ConnectHandler.DownstreamConnection
class	ConnectHandler.UpstreamConnection

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

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

LifeCycle.Listener

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

Container.InheritedListener, Container.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

_handler

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
ConnectHandler()
ConnectHandler(Handler handler)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	connectToServer(HttpServletRequest request, String host, int port, Promise<SocketChannel> promise)
protected void	doStart() Starts the managed lifecycle beans in the order they were added.
void	dump(Appendable out, String indent)
Set<String>	getBlackListHosts()
int	getBufferSize()
ByteBufferPool	getByteBufferPool()
long	getConnectTimeout()
Executor	getExecutor()
long	getIdleTimeout()
Scheduler	getScheduler()
Set<String>	getWhiteListHosts()
void	handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) Handle a request.
protected boolean	handleAuthentication(HttpServletRequest request, HttpServletResponse response, String address) Handles the authentication before setting up the tunnel to the remote server.
protected void	handleConnect(Request baseRequest, HttpServletRequest request, HttpServletResponse response, String serverAddress) Handles a CONNECT request.
protected InetSocketAddress	newConnectAddress(String host, int port) Creates the server address to connect to.
protected ConnectHandler.DownstreamConnection	newDownstreamConnection(EndPoint endPoint, ConcurrentMap<String,Object> context)
protected ConnectHandler.DownstreamConnection	newDownstreamConnection(EndPoint endPoint, ConcurrentMap<String,Object> context, ByteBuffer buffer) Deprecated. use newDownstreamConnection(EndPoint, ConcurrentMap) instead
protected SelectorManager	newSelectorManager()
protected ConnectHandler.UpstreamConnection	newUpstreamConnection(EndPoint endPoint, ConnectHandler.ConnectContext connectContext)
protected void	onConnectFailure(HttpServletRequest request, HttpServletResponse response, AsyncContext asyncContext, Throwable failure)
protected void	onConnectSuccess(ConnectHandler.ConnectContext connectContext, ConnectHandler.UpstreamConnection upstreamConnection)
protected void	prepareContext(HttpServletRequest request, ConcurrentMap<String,Object> context)
protected int	read(EndPoint endPoint, ByteBuffer buffer) Deprecated. override read(EndPoint, ByteBuffer, ConcurrentMap) instead
protected int	read(EndPoint endPoint, ByteBuffer buffer, ConcurrentMap<String,Object> context) Reads (with non-blocking semantic) into the given buffer from the given endPoint.
void	setBufferSize(int bufferSize)
void	setByteBufferPool(ByteBufferPool bufferPool)
void	setConnectTimeout(long connectTimeout)
void	setExecutor(Executor executor)
void	setIdleTimeout(long idleTimeout)
void	setScheduler(Scheduler scheduler)
boolean	validateDestination(String host, int port) Checks the given host and port against whitelist and blacklist.
protected void	write(EndPoint endPoint, ByteBuffer buffer, Callback callback) Deprecated. override write(EndPoint, ByteBuffer, Callback, ConcurrentMap) instead
protected void	write(EndPoint endPoint, ByteBuffer buffer, Callback callback, ConcurrentMap<String,Object> context) Writes (with non-blocking semantic) the given buffer of data onto the given endPoint.

Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

destroy, expandChildren, getHandler, getHandlers, setHandler, setServer

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

doStop, dumpThis, getServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

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

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

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

ConnectHandler

public ConnectHandler()

ConnectHandler

public ConnectHandler(Handler handler)

Method Detail

getExecutor

public Executor getExecutor()

setExecutor

public void setExecutor(Executor executor)

getScheduler

public Scheduler getScheduler()

setScheduler

public void setScheduler(Scheduler scheduler)

getByteBufferPool

public ByteBufferPool getByteBufferPool()

setByteBufferPool

public void setByteBufferPool(ByteBufferPool bufferPool)

getConnectTimeout

public long getConnectTimeout()

Returns:

the timeout, in milliseconds, to connect to the remote server

setConnectTimeout

public void setConnectTimeout(long connectTimeout)

Parameters:

connectTimeout - the timeout, in milliseconds, to connect to the remote server

getIdleTimeout

public long getIdleTimeout()

Returns:

the idle timeout, in milliseconds

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

Parameters:

idleTimeout - the idle timeout, in milliseconds

getBufferSize

public int getBufferSize()

setBufferSize

public void setBufferSize(int bufferSize)

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class AbstractHandler

Throws:

Exception

newSelectorManager

protected SelectorManager newSelectorManager()

handle

public void handle(String target,
          Request baseRequest,
          HttpServletRequest request,
          HttpServletResponse response)
            throws ServletException,
                   IOException

Description copied from interface: Handler

Handle a request.

Specified by:

handle in interface Handler

Overrides:

handle in class HandlerWrapper

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request. The HttpChannel.getCurrentHttpChannel() method can be used access the Request object if required.

response - The response as the Response object or a wrapper of that request. The HttpChannel.getCurrentHttpChannel() method can be used access the Response object if required.

Throws:

ServletException

IOException

handleConnect

protected void handleConnect(Request baseRequest,
                 HttpServletRequest request,
                 HttpServletResponse response,
                 String serverAddress)

Handles a CONNECT request.

CONNECT requests may have authentication headers such as Proxy-Authorization that authenticate the client with the proxy.

Parameters:

baseRequest - Jetty-specific http request

request - the http request

response - the http response

serverAddress - the remote server address in the form host:port

connectToServer

protected void connectToServer(HttpServletRequest request,
                   String host,
                   int port,
                   Promise<SocketChannel> promise)

newConnectAddress

protected InetSocketAddress newConnectAddress(String host,
                                  int port)

Creates the server address to connect to.

Parameters:

host - The host from the CONNECT request

port - The port from the CONNECT request

Returns:

The InetSocketAddress to connect to.

onConnectSuccess

protected void onConnectSuccess(ConnectHandler.ConnectContext connectContext,
                    ConnectHandler.UpstreamConnection upstreamConnection)

onConnectFailure

protected void onConnectFailure(HttpServletRequest request,
                    HttpServletResponse response,
                    AsyncContext asyncContext,
                    Throwable failure)

handleAuthentication

protected boolean handleAuthentication(HttpServletRequest request,
                           HttpServletResponse response,
                           String address)

Handles the authentication before setting up the tunnel to the remote server.

The default implementation returns true.

Parameters:

request - the HTTP request

response - the HTTP response

address - the address of the remote server in the form host:port.

Returns:

true to allow to connect to the remote host, false otherwise

newDownstreamConnection

@Deprecated
protected ConnectHandler.DownstreamConnection newDownstreamConnection(EndPoint endPoint,
                                                                     ConcurrentMap<String,Object> context,
                                                                     ByteBuffer buffer)

Deprecated. use newDownstreamConnection(EndPoint, ConcurrentMap) instead

newDownstreamConnection

protected ConnectHandler.DownstreamConnection newDownstreamConnection(EndPoint endPoint,
                                                          ConcurrentMap<String,Object> context)

newUpstreamConnection

protected ConnectHandler.UpstreamConnection newUpstreamConnection(EndPoint endPoint,
                                                      ConnectHandler.ConnectContext connectContext)

prepareContext

protected void prepareContext(HttpServletRequest request,
                  ConcurrentMap<String,Object> context)

read

protected int read(EndPoint endPoint,
       ByteBuffer buffer,
       ConcurrentMap<String,Object> context)
            throws IOException

Reads (with non-blocking semantic) into the given buffer from the given endPoint.

Parameters:

endPoint - the endPoint to read from

buffer - the buffer to read data into

context - the context information related to the connection

Returns:

the number of bytes read (possibly 0 since the read is non-blocking) or -1 if the channel has been closed remotely

Throws:

IOException - if the endPoint cannot be read

read

@Deprecated
protected int read(EndPoint endPoint,
                  ByteBuffer buffer)
            throws IOException

Deprecated. override read(EndPoint, ByteBuffer, ConcurrentMap) instead

Throws:

IOException

write

protected void write(EndPoint endPoint,
         ByteBuffer buffer,
         Callback callback,
         ConcurrentMap<String,Object> context)

Writes (with non-blocking semantic) the given buffer of data onto the given endPoint.

Parameters:

endPoint - the endPoint to write to

buffer - the buffer to write

callback - the completion callback to invoke

write

@Deprecated
protected void write(EndPoint endPoint,
                    ByteBuffer buffer,
                    Callback callback)

Deprecated. override write(EndPoint, ByteBuffer, Callback, ConcurrentMap) instead

getWhiteListHosts

public Set<String> getWhiteListHosts()

getBlackListHosts

public Set<String> getBlackListHosts()

validateDestination

public boolean validateDestination(String host,
                          int port)

Checks the given host and port against whitelist and blacklist.

Parameters:

host - the host to check

port - the port to check

Returns:

true if it is allowed to connect to the given host and port

dump

public void dump(Appendable out,
        String indent)
          throws IOException

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Throws:

IOException