VirtualHostMBean

Overview

This bean represents the configuration of virtual web server within a WebLogic Server instance. Note that a server may define multiple web servers to support virtual hosts.

This MBean represents a virtual host.

Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

Targets

You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

WebServerLog

Returns the Log settings for the WebServer/VirtualHost.

Attributes

This section describes the following attributes:

AcceptContextPathInGetRealPath

Indicates whether this server allows the inclusion of the context path in the virtual path to context.getRealPath(). (If checked, you cannot use sub directories with the same name as contextPath). This is a compatibility switch that will be deprecated 9.0.0.0 in future releases.

Gets the acceptContextPathInGetRealPath attribute of the WebServerMBean object

AuthCookieEnabled

Whether authcookie feature is enabled or not.

Charsets

Provides user defined mapping between internet and Java charset names.

ChunkedTransferDisabled

Indicates whether the use of Chunk Transfer-Encoding in HTTP/1.1 is enabled.

DefaultWebAppContextRoot

Returns the original context-root for the default Web application for this Web server. Alternatively, you can use the context-root attributes in application.xml or weblogic.xml to set a default Web application. The context-root for a default Web application is /. If "" (empty string) is specified, the Web server defaults to /.

DeploymentOrder

A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

FrontendHost

The name of the host to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.

Sets the HTTP frontendHost Provides a method to ensure that the webapp will always have the correct HOST information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.

FrontendHTTPPort

The name of the HTTP port to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.

Sets the frontendHTTPPort Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.

FrontendHTTPSPort

The name of the secure HTTP port to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.

Sets the frontendHTTPSPort Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.

HttpsKeepAliveSecs

The amount of time this server waits before closing an inactive HTTPS connection.

Number of seconds to maintain HTTPS keep-alive before timing out the request.

KeepAliveEnabled

Indicates whether there should be a persistent connection to this server. (This may improve the performance of your Web applications.)

Gets the keepAliveEnabled attribute of the WebServerMBean object

KeepAliveSecs

The amount of time this server waits before closing an inactive HTTP connection.

Number of seconds to maintain HTTP keep-alive before timing out the request.

MaxPostSize

The maximum post size this server allows for reading HTTP POST data in a servlet request. A value less than 0 indicates an unlimited size.

Gets the maxPostSize attribute of the WebServerMBean object

For more information, see:

• WebAppContainerMBean#getMaxPostSize()

MaxPostTimeSecs

Max Post Time (in seconds) for reading HTTP POST data in a servlet request. MaxPostTime < 0 means unlimited

Gets the maxPostTimeSecs attribute of the WebServerMBean object

For more information, see:

• WebAppContainerMBean#getMaxPostTimeSecs()

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:
Name=user-specified-name

NetworkAccessPoint

The dedicated server channel name (NetworkAccessPoint) for which this virtual host will serve http request. If the NetworkAccessPoint for a given http request doesn't match any virtual host's NetworkAccessPoint, incoming HOST header will be matched with the VirtualHostNames in order to resolve the right virtual host.

Notes

Optional information that you can include to describe this configuration.

WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

OverloadResponseCode

Get the response code to be used when an application is overloaded. An application can get overloaded when the number of pending requests has reached the max capacity specified in the WorkManager or when the server is low on memory. The low memory condition is determined using OverloadProtectionMBean#getFreeMemoryPercentLowThreshold() .

For more information, see:

• CapacityMBean
• OverloadProtectionMBean

Parent

Return the immediate parent for this MBean

PostTimeoutSecs

The amount of time this server waits between receiving chunks of data in an HTTP POST data before it times out. (This is used to prevent denial-of-service attacks that attempt to overload the server with POST data.)

Gets the postTimeoutSecs attribute of the WebServerMBean object

SendServerHeaderEnabled

Indicates whether this server name is sent with the HTTP response. (This is useful for wireless applications where there is limited space for headers.)

Indicates whether this server instance includes its name and WebLogic Server version number in HTTP response headers.

SingleSignonDisabled

Indicates whether the singleSignonDisabled attribute is enabled

Type

Returns the type of the MBean.

URLResource

Adds a URL connection factory resource into JNDI.

UseHeaderEncoding

UseHighestCompatibleHTTPVersion

Enables use of the highest compatible HTTP protocol version-string in the response. E.g. HTTP spec suggests that HTTP/1.1 version-string should be used in response to a request using HTTP/1.0. This does not necessarily affect the response format.

VirtualHostNames

The comma-separated list of host names for which this virtual host will serve requests.

WAPEnabled

Indicates whether the session ID should include JVM information. (Checking this box may be necessary when using URL rewriting with WAP devices that limit the size of the URL to 128 characters, and may also affect the use of replicated sessions in a cluster.) When this box is selected, the default size of the URL will be set at 52 characters, and it will not contain any special characters.

Gets the WAPEnabled attribute of the WebServerMBean object

For more information, see:

• WebAppContainerMBean#isWAPEnabled()

WriteChunkBytes

The default size of the blocks to be written to the network layer.

Gets the writeChunkBytes attribute of the WebServerMBean object

Operations

This section describes the following operations:

addTarget

You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

removeTarget

Removes the value of the addTarget attribute.

For more information, see:

• addTarget

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

unSet

Restore the given property to its default value.