Package org.littleshoot.proxy.impl

Class ConnectionFlowStep

java.lang.Object

org.littleshoot.proxy.impl.ConnectionFlowStep

abstract class ConnectionFlowStep
extends Object

Represents a phase in a ConnectionFlow.

Field Summary

Fields

Modifier and Type	Field	Description
private final ProxyConnection	connection
private final ProxyConnectionLogger	LOG
private final ConnectionState	state

Constructor Summary

Constructors

Constructor	Description
ConnectionFlowStep(ProxyConnection connection, ConnectionState state)	Construct a new step in a connection flow.

Method Summary

Modifier and Type	Method	Description
protected abstract Future	execute()	Implement this method to actually do the work involved in this step of the flow.
(package private) ProxyConnection	getConnection()
(package private) ConnectionState	getState()
(package private) void	onSuccess(ConnectionFlow flow)	When the flow determines that this step was successful, it calls into this method.
(package private) void	read(ConnectionFlow flow, Object msg)	Any messages that are read from the underlying connection while we're at this step of the connection flow are passed to this method.
(package private) boolean	shouldExecuteOnEventLoop()	Indicates whether or not this step should be executed on the channel's event loop.
(package private) boolean	shouldSuppressInitialRequest()	Indicates whether or not to suppress the initial request.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

LOG

private final ProxyConnectionLogger LOG

connection

private final ProxyConnection connection

state

private final ConnectionState state

Constructor Details

ConnectionFlowStep

ConnectionFlowStep(ProxyConnection connection,
 ConnectionState state)

Construct a new step in a connection flow.

Parameters:

connection - the connection that we're working on

state - the state that the connection will show while we're processing this step

Method Details

getConnection

ProxyConnection getConnection()

getState

ConnectionState getState()

shouldSuppressInitialRequest

boolean shouldSuppressInitialRequest()

Indicates whether or not to suppress the initial request. Defaults to false, can be overridden.

shouldExecuteOnEventLoop

boolean shouldExecuteOnEventLoop()

Indicates whether or not this step should be executed on the channel's event loop. Defaults to true, can be overridden.

If this step modifies the pipeline, for example by adding/removing handlers, it's best to make it execute on the event loop.

execute

protected abstract Future execute()

Implement this method to actually do the work involved in this step of the flow.

onSuccess

void onSuccess(ConnectionFlow flow)

When the flow determines that this step was successful, it calls into this method. The default implementation simply continues with the flow. Other implementations may choose to not continue and instead wait for a message or something like that.

read

void read(ConnectionFlow flow,
 Object msg)

Any messages that are read from the underlying connection while we're at this step of the connection flow are passed to this method.

The default implementation ignores the message and logs this, since we weren't really expecting a message here.

Some ConnectionFlowSteps do need to read the messages, so they override this method as appropriate.

Parameters:

flow - our ConnectionFlow

msg - the message read from the underlying connection

toString

public String toString()

Overrides:

toString in class Object