PluginProperties


This type is a class for model objects.

Webserver plugin properties. @since 6.0.0

Package: webserver

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

Collection attributes having this type:
  WebServer.pluginProperties



Attributes Summary
PluginInstallRoot : EString The fully qualified directory path in which the plugin is installed on the webserver.
ConfigFilename : EString The name of the plugin configuration file.
RefreshInterval : EInt The time interval (in seconds) at which the plug-in should check the configuration file to see if updates or changes have occurred.
IgnoreDNSFailures : EBoolean Specifies whether the plug-in ignores DNS failures within a configuration when starting. The default value is false, and DNS failures will prevent the plug-in from loading.
ResponseChunkSize : EInt Specifies the maximum chunk size (in KB) to use when reading the response body.
ASDisableNagle : EBoolean Specifies whether the user wants to disable nagle algorithm for the connection between the plug-in and the application server.
IISDisableNagle : EBoolean The nagle algorithm is enabled by default on Microsoft Internet Infomations Services (IIS). This attribute can be used to disable the nagle algorithm.
IISPluginPriority : PluginPriorityKind Specify the priority in which IIS webserver loads the WAS plugin. The default value is HIGH.
AcceptAllContent : EBoolean Specifies whether or not users can include content in POST, PUT, GET, and HEAD requests when a Content-Length or Transfer-encoding header is contained in the request header. It can be set to true if content is to be expected and read for all requests. By default, content is to be expected and read for POST and PUT requests only.
ChunkedResponse : EBoolean Specifies whether the plug-in will chunk the response to the client if the header "Transfer-Encoding : Chunked" is present in the response. This attribute applies to the following webservers: IIS, IPlanet, and Domino. IHS webserver automatically handles the chunking of the response to the client.
LogFilename : EString The fully qualified name of the log file on the webserver to which the plug-in will write error messages.
LogLevel : LogLevelKind The level of detail of the log messages that the plug-in should write to the log. You can specify one of the following values for this attribute: Trace - All of the steps in the request process are logged in detail. Stats - The server selected for each request and other load balancing information relating to request handling is logged. Warn - All warning and error messages resulting from abnormal request processing are logged. Error - Only error messages resulting from abnormal request processing are logged.
ESIEnable : EBoolean This property can be used to disable the ESI (Edge Side Include) processor by setting the value to false. ESI is enabled by default.
ESIMaxCacheSize : EInt Maximum size of the cache in 1K byte units. The default maximum size of the cache is 1 megabyte. If the cache is full, the first entry to be evicted from the cache is the entry that is closest to expiration.
ESIInvalidationMonitor : EBoolean Specifies whether or not the ESI processor should receive invalidations from the application server.
AppServerPortPreference : PortPreferenceKind Specifies the way the Application server finds the port number used in building URI's for a sendRedirect. It can be the port number from the host header of the http request coming in, or the port number that the web server received the request on. The default is "webserverPort". Other option is "hostHeader".
VHostMatchingCompat : EBoolean Specifies the port number used for virtual host matching. When this attribute is enabled, matching is done physically by using the port number for which the request was received. Otherwise, matching is done logically by using the port number from the host header. The default is false.
PluginGeneration : PluginMethodKind Specifies whether the plugin config file should be automatically generated by the plugin config service. By default, the plugin config file is not automatically generated.
PluginPropagation : PluginMethodKind Specifies whether the plugin config file should be automatically propagated to the remote unmanaged webservers using IHS admin. The plugin config file is progagated by the plugin config service after being generated automatically. By default, the plugin config file is not automatically propagated to the remote unmanaged node.
KeyRingFilename : EString Name of the key ring database file used for making SSL connection to the application server.
RemoteConfigFilename : EString The fully qualified directory path and file name of the plug-in configuration file on the webserver box
RemoteKeyRingFilename : EString The fully qualified directory path and file name of the key ring darabase file on the webserver box
pluginServerClusterProperties : PluginServerClusterProperties @ * No description is available *
properties : Property * * No description is available *



Attribute Details

PluginInstallRoot  -  The fully qualified directory path in which the plugin is installed on the webserver.
    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

ConfigFilename  -  The name of the plugin configuration file.
    Data Type: EString
    Default value:  plugin-cfg.xml
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

RefreshInterval  -  The time interval (in seconds) at which the plug-in should check the configuration file to see if updates or changes have occurred.
    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

IgnoreDNSFailures  -  Specifies whether the plug-in ignores DNS failures within a configuration when starting. The default value is false, and DNS failures will prevent the plug-in from loading.
    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

ResponseChunkSize  -  Specifies the maximum chunk size (in KB) to use when reading the response body.
    Data Type: EInt
    Default value:  64
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

ASDisableNagle  -  Specifies whether the user wants to disable nagle algorithm for the connection between the plug-in and the application 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

IISDisableNagle  -  The nagle algorithm is enabled by default on Microsoft Internet Infomations Services (IIS). This attribute can be used to disable the nagle algorithm.
    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

IISPluginPriority  -  Specify the priority in which IIS webserver loads the WAS plugin. The default value is HIGH.
    Data Type: PluginPriorityKind
    Default value:  HIGH
    Allowed values:
        0 - HIGH
        1 - MEDIUM
        2 - LOW
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

AcceptAllContent  -  Specifies whether or not users can include content in POST, PUT, GET, and HEAD requests when a Content-Length or Transfer-encoding header is contained in the request header. It can be set to true if content is to be expected and read for all requests. By default, content is to be expected and read for POST and PUT requests only.
    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

ChunkedResponse  -  Specifies whether the plug-in will chunk the response to the client if the header "Transfer-Encoding : Chunked" is present in the response. This attribute applies to the following webservers: IIS, IPlanet, and Domino. IHS webserver automatically handles the chunking of the response to the client.
    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

LogFilename  -  The fully qualified name of the log file on the webserver to which the plug-in will write error messages.
    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

LogLevel  -  The level of detail of the log messages that the plug-in should write to the log. You can specify one of the following values for this attribute: Trace - All of the steps in the request process are logged in detail. Stats - The server selected for each request and other load balancing information relating to request handling is logged. Warn - All warning and error messages resulting from abnormal request processing are logged. Error - Only error messages resulting from abnormal request processing are logged.
    Data Type: LogLevelKind
    Default value:  ERROR
    Allowed values:
        0 - TRACE
        1 - STATS
        2 - WARN
        3 - ERROR
        4 - DEBUG
        5 - DETAIL
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

ESIEnable  -  This property can be used to disable the ESI (Edge Side Include) processor by setting the value to false. ESI is enabled by default.
    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

ESIMaxCacheSize  -  Maximum size of the cache in 1K byte units. The default maximum size of the cache is 1 megabyte. If the cache is full, the first entry to be evicted from the cache is the entry that is closest to expiration.
    Data Type: EInt
    Default value:  1024
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

ESIInvalidationMonitor  -  Specifies whether or not the ESI processor should receive invalidations from the application 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

AppServerPortPreference  -  Specifies the way the Application server finds the port number used in building URI's for a sendRedirect. It can be the port number from the host header of the http request coming in, or the port number that the web server received the request on. The default is "webserverPort". Other option is "hostHeader".
    Data Type: PortPreferenceKind
    Default value:  WEBSERVERPORT
    Allowed values:
        0 - WEBSERVERPORT
        1 - HOSTHEADER
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

VHostMatchingCompat  -  Specifies the port number used for virtual host matching. When this attribute is enabled, matching is done physically by using the port number for which the request was received. Otherwise, matching is done logically by using the port number from the host header. The default is false.
    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

PluginGeneration  -  Specifies whether the plugin config file should be automatically generated by the plugin config service. By default, the plugin config file is not automatically generated.
    Data Type: PluginMethodKind
    Default value:  AUTOMATIC
    Allowed values:
        0 - AUTOMATIC
        1 - MANUAL
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

PluginPropagation  -  Specifies whether the plugin config file should be automatically propagated to the remote unmanaged webservers using IHS admin. The plugin config file is progagated by the plugin config service after being generated automatically. By default, the plugin config file is not automatically propagated to the remote unmanaged node.
    Data Type: PluginMethodKind
    Default value:  AUTOMATIC
    Allowed values:
        0 - AUTOMATIC
        1 - MANUAL
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

KeyRingFilename  -  Name of the key ring database file used for making SSL connection to the application server.
    Data Type: EString
    Default value:  plugin-key.kdb
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

RemoteConfigFilename  -  The fully qualified directory path and file name of the plug-in configuration file on the webserver box
    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

RemoteKeyRingFilename  -  The fully qualified directory path and file name of the key ring darabase file on the webserver box
    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

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



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