HttpTunnelingSocketChannelConfig (The Netty Project API Reference (3.2.6.Final))

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.netty.channel.socket.http
Class HttpTunnelingSocketChannelConfig

java.lang.Object
  org.jboss.netty.channel.socket.http.HttpTunnelingSocketChannelConfig

All Implemented Interfaces:: ChannelConfig, SocketChannelConfig

public final class HttpTunnelingSocketChannelConfig
extends Object
implements SocketChannelConfig
extends Object
implements SocketChannelConfig

The ChannelConfig of a client-side HTTP tunneling SocketChannel. A SocketChannel created by HttpTunnelingClientSocketChannelFactory will return an instance of this configuration type for SocketChannel.getConfig().

Available options

In addition to the options provided by SocketChannelConfig, HttpTunnelingSocketChannelConfig allows the following options in the option map:

Name	Associated setter method
`"sslContext"`	`setSslContext(SSLContext)`
`"enabledSslCiperSuites"`	`setEnabledSslCipherSuites(String[])`
`"enabledSslProtocols"`	`setEnabledSslProtocols(String[])`
`"enableSslSessionCreation"`	`setEnableSslSessionCreation(boolean)`

Version:: $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
Author:: The Netty Project, Andy Taylor (andy.taylor@jboss.org), Trustin Lee

Method Summary
`ChannelBufferFactory`	`getBufferFactory()` Returns the default `ChannelBufferFactory` used to create a new `ChannelBuffer`.
`int`	`getConnectTimeoutMillis()` Returns the connect timeout of the channel in milliseconds.
`String[]`	`getEnabledSslCipherSuites()` Returns the cipher suites enabled for use on an `SSLEngine`.
`String[]`	`getEnabledSslProtocols()` Returns the protocol versions enabled for use on an `SSLEngine`.
`ChannelPipelineFactory`	`getPipelineFactory()` Returns the `ChannelPipelineFactory` which will be used when a child channel is created.
`int`	`getReceiveBufferSize()` Gets the `SO_RCVBUF` option.
`int`	`getSendBufferSize()` Gets the `SO_SNDBUF` option.
`String`	`getServerName()` Returns the host name of the HTTP server.
`String`	`getServerPath()` Returns the path where the `HttpTunnelingServlet` is mapped to.
`int`	`getSoLinger()` Gets the `SO_LINGER` option.
`SSLContext`	`getSslContext()` Returns the `SSLContext` which is used to establish an HTTPS connection.
`int`	`getTrafficClass()` Gets the traffic class.
`boolean`	`isEnableSslSessionCreation()` Returns `true` if new `SSLSession`s may be established by an `SSLEngine`.
`boolean`	`isKeepAlive()` Gets the `SO_KEEPALIVE` option.
`boolean`	`isReuseAddress()` Gets the `SO_REUSEADDR` option.
`boolean`	`isTcpNoDelay()` Gets the `SO_TCPNODELAY` option.
`void`	`setBufferFactory(ChannelBufferFactory bufferFactory)` Sets the default `ChannelBufferFactory` used to create a new `ChannelBuffer`.
`void`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`void`	`setEnabledSslCipherSuites(String[] suites)` Sets the cipher suites enabled for use on an `SSLEngine`.
`void`	`setEnabledSslProtocols(String[] protocols)` Sets the protocol versions enabled for use on an `SSLEngine`.
`void`	`setEnableSslSessionCreation(boolean flag)` Sets whether new `SSLSession`s may be established by an `SSLEngine`.
`void`	`setKeepAlive(boolean keepAlive)` Sets the `SO_KEEPALIVE` option.
`boolean`	`setOption(String key, Object value)` Sets a configuration property with the specified name and value.
`void`	`setOptions(Map<String,Object> options)` Sets the configuration properties from the specified `Map`.
`void`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` Sets the performance preferences as specified in `Socket.setPerformancePreferences(int, int, int)`.
`void`	`setPipelineFactory(ChannelPipelineFactory pipelineFactory)` Sets the `ChannelPipelineFactory` which will be used when a child channel is created.
`void`	`setReceiveBufferSize(int receiveBufferSize)` Gets the `SO_RCVBUF` option.
`void`	`setReuseAddress(boolean reuseAddress)` Sets the `SO_REUSEADDR` option.
`void`	`setSendBufferSize(int sendBufferSize)` Sets the `SO_SNDBUF` option.
`void`	`setServerName(String serverName)` Sets the host name of the HTTP server.
`void`	`setServerPath(String serverPath)` Sets the path where the `HttpTunnelingServlet` is mapped to.
`void`	`setSoLinger(int soLinger)` Sets the `SO_LINGER` option.
`void`	`setSslContext(SSLContext sslContext)` Sets the `SSLContext` which is used to establish an HTTPS connection.
`void`	`setTcpNoDelay(boolean tcpNoDelay)` Sets the `SO_TCPNODELAY` option.
`void`	`setTrafficClass(int trafficClass)` Sets the traffic class as specified in `Socket.setTrafficClass(int)`.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

getServerName

public String getServerName()

Returns the host name of the HTTP server. If null, the "Host" header is not sent by the HTTP tunneling client.

setServerName

public void setServerName(String serverName)

Sets the host name of the HTTP server. If null, the "Host" header is not sent by the HTTP tunneling client.

getServerPath

public String getServerPath()

Returns the path where the HttpTunnelingServlet is mapped to. The default value is "/netty-tunnel".

setServerPath

public void setServerPath(String serverPath)

Sets the path where the HttpTunnelingServlet is mapped to. The default value is "/netty-tunnel".

getSslContext

public SSLContext getSslContext()

Returns the SSLContext which is used to establish an HTTPS connection. If null, a plain-text HTTP connection is established.

setSslContext

public void setSslContext(SSLContext sslContext)

Sets the SSLContext which is used to establish an HTTPS connection. If null, a plain-text HTTP connection is established.

getEnabledSslCipherSuites

public String[] getEnabledSslCipherSuites()

Returns the cipher suites enabled for use on an SSLEngine. If null, the default value will be used.

See Also:: SSLEngine.getEnabledCipherSuites()

setEnabledSslCipherSuites

public void setEnabledSslCipherSuites(String[] suites)

Sets the cipher suites enabled for use on an SSLEngine. If null, the default value will be used.

See Also:: SSLEngine.setEnabledCipherSuites(String[])

getEnabledSslProtocols

public String[] getEnabledSslProtocols()

Returns the protocol versions enabled for use on an SSLEngine.

See Also:: SSLEngine.getEnabledProtocols()

setEnabledSslProtocols

public void setEnabledSslProtocols(String[] protocols)

Sets the protocol versions enabled for use on an SSLEngine.

See Also:: SSLEngine.setEnabledProtocols(String[])

isEnableSslSessionCreation

public boolean isEnableSslSessionCreation()

Returns true if new SSLSessions may be established by an SSLEngine.

See Also:: SSLEngine.getEnableSessionCreation()

setEnableSslSessionCreation

public void setEnableSslSessionCreation(boolean flag)

Sets whether new SSLSessions may be established by an SSLEngine.

See Also:: SSLEngine.setEnableSessionCreation(boolean)

setOptions

public void setOptions(Map<String,Object> options)

Description copied from interface: ChannelConfig

Sets the configuration properties from the specified Map.

Specified by:: setOptions in interface ChannelConfig

setOption

public boolean setOption(String key,
                         Object value)

Description copied from interface: ChannelConfig

Sets a configuration property with the specified name and value. To override this method properly, you must call the super class:

 public boolean setOption(String name, Object value) {
     if (super.setOption(name, value)) {
         return true;
     }

     if (name.equals("additionalOption")) {
         ....
         return true;
     }

     return false;
 }

Specified by:: setOption in interface ChannelConfig

Returns:: true if and only if the property has been set