complexType HTTPClientPolicy in namespace http://cxf.apache.org/transports/http/configuration

Overview

Namespace

Component

Index

Help

FUSE ESB 4.2 XML Configuration Reference

SUMMARY: DOCUMENTATION | ATTRIBUTES

FRAMES | NO FRAMES

http://cxf.apache.org/transports/http/configuration
complexType HTTPClientPolicy

{http://www.w3.org/2001/XMLSchema}anyType
  {http://schemas.xmlsoap.org/wsdl/}tExtensibilityElement
      {http://cxf.apache.org/transports/http/configuration}HTTPClientPolicy

Model: <... Accept = string AcceptEncoding = string AcceptLanguage = string AllowChunking = boolean | ParameterizedValue : "true" AutoRedirect = boolean | ParameterizedValue : "false" BrowserType = string CacheControl = "no-cache" | "no-store" | "max-age" | "max-stale" | "min-fresh" | "no-transform" | "only-if-cached" | "cache-extension" ChunkingThreshold = int | ParameterizedValue : "4096" Connection = "close" | "Keep-Alive" : "Keep-Alive" ConnectionTimeout = unsignedInt | ParameterizedValue : "30000" ContentType = string Cookie = string DecoupledEndpoint = string Host = string MaxRetransmits = int | ParameterizedValue : "-1" ProxyServer = string ProxyServerPort = int | ParameterizedValue ProxyServerType = "HTTP" | "SOCKS" : "HTTP" ReceiveTimeout = unsignedInt | ParameterizedValue : "60000" Referer = string required = boolean />

Prohibited substitutions (block): allowed to substitute with an xsi:type attribute with any derived type

Content Type: empty, not nillable.
This type can be derived by extension or restriction.

Usage: client

Documentation

Properties used to configure a client-side HTTP port

Attribute Summary
`string`	`Accept` Specifies the MIME types the client is prepared to handle (e.g., HTML, JPEG, GIF, etc.)
`string`	`AcceptEncoding` Specifies the encoding the client is prepared to handle (e.g., gzip)
`string`	`AcceptLanguage` Specifies the language the client desires (e.g., English, French, etc.)
`ParameterizedBoolean`	`AllowChunking` If true, the client is free to use chunking streams if it wants, but it is not required to use chunking streams.
`ParameterizedBoolean`	`AutoRedirect` Specifies if the consumer will automatically follow a server issued redirection.
`string`	`BrowserType` aka User-Agent Specifies the type of browser is sending the request.
`clientCacheControlType`	`CacheControl` Most commonly used to specify no-cache, however the standard supports a dozen or so caching related directives for requests
`ParameterizedInt`	`ChunkingThreshold` If AllowChunking is true, this sets the threshold at which messages start getting chunked.
`connectionType`	`Connection` The connection disposition.
`ParameterizedUInt`	`ConnectionTimeout` Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out.
`string`	`ContentType` Specifies the content type of the stream being sent in a post request.
`string`	`Cookie` Specifies a cookie to send to the server.
`string`	`DecoupledEndpoint` Specifies the URL of a decoupled endpoint for the receipt of responses over a separate provider->consumer connection.
`string`	`Host` Specifies the Internet host and port number of the resource on which the request is being invoked.
`ParameterizedInt`	`MaxRetransmits` Specifies the maximum amount of retransmits that are allowed for redirects.
`string`	`ProxyServer` Specifies the address of proxy server if one is used.
`ParameterizedInt`	`ProxyServerPort` Specifies the port number used by the proxy server.
`proxyServerType`	`ProxyServerType` Specifies the ype of the proxy server.
`ParameterizedUInt`	`ReceiveTimeout` Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out.
`string`	`Referer` Specifies the URL that referred us to this URL.
`boolean`	`required`

Attribute Detail

Accept

Documentation

                        Specifies the MIME types the client is prepared to handle (e.g., HTML, JPEG, GIF, etc.)

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

AcceptEncoding

Documentation

                        Specifies the encoding the client is prepared to handle (e.g., gzip)

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

AcceptLanguage

Documentation

                        Specifies the language the client desires (e.g., English, French, etc.)

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

AllowChunking

Documentation

                        If true, the client is free to use chunking streams if it wants, but it is not 
                        required to use chunking streams. If false, the client 
                        must use regular, non-chunked requests in all cases.

Definition: Defined with global type ParameterizedBoolean

Model: boolean | ParameterizedValue

Default Value: "true"

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

Type: ParameterizedBoolean

AutoRedirect

Documentation

                       Specifies if the consumer will automatically follow a server issued redirection.
                        (name is not part of standard)

Definition: Defined with global type ParameterizedBoolean

Model: boolean | ParameterizedValue

Default Value: "false"

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

Type: ParameterizedBoolean

BrowserType

Documentation

                        aka User-Agent
                        Specifies the type of browser is sending the request. This is usually only 
                        needed when sites have HTML customized to Netscape vs IE, etc, but can
                        also be used to optimize for different SOAP stacks.

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

CacheControl

Documentation

                        Most commonly used to specify no-cache, however the standard supports a 
                        dozen or so caching related directives for requests

Definition: Defined with global type clientCacheControlType

Model: "no-cache" | "no-store" | "max-age" | "max-stale" | "min-fresh" | "no-transform" | "only-if-cached" | "cache-extension"

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

ChunkingThreshold

Documentation

                        If AllowChunking is true, this sets the threshold at which messages start
                        getting chunked. Messages under this limit do not get chunked.

Definition: Defined with global type ParameterizedInt

Model: int | ParameterizedValue

Default Value: "4096"

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, partialy ordered, countable infinite value space

White Space Processing: collapse

Type: ParameterizedInt

Connection

Documentation

                        The connection disposition. If close the connection to the server is closed 
                        after each request/response dialog. If Keep-Alive the client requests the server 
                        to keep the connection open, and if the server honors the keep alive request, 
                        the connection is reused. Many servers and proxies do not honor keep-alive requests.

Definition: Defined with global type connectionType

Model: "close" | "Keep-Alive"

Default Value: "Keep-Alive"

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

ConnectionTimeout

Documentation

                        Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. 0 is infinite.

Definition: Defined with global type ParameterizedUInt

Model: unsignedInt | ParameterizedValue

Default Value: "30000"

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, partialy ordered, countable infinite value space

White Space Processing: collapse

Type: ParameterizedUInt

ContentType

Documentation

                        Specifies the content type of the stream being sent in a post request. 
                        (this should be text/xml for web services, or can be set to 
                        application/x-www-form-urlencoded if the client is sending form data).

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

Cookie

Documentation

                        Specifies a cookie to send to the server. Some stateful session designs will use cookies to identify a session.
                        If the cookie is static, you can supply it here. If it is dynamic,
                        it will need to be set by the server on first access, and can be handled
                        automatically by the runtime.

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

DecoupledEndpoint

Documentation

                        Specifies the URL of a decoupled endpoint for the receipt of responses over a separate provider->consumer connection.

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

Host

Documentation

                        Specifies the Internet host and port number of the resource on which the request is being invoked.
                        This is sent by default based upon the URL. Certain DNS scenarios or
                        application designs may request you to set this, but typically it is
                        not required.

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

MaxRetransmits

Documentation

                        Specifies the maximum amount of retransmits that are allowed for redirects. Retransmits for 
                        authorization is included in the retransmit count. Each redirect may cause another 
                        retransmit for a UNAUTHORIZED response code, ie. 401. 
                        Any negative number indicates unlimited retransmits,
                        although, loop protection is provided. 
                        The default is unlimited. 
                        (name is not part of standard)

Definition: Defined with global type ParameterizedInt

Model: int | ParameterizedValue

Default Value: "-1"

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, partialy ordered, countable infinite value space

White Space Processing: collapse

Type: ParameterizedInt

ProxyServer

Documentation

                        Specifies the address of proxy server if one is used.

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

ProxyServerPort

Documentation

                        Specifies the port number used by the proxy server.

Definition: Defined with global type ParameterizedInt

Model: int | ParameterizedValue

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, partialy ordered, countable infinite value space

White Space Processing: collapse

Type: ParameterizedInt

ProxyServerType

Documentation

                        Specifies the ype of the proxy server. Can be either HTTP or SOCKS.

Definition: Defined with global type proxyServerType

Model: "HTTP" | "SOCKS"

Default Value: "HTTP"

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

ReceiveTimeout

Documentation

                        Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. 0 is infinite.

Definition: Defined with global type ParameterizedUInt

Model: unsignedInt | ParameterizedValue

Default Value: "60000"

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, partialy ordered, countable infinite value space

White Space Processing: collapse

Type: ParameterizedUInt

Referer

Documentation

                        Specifies the URL that referred us to this URL. This is 
                        sent automatically with auto redirect.

                        May allow the server to optimize processing based upon
                        previous task flow.  However, typically not used in 
                        web services applications.

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

required

Definition

Defined as global attribute required

Defined with global type boolean

Namespace: http://schemas.xmlsoap.org/wsdl/

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

Overview

Namespace

Component

Index

Help

FUSE ESB 4.2 XML Configuration Reference

SUMMARY: DOCUMENTATION | ATTRIBUTES

FRAMES | NO FRAMES

FUSE ESB 4.2 XML Configuration Reference

http://cxf.apache.org/transports/http/configuration complexType HTTPClientPolicy

Accept

AcceptEncoding

AcceptLanguage

AllowChunking

AutoRedirect

BrowserType

CacheControl

ChunkingThreshold

Connection

ConnectionTimeout

ContentType

Cookie

DecoupledEndpoint

Host

MaxRetransmits

ProxyServer

ProxyServerPort

ProxyServerType

ReceiveTimeout

Referer

required

http://cxf.apache.org/transports/http/configuration
complexType HTTPClientPolicy