ProxySettings


This type is a class for model objects.

These settings describe the global attributes and policies that define the behavior of the proxy server.

Package: proxy

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



Attributes Summary
methodsDisable : EString HTTP methods that should not be accepted by the proxy server.
enableCaching : EBoolean Enable caching at the proxy server
enableDynamicCache : EBoolean Enable caching of full page dynamic content.
enableESI : EBoolean Enable assembly, caching and fetching content using the ESI (Edge Side Include) specification.
sslCacheEnable : EBoolean Enable content secured by SSL to be cached at the proxy server
enableAggressiveCaching : EBoolean Enable aggressive caching of content in the Proxy Server.
cacheUpdateUri : EString The URI at a remote server used to receive invalidations and provide updates on the proxy cache statistics
cacheInstanceName : EString The default cache instance configured as a cache store for the proxy server
outboundRequestTimeout : EInt The amount of time to wait for requests made to the content servers in seconds.
outboundSSLAlias : EString The default SSL repertoire alias configured for making SSL connections to the enterprise content servers by the proxy server.
connectionPoolEnable : EBoolean Enable the use of a pool of established connections to the enterprise content servers.
maxConnectionsPerServer : EInt The maximum number of idle established connections that may be in the connection pool for any server.
trustedIntermediaryAddresses : EString The addresses of trusted intermediaries that forwards requests to the Proxy server. If there is a trusted intermediary (security proxy) fronting this proxy server, the IP address or host name of those servers should be specified here.
enableLogging : EBoolean * No description is available *
maximumLogSize : EInt Maximum size of each of the log files in megabytes.
proxyAccessLog : EString The location for the HTTP access log (NCSA) generated for proxied requests
cacheAccessLog : EString The HTTP access log (NCSA) generated for requests served from the local cache
localAccessLog : EString * No description is available *
excludeURIGroup : EString * No description is available *
serverHeader : EString The value of the SERVER header returned by the Proxy server in responses.
enableWebServicesSupport : EBoolean Specifies whether support for Web Services is active or not
outboundConnectTimeout : EInt The amount of time (in milliseconds) the proxy will wait to connect to a server. If the time expires, the proxy will attempt to select another available server. In no other available servers exist, an HTTP 504 response is sent to the client. A value of zero means to use the operating system's Kernel timeout value. Default value is 10000.
enableCustomErrorPagePolicy : EBoolean @since 7.0.0 Flag to indicate which error page policy should be employed - custom/remote vs. local.
maxRequestBodyBufferChunkSize : EInt @since 7.0.0 The maximum number of request body kilobytes read from the client that the proxy will buffer in memory before writing to the server.
maxResponseBodyBufferChunkSize : EInt @since 7.0.0 The maximum number of request body kilobytes read from the client that the proxy will buffer in memory before writing to the server.
enableStaticRouting : EBoolean @since 7.0.0 Enables static routing on the proxy server. If not enabled, the proxy server will use dynamic routing to route requests to back-end servers.
outboundRequestWriteTimeout : EInt @since 7.0.0 The amount of time to wait in seconds for write requests made to the content servers.
memoryCacheEntrySizeInMB : EInt @since 7.0.0 Specifies the maximum size of an individual cached response in MB. Any cached response larger than this will not be cached.
staticRoutingFileDirectory : EString @since 7.0.0 A directory of files that contain static routing information.
pluginConfigPolicy : PluginConfigPolicy @ * No description is available *
properties : Property * * No description is available *
routingPolicy : RoutingPolicy @ * No description is available *
staticCachePolicy : StaticCachePolicy @ * No description is available *
uriGroups : URIGroup * * No description is available *
errorPagePolicy : CustomErrorPagePolicy @ * No description is available *
rewritingPolicy : RewritingPolicy @ * No description is available *
localErrorPagePolicy : LocalErrorPagePolicy @ * No description is available *
staticFileServingPolicy : StaticFileServingPolicy @ * No description is available *
customAdvisorPolicy : CustomAdvisorPolicy @ * No description is available *
workloadManagementPolicy : WorkloadManagementPolicy @ * No description is available *



Attribute Details

methodsDisable  -  HTTP methods that should not be accepted by the proxy server.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableCaching  -  Enable caching at the proxy server
    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

enableDynamicCache  -  Enable caching of full page dynamic content.
    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

enableESI  -  Enable assembly, caching and fetching content using the ESI (Edge Side Include) specification.
    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

sslCacheEnable  -  Enable content secured by SSL to be cached at the proxy server
    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

enableAggressiveCaching  -  Enable aggressive caching of content in the Proxy Server.
    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

cacheUpdateUri  -  The URI at a remote server used to receive invalidations and provide updates on the proxy cache statistics
    Data Type: EString
    Default value:  /_DynaCacheEsi/esiInvalidator
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

cacheInstanceName  -  The default cache instance configured as a cache store for the proxy server
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

outboundRequestTimeout  -  The amount of time to wait for requests made to the content servers in seconds.
    Data Type: EInt
    Default value:  120
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

outboundSSLAlias  -  The default SSL repertoire alias configured for making SSL connections to the enterprise content servers by the proxy server.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

connectionPoolEnable  -  Enable the use of a pool of established connections to the enterprise content servers.
    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

maxConnectionsPerServer  -  The maximum number of idle established connections that may be in the connection pool for any server.
    Data Type: EInt
    Default value:  20
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

trustedIntermediaryAddresses  -  The addresses of trusted intermediaries that forwards requests to the Proxy server. If there is a trusted intermediary (security proxy) fronting this proxy server, the IP address or host name of those servers should be specified here.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    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

maximumLogSize  -  Maximum size of each of the log files in megabytes.
    Data Type: EInt
    Default value:  500
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

proxyAccessLog  -  The location for the HTTP access log (NCSA) generated for proxied requests
    Data Type: EString
    Default value:  ${SERVER_LOG_ROOT}/proxy.log
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

cacheAccessLog  -  The HTTP access log (NCSA) generated for requests served from the local cache
    Data Type: EString
    Default value:  ${SERVER_LOG_ROOT}/cache.log
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

localAccessLog  -  * No description is available *
    Data Type: EString
    Default value:  ${SERVER_LOG_ROOT}/local.log
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

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

serverHeader  -  The value of the SERVER header returned by the Proxy server in responses.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableWebServicesSupport  -  Specifies whether support for Web Services is active or not
    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

outboundConnectTimeout  -  The amount of time (in milliseconds) the proxy will wait to connect to a server. If the time expires, the proxy will attempt to select another available server. In no other available servers exist, an HTTP 504 response is sent to the client. A value of zero means to use the operating system's Kernel timeout value. Default value is 10000.
    Data Type: EInt
    Default value:  10000
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableCustomErrorPagePolicy  -  @since 7.0.0 Flag to indicate which error page policy should be employed - custom/remote vs. local.
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

maxRequestBodyBufferChunkSize  -  @since 7.0.0 The maximum number of request body kilobytes read from the client that the proxy will buffer in memory before writing to the server.
    Data Type: EInt
    Default value:  32
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

maxResponseBodyBufferChunkSize  -  @since 7.0.0 The maximum number of request body kilobytes read from the client that the proxy will buffer in memory before writing to the server.
    Data Type: EInt
    Default value:  32
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableStaticRouting  -  @since 7.0.0 Enables static routing on the proxy server. If not enabled, the proxy server will use dynamic routing to route requests to back-end servers.
    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

outboundRequestWriteTimeout  -  @since 7.0.0 The amount of time to wait in seconds for write requests made to the content servers.
    Data Type: EInt
    Default value:  120
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

memoryCacheEntrySizeInMB  -  @since 7.0.0 Specifies the maximum size of an individual cached response in MB. Any cached response larger than this will not be cached.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

staticRoutingFileDirectory  -  @since 7.0.0 A directory of files that contain static routing information.
    Data Type: EString
    Default value:  ${USER_INSTALL_ROOT}/staticRoutes
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

pluginConfigPolicy  -  * No description is available *
    Reference Type: PluginConfigPolicy @
    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

properties  -  * No description is available *
    Reference Type: Property *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

routingPolicy  -  * No description is available *
    Reference Type: RoutingPolicy @
    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

staticCachePolicy  -  * No description is available *
    Reference Type: StaticCachePolicy @
    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

uriGroups  -  * No description is available *
    Reference Type: URIGroup *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

errorPagePolicy  -  * No description is available *
    Reference Type: CustomErrorPagePolicy @
    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

rewritingPolicy  -  * No description is available *
    Reference Type: RewritingPolicy @
    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

localErrorPagePolicy  -  * No description is available *
    Reference Type: LocalErrorPagePolicy @
    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

staticFileServingPolicy  -  * No description is available *
    Reference Type: StaticFileServingPolicy @
    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

customAdvisorPolicy  -  * No description is available *
    Reference Type: CustomAdvisorPolicy @
    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

workloadManagementPolicy  -  * No description is available *
    Reference Type: WorkloadManagementPolicy @
    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