HTTPInboundChannel


This type is a class for model objects.

This class handles inbound HTTP requests from a remote client. It handles parsing the request and using discrimination to find an application channel above that will handle the request and send a response.

Package: channels
Supertype: InboundTransportChannel

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *



Attributes Summary
maximumPersistentRequests : EInt Maximum requests allowed on a single HTTP connection. -1 means one request per connection only 0 means unlimited requests per connection X means X requests per connection
keepAlive : EBoolean When sending an outgoing HTTP message, this controls whether or not to default to a persistent connection (Keep-Alive) as opposed to a connection that will close after one request/response exchange. Note that if the maximum request persistence parameter is set to the unlimited value, then it will override this configuration and force a Keep-Alive scenario.
readTimeout : EInt This timeout value controls the allowed time (in seconds) to wait while performing a read of data on a socket.
writeTimeout : EInt This timeout value controls the allowed time (in seconds) to wait while performing a write of data on a socket.
persistentTimeout : EInt This timeout value controls the allowed idle time (in seconds) on a socket between client requests. Once this timeout is passed, the connection will be closed.
enableLogging : EBoolean * No description is available *
maxFieldSize : EInt @since 7.0.0 Maximum size allowed for various HTTP fields being parsed, such as header names or values, along with request URLs or request methods.
maxHeaders : EInt @since 7.0.0 Maximum number of headers that will be parsed on an inbound message before an error status code is sent to the client. It is also used for headers added to an outbound response message, throwing an exception to the user when too many headers are added.
maxRequestMessageBodySize : EInt @since 7.0.0 Maximum inbound request message that will be read off the network before an IOException is sent to the Proxy channel. -1 is unlimited inbound body and 0 signifies that no message body is allowed.
useChannelAccessLoggingSettings : EBoolean @since 7.0.0 Flag to determine whether to use the channel specific NCSA access logging settings. If false the global NCSA access logging settings will be used.
useChannelFRCALoggingSettings : EBoolean @since 7.0.0 Flag to determine whether to use the channel specific FRCA logging settings. If false the global FRCA logging settings will be used.
useChannelErrorLoggingSettings : EBoolean @since 7.0.0 Flag to determine whether to use the channel specific error logging settings. If false the global error logging settings will be used.
httpInboundChannelLogging : HTTPInboundChannelLogging @ * No description is available *



Attribute Details

maximumPersistentRequests  -  Maximum requests allowed on a single HTTP connection. -1 means one request per connection only 0 means unlimited requests per connection X means X requests per connection
    Data Type: EInt
    Default value:  100
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

keepAlive  -  When sending an outgoing HTTP message, this controls whether or not to default to a persistent connection (Keep-Alive) as opposed to a connection that will close after one request/response exchange. Note that if the maximum request persistence parameter is set to the unlimited value, then it will override this configuration and force a Keep-Alive scenario.
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

readTimeout  -  This timeout value controls the allowed time (in seconds) to wait while performing a read of data on a socket.
    Data Type: EInt
    Default value:  60
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

writeTimeout  -  This timeout value controls the allowed time (in seconds) to wait while performing a write of data on a socket.
    Data Type: EInt
    Default value:  60
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

persistentTimeout  -  This timeout value controls the allowed idle time (in seconds) on a socket between client requests. Once this timeout is passed, the connection will be closed.
    Data Type: EInt
    Default value:  30
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableLogging  -  * No description is available *
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

maxFieldSize  -  @since 7.0.0 Maximum size allowed for various HTTP fields being parsed, such as header names or values, along with request URLs or request methods.
    Data Type: EInt
    Default value:  32768
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

maxHeaders  -  @since 7.0.0 Maximum number of headers that will be parsed on an inbound message before an error status code is sent to the client. It is also used for headers added to an outbound response message, throwing an exception to the user when too many headers are added.
    Data Type: EInt
    Default value:  50
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

maxRequestMessageBodySize  -  @since 7.0.0 Maximum inbound request message that will be read off the network before an IOException is sent to the Proxy channel. -1 is unlimited inbound body and 0 signifies that no message body is allowed.
    Data Type: EInt
    Default value:  -1
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

useChannelAccessLoggingSettings  -  @since 7.0.0 Flag to determine whether to use the channel specific NCSA access logging settings. If false the global NCSA access logging settings will be used.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

useChannelFRCALoggingSettings  -  @since 7.0.0 Flag to determine whether to use the channel specific FRCA logging settings. If false the global FRCA logging settings will be used.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

useChannelErrorLoggingSettings  -  @since 7.0.0 Flag to determine whether to use the channel specific error logging settings. If false the global error logging settings will be used.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

httpInboundChannelLogging  -  * No description is available *
    Reference Type: HTTPInboundChannelLogging @
    Containment:  true
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false



(C) COPYRIGHT International Business Machines Corp. 1996-2006