DefaultHttpProxyManager (Zodiac Server Proxy 1.3.12 API)

java.lang.Object
- org.zodiac.server.proxy.impl.DefaultHttpProxyManager

所有已实现的接口:

HttpProxyManager, ProxyManager
```
public class DefaultHttpProxyManager
extends Object
implements HttpProxyManager
```
Primary implementation of an HttpProxyManager.

DefaultHttpProxyManager is bootstrapped by calling bootstrap() or bootstrapFromFile(String), and then calling DefaultHttpProxyManager.DefaultHttpProxyManagerBootstrap.start(). For example:
```
 DefaultHttpProxyServer server = DefaultHttpProxyServer.bootstrap().withPort(8090).start();
 
```

嵌套类概要

嵌套类
限定符和类型类和说明

private static class DefaultHttpProxyManager.DefaultHttpProxyManagerBootstrap

嵌套类
限定符和类型	类和说明
`private static class`	`DefaultHttpProxyManager.DefaultHttpProxyManagerBootstrap`

字段概要

字段
限定符和类型	字段和说明
`private Collection<ActivityTracker>`	`activityTrackers`
`private io.netty.channel.group.ChannelGroup`	`allChannels`
`private boolean`	`allowDuplicateContentLengths`
`private String`	`applicationName`
`private InetSocketAddress`	`boundAddress`
`private int`	`connectTimeout`
`private boolean`	`enableThrottle`
`private int`	`eventThreadPoolGracefulShutdownAwaitSeconds`
`private long`	`eventThreadPoolGracefulShutdownQuietPeriodSeconds`
`private long`	`eventThreadPoolGracefulShutdownTimeoutSeconds`
`private static String`	`FALLBACK_PROXY_ALIAS`
`private HttpFiltersSource`	`filtersSource`
`private io.netty.handler.traffic.GlobalTrafficShapingHandler`	`globalTrafficShapingHandler`
`private boolean`	`gracefulShutdown`
`private int`	`gracefulShutdownAwaitSeconds`
`private HttpProxyConfigOptions`	`httpProxyConfigOptions`
`private int`	`idleConnectionTimeout`
`private int`	`initialBufferSize`
`private InetSocketAddress`	`localAddress`
`private static org.slf4j.Logger`	`LOG`
`private int`	`maxChunkSize`
`private int`	`maxHeaderSize`
`private int`	`maxInitialLineLength`
`private String`	`proxyAlias`
`private ProxyConfigOptions`	`proxyConfigOptions`
`private InetSocketAddress`	`requestedAddress`
`private AtomicBoolean`	`runningMutex`
`private ServerGroup`	`serverGroup`
`private HostResolver`	`serverResolver`
`private SslEngineSource`	`sslEngineSource`
`private AtomicBoolean`	`stopped`
`private int`	`tcpBackLog`
`private boolean`	`transparent`
`private TransportProtocol`	`transportProtocol`
`private int`	`udpBackLog`
`private boolean`	`validateHeaders`

构造器概要

构造器
限定符	构造器和说明
`private`	DefaultHttpProxyManager(ProxyConfigOptions proxyConfigOptions, HttpProxyConfigOptions httpProxyConfigOptions, String applicationName, ServerGroup serverGroup, TransportProtocol transportProtocol, InetSocketAddress requestedAddress, SslEngineSource sslEngineSource, HttpFiltersSource filtersSource, boolean transparent, int idleConnectionTimeout, Collection<ActivityTracker> activityTrackers, int connectTimeout, HostResolver serverResolver, long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond, InetSocketAddress localAddress, String proxyAlias, int maxInitialLineLength, int maxHeaderSize, int maxChunkSize) 已过时。
`private`	DefaultHttpProxyManager(ProxyConfigOptions proxyConfigOptions, HttpProxyConfigOptions httpProxyConfigOptions, String applicationName, ServerGroup serverGroup, TransportProtocol transportProtocol, InetSocketAddress requestedAddress, SslEngineSource sslEngineSource, HttpFiltersSource filtersSource, boolean transparent, int tcpBackLog, int udpBackLog, int idleConnectionTimeout, Collection<ActivityTracker> activityTrackers, int connectTimeout, HostResolver serverResolver, boolean enabledThrottle, long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond, long throttleCheckIntervalMills, long maxTrafficDelaySeconds, InetSocketAddress localAddress, String proxyAlias, int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths, boolean gracefulShutdown, int gracefulShutdownAwaitSeconds, long eventThreadPoolGracefulShutdownQuietPeriodSeconds, long eventThreadPoolGracefulShutdownTimeoutSeconds, int eventThreadPoolGracefulShutdownAwaitSeconds)

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`abort()` Stops the server and all related clones immediately, without waiting for traffic to stop.
`static HttpProxyManagerBootstrap`	`bootstrap()` Bootstrap a new `DefaultHttpProxyManager` starting from scratch.
`static HttpProxyManagerBootstrap`	`bootstrapFromFile(String path)` 已过时。
`DefaultHttpProxyManager.DefaultHttpProxyManagerBootstrap`	`clone()` Clone the existing server, with a port 1 higher and everything else the same.
`protected void`	`closeAllChannels(boolean graceful)` Closes all channels opened by this proxy server.
`private io.netty.handler.traffic.GlobalTrafficShapingHandler`	`createGlobalTrafficShapingHandler(TransportProtocol transportProtocol, long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond)` 已过时。 Use `createGlobalTrafficShapingHandler(TransportProtocol, long, long, long, long)` replaced.
`private io.netty.handler.traffic.GlobalTrafficShapingHandler`	`createGlobalTrafficShapingHandler(TransportProtocol transportProtocol, long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond, long throttleCheckIntervalMills, long maxTrafficDelaySeconds)` Creates a new GlobalTrafficShapingHandler for this HttpProxyServer, using this proxy's proxyToServerEventLoop.
`private void`	`doStart()`
`protected void`	`doStop(boolean graceful)` Performs cleanup necessary to stop the server.
`Collection<ActivityTracker>`	`getActivityTrackers()`
`int`	`getConnectTimeout()` Returns the maximum time to wait, in milliseconds, to connect to a server.
`HttpFiltersSource`	`getFiltersSource()`
`int`	`getIdleConnectionTimeout()`
`int`	`getInitialBufferSize()`
`InetSocketAddress`	`getListenAddress()` Return the address on which this proxy is listening.
`InetSocketAddress`	`getLocalAddress()`
`int`	`getMaxChunkSize()`
`int`	`getMaxHeaderSize()`
`int`	`getMaxInitialLineLength()`
`String`	`getProxyAlias()`
`EventLoopGroup`	`getProxyToServerWorkerFor(TransportProtocol transportProtocol)`
`long`	`getReadThrottle()`
`HostResolver`	`getServerResolver()`
`protected SslEngineSource`	`getSslEngineSource()`
`long`	`getWriteThrottle()`
`boolean`	`isAllowDuplicateContentLengths()`
`boolean`	`isTransparent()`
`boolean`	`isValidateHeaders()`
`void`	`registerChannel(Channel channel)` Register a new `Channel` with this server, for later closing.
`void`	`setConnectTimeout(int connectTimeoutMs)` Sets the maximum time to wait, in milliseconds, to connect to a server.
`void`	`setIdleConnectionTimeout(int idleConnectionTimeout)`
`void`	`setThrottle(boolean enableThrottle, long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond, long throttleCheckIntervalMills, long maxTrafficDelaySeconds)` Set the read/write throttle bandwidths (in bytes/second) for this proxy.
`void`	`setThrottle(long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond)` Set the read/write throttle bandwidths (in bytes/second) for this proxy.
`private HttpProxyManager`	`start()`
`void`	`stop()` Stops the server and all related clones.

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

LOG

private static final org.slf4j.Logger LOG

FALLBACK_PROXY_ALIAS

private static final String FALLBACK_PROXY_ALIAS

另请参阅:: 常量字段值

runningMutex

private final AtomicBoolean runningMutex

applicationName
```
private final String applicationName
```

proxyConfigOptions

private final ProxyConfigOptions proxyConfigOptions

httpProxyConfigOptions

private final HttpProxyConfigOptions httpProxyConfigOptions

serverGroup
```
private final ServerGroup serverGroup
```

transportProtocol

private final TransportProtocol transportProtocol

requestedAddress

private final InetSocketAddress requestedAddress

localAddress

private volatile InetSocketAddress localAddress

boundAddress

private volatile InetSocketAddress boundAddress

sslEngineSource

private final SslEngineSource sslEngineSource

filtersSource

private final HttpFiltersSource filtersSource

transparent
```
private final boolean transparent
```

tcpBackLog
```
private final int tcpBackLog
```

udpBackLog
```
private final int udpBackLog
```

connectTimeout
```
private volatile int connectTimeout
```

idleConnectionTimeout

private volatile int idleConnectionTimeout

serverResolver

private final HostResolver serverResolver

enableThrottle

private volatile boolean enableThrottle

globalTrafficShapingHandler

private volatile io.netty.handler.traffic.GlobalTrafficShapingHandler globalTrafficShapingHandler

maxInitialLineLength
```
private final int maxInitialLineLength
```

maxHeaderSize
```
private final int maxHeaderSize
```

maxChunkSize
```
private final int maxChunkSize
```

validateHeaders
```
private final boolean validateHeaders
```

initialBufferSize
```
private final int initialBufferSize
```

allowDuplicateContentLengths

private final boolean allowDuplicateContentLengths

gracefulShutdown
```
private final boolean gracefulShutdown
```

gracefulShutdownAwaitSeconds

private int gracefulShutdownAwaitSeconds

eventThreadPoolGracefulShutdownQuietPeriodSeconds

private long eventThreadPoolGracefulShutdownQuietPeriodSeconds

eventThreadPoolGracefulShutdownTimeoutSeconds

private long eventThreadPoolGracefulShutdownTimeoutSeconds

eventThreadPoolGracefulShutdownAwaitSeconds

private int eventThreadPoolGracefulShutdownAwaitSeconds

proxyAlias
```
private final String proxyAlias
```

stopped
```
private final AtomicBoolean stopped
```

activityTrackers

private final Collection<ActivityTracker> activityTrackers

allChannels

private final io.netty.channel.group.ChannelGroup allChannels

构造器详细资料

DefaultHttpProxyManager

@Deprecated
private DefaultHttpProxyManager(ProxyConfigOptions proxyConfigOptions,
                                             HttpProxyConfigOptions httpProxyConfigOptions,
                                             String applicationName,
                                             ServerGroup serverGroup,
                                             TransportProtocol transportProtocol,
                                             InetSocketAddress requestedAddress,
                                             SslEngineSource sslEngineSource,
                                             HttpFiltersSource filtersSource,
                                             boolean transparent,
                                             int idleConnectionTimeout,
                                             Collection<ActivityTracker> activityTrackers,
                                             int connectTimeout,
                                             HostResolver serverResolver,
                                             long readThrottleBytesPerSecond,
                                             long writeThrottleBytesPerSecond,
                                             InetSocketAddress localAddress,
                                             String proxyAlias,
                                             int maxInitialLineLength,
                                             int maxHeaderSize,
                                             int maxChunkSize)

已过时。

DefaultHttpProxyManager

private DefaultHttpProxyManager(ProxyConfigOptions proxyConfigOptions,
                                HttpProxyConfigOptions httpProxyConfigOptions,
                                String applicationName,
                                ServerGroup serverGroup,
                                TransportProtocol transportProtocol,
                                InetSocketAddress requestedAddress,
                                SslEngineSource sslEngineSource,
                                HttpFiltersSource filtersSource,
                                boolean transparent,
                                int tcpBackLog,
                                int udpBackLog,
                                int idleConnectionTimeout,
                                Collection<ActivityTracker> activityTrackers,
                                int connectTimeout,
                                HostResolver serverResolver,
                                boolean enabledThrottle,
                                long readThrottleBytesPerSecond,
                                long writeThrottleBytesPerSecond,
                                long throttleCheckIntervalMills,
                                long maxTrafficDelaySeconds,
                                InetSocketAddress localAddress,
                                String proxyAlias,
                                int maxInitialLineLength,
                                int maxHeaderSize,
                                int maxChunkSize,
                                boolean validateHeaders,
                                int initialBufferSize,
                                boolean allowDuplicateContentLengths,
                                boolean gracefulShutdown,
                                int gracefulShutdownAwaitSeconds,
                                long eventThreadPoolGracefulShutdownQuietPeriodSeconds,
                                long eventThreadPoolGracefulShutdownTimeoutSeconds,
                                int eventThreadPoolGracefulShutdownAwaitSeconds)

方法详细资料
- bootstrap
```
public static HttpProxyManagerBootstrap bootstrap()
```
  Bootstrap a new DefaultHttpProxyManager starting from scratch.
  
  返回:
  
  HttpProxyManagerBootstrap
- bootstrapFromFile
```
@Deprecated
public static HttpProxyManagerBootstrap bootstrapFromFile(String path)
```
  已过时。
- createGlobalTrafficShapingHandler
```
@Deprecated
private io.netty.handler.traffic.GlobalTrafficShapingHandler createGlobalTrafficShapingHandler(TransportProtocol transportProtocol,
                                                                                                            long readThrottleBytesPerSecond,
                                                                                                            long writeThrottleBytesPerSecond)
```
  已过时。 Use createGlobalTrafficShapingHandler(TransportProtocol, long, long, long, long) replaced.
  
  Creates a new GlobalTrafficShapingHandler for this HttpProxyServer, using this proxy's proxyToServerEventLoop.
  
  参数:
  
  transportProtocol - transport protocol
  
  readThrottleBytesPerSecond - read BPS
  
  writeThrottleBytesPerSecond - write BPS
  
  返回:
  
  GlobalTrafficShapingHandler
- createGlobalTrafficShapingHandler
```
private io.netty.handler.traffic.GlobalTrafficShapingHandler createGlobalTrafficShapingHandler(TransportProtocol transportProtocol,
                                                                                               long readThrottleBytesPerSecond,
                                                                                               long writeThrottleBytesPerSecond,
                                                                                               long throttleCheckIntervalMills,
                                                                                               long maxTrafficDelaySeconds)
```
  Creates a new GlobalTrafficShapingHandler for this HttpProxyServer, using this proxy's proxyToServerEventLoop.
  
  参数:
  
  transportProtocol - transport protocol
  
  readThrottleBytesPerSecond - read BPS
  
  writeThrottleBytesPerSecond - write BPS
  
  throttleCheckIntervalMills - check interval in milliseconds
  
  maxTrafficDelaySeconds - throttle delay in seconds
  
  返回:
  
  GlobalTrafficShapingHandler
- isTransparent
```
public boolean isTransparent()
```
  指定者:
  
  isTransparent 在接口中 ProxyManager
- getIdleConnectionTimeout
```
public int getIdleConnectionTimeout()
```
  指定者:
  
  getIdleConnectionTimeout 在接口中 ProxyManager
- setIdleConnectionTimeout
```
public void setIdleConnectionTimeout(int idleConnectionTimeout)
```
  指定者:
  
  setIdleConnectionTimeout 在接口中 ProxyManager
- getConnectTimeout
```
public int getConnectTimeout()
```
  从接口复制的说明: ProxyManager
  
  Returns the maximum time to wait, in milliseconds, to connect to a server.
  
  指定者:
  
  getConnectTimeout 在接口中 ProxyManager
  
  返回:
  
  timeout
- setConnectTimeout
```
public void setConnectTimeout(int connectTimeoutMs)
```
  从接口复制的说明: ProxyManager
  
  Sets the maximum time to wait, in milliseconds, to connect to a server.
  
  指定者:
  
  setConnectTimeout 在接口中 ProxyManager
  
  参数:
  
  connectTimeoutMs - connection timeout in milliseconds
- getServerResolver
```
public HostResolver getServerResolver()
```
  指定者:
  
  getServerResolver 在接口中 ProxyManager
- getLocalAddress
```
public InetSocketAddress getLocalAddress()
```
  指定者:
  
  getLocalAddress 在接口中 ProxyManager
- getListenAddress
```
public InetSocketAddress getListenAddress()
```
  从接口复制的说明: ProxyManager
  
  Return the address on which this proxy is listening.
  
  指定者:
  
  getListenAddress 在接口中 ProxyManager
  
  返回:
  
  address
- setThrottle
```
public void setThrottle(long readThrottleBytesPerSecond,
                        long writeThrottleBytesPerSecond)
```
  从接口复制的说明: ProxyManager
  
  Set the read/write throttle bandwidths (in bytes/second) for this proxy.
  
  指定者:
  
  setThrottle 在接口中 ProxyManager
  
  参数:
  
  readThrottleBytesPerSecond - read BPS
  
  writeThrottleBytesPerSecond - write BPS
- setThrottle
```
public void setThrottle(boolean enableThrottle,
                        long readThrottleBytesPerSecond,
                        long writeThrottleBytesPerSecond,
                        long throttleCheckIntervalMills,
                        long maxTrafficDelaySeconds)
```
  从接口复制的说明: ProxyManager
  
  Set the read/write throttle bandwidths (in bytes/second) for this proxy.
  
  指定者:
  
  setThrottle 在接口中 ProxyManager
  
  参数:
  
  enableThrottle - enables throttle
  
  readThrottleBytesPerSecond - read BPS
  
  writeThrottleBytesPerSecond - write BPS
  
  throttleCheckIntervalMills - check interval in milliseconds
  
  maxTrafficDelaySeconds - throttle delay in seconds
- getReadThrottle
```
public long getReadThrottle()
```
- getWriteThrottle
```
public long getWriteThrottle()
```
- getMaxInitialLineLength
```
public int getMaxInitialLineLength()
```
  指定者:
  
  getMaxInitialLineLength 在接口中 HttpProxyManager
- getMaxHeaderSize
```
public int getMaxHeaderSize()
```
  指定者:
  
  getMaxHeaderSize 在接口中 HttpProxyManager
- getMaxChunkSize
```
public int getMaxChunkSize()
```
  指定者:
  
  getMaxChunkSize 在接口中 HttpProxyManager
- isValidateHeaders
```
public boolean isValidateHeaders()
```
  指定者:
  
  isValidateHeaders 在接口中 HttpProxyManager
- getInitialBufferSize
```
public int getInitialBufferSize()
```
  指定者:
  
  getInitialBufferSize 在接口中 HttpProxyManager
- isAllowDuplicateContentLengths
```
public boolean isAllowDuplicateContentLengths()
```
  指定者:
  
  isAllowDuplicateContentLengths 在接口中 HttpProxyManager
- clone
```
public DefaultHttpProxyManager.DefaultHttpProxyManagerBootstrap clone()
```
  从接口复制的说明: HttpProxyManager
  
  Clone the existing server, with a port 1 higher and everything else the same. If the proxy was started with port 0 (JVM-assigned port), the cloned proxy will also use a JVM-assigned port.
  
  The new server will share event loops with the original server. The event loops will use whatever name was given to the first server in the clone group. The server group will not terminate until the original server and all clones terminate.
  
  指定者:
  
  clone 在接口中 HttpProxyManager
  
  覆盖:
  
  clone 在类中 Object
  
  返回:
  
  a bootstrap that allows customizing and starting the cloned server
- stop
```
public void stop()
```
  从接口复制的说明: ProxyManager
  
  Stops the server and all related clones. Waits for traffic to stop before shutting down.
  
  指定者:
  
  stop 在接口中 ProxyManager
- abort
```
public void abort()
```
  从接口复制的说明: ProxyManager
  
  Stops the server and all related clones immediately, without waiting for traffic to stop.
  
  指定者:
  
  abort 在接口中 ProxyManager
- doStop
```
protected void doStop(boolean graceful)
```
  Performs cleanup necessary to stop the server. Closes all channels opened by the server and unregisters this server from the server group.
  
  参数:
  
  graceful - when true, waits for requests to terminate before stopping the server
- registerChannel
```
public void registerChannel(Channel channel)
```
  Register a new Channel with this server, for later closing.
  
  指定者:
  
  registerChannel 在接口中 ProxyManager
  
  参数:
  
  channel - channel
- closeAllChannels
```
protected void closeAllChannels(boolean graceful)
```
  Closes all channels opened by this proxy server.
  
  参数:
  
  graceful - when false, attempts to shutdown all channels immediately and ignores any channel-closing exceptions
- start
```
private HttpProxyManager start()
```
- doStart
```
private void doStart()
```
- getSslEngineSource
```
protected SslEngineSource getSslEngineSource()
```
- getFiltersSource
```
public HttpFiltersSource getFiltersSource()
```
  指定者:
  
  getFiltersSource 在接口中 HttpProxyManager
- getActivityTrackers
```
public Collection<ActivityTracker> getActivityTrackers()
```
  指定者:
  
  getActivityTrackers 在接口中 ProxyManager
- getProxyAlias
```
public String getProxyAlias()
```
  指定者:
  
  getProxyAlias 在接口中 ProxyManager
- getProxyToServerWorkerFor
```
public EventLoopGroup getProxyToServerWorkerFor(TransportProtocol transportProtocol)
```
  指定者:
  
  getProxyToServerWorkerFor 在接口中 ProxyManager

类 DefaultHttpProxyManager

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

LOG

FALLBACK_PROXY_ALIAS

runningMutex

applicationName

proxyConfigOptions

httpProxyConfigOptions

serverGroup

transportProtocol

requestedAddress

localAddress

boundAddress

sslEngineSource

filtersSource

transparent

tcpBackLog

udpBackLog

connectTimeout

idleConnectionTimeout

serverResolver

enableThrottle

globalTrafficShapingHandler

maxInitialLineLength

maxHeaderSize

maxChunkSize

validateHeaders

initialBufferSize

allowDuplicateContentLengths

gracefulShutdown

gracefulShutdownAwaitSeconds

eventThreadPoolGracefulShutdownQuietPeriodSeconds

eventThreadPoolGracefulShutdownTimeoutSeconds

eventThreadPoolGracefulShutdownAwaitSeconds

proxyAlias

stopped

activityTrackers

allChannels

构造器详细资料

DefaultHttpProxyManager

DefaultHttpProxyManager

方法详细资料

bootstrap

bootstrapFromFile

createGlobalTrafficShapingHandler

createGlobalTrafficShapingHandler

isTransparent

getIdleConnectionTimeout

setIdleConnectionTimeout

getConnectTimeout

setConnectTimeout

getServerResolver

getLocalAddress

getListenAddress

setThrottle

setThrottle

getReadThrottle

getWriteThrottle

getMaxInitialLineLength

getMaxHeaderSize

getMaxChunkSize

isValidateHeaders

getInitialBufferSize

isAllowDuplicateContentLengths

clone

stop

abort

doStop

registerChannel

closeAllChannels

start

doStart

getSslEngineSource

getFiltersSource

getActivityTrackers