VirtualHostMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

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.

       
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.VirtualHostMBean
Factory Methods
Additional Access Points In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:
    Access Points Inherited from DeploymentMBean Because this MBean extends or implements DeploymentMBean, you can also access this MBean by retrieving DeploymentMBeans. The following attributes contain DeploymentMBeans and its subtypes:
      Access Points Inherited from TargetMBean Because this MBean extends or implements TargetMBean, you can also access this MBean by retrieving TargetMBeans. The following attributes contain TargetMBeans and its subtypes:
      Access Points Inherited from WebServerMBean Because this MBean extends or implements WebServerMBean, you can also access this MBean by retrieving WebServerMBeans. The following attributes contain WebServerMBeans and its subtypes:
      Deprecated Factory Methods and Access Points


        Related MBeans

        This section describes attributes that provide access to other MBeans.


        DefaultWebApp

        Provides the Servlet 2.3 Web Application that maps to the "default" servlet context (where ContextPath = "/"). This param has been deprecated 9.0.0.0 starting from 8.1 release. Set context-root="" instead in weblogic.xml or application.xml. Alternatively, use getDefaultWebAppDeployment()

        Gets the defaultWebApp attribute of the WebServerMBean object

               
        Privileges Read/Write
        TypeWebAppComponentMBean
        Relationship type: Reference.

        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.

               
        Privileges Read/Write
        TypeTargetMBean[]
        Relationship type: Reference.

        WebServerLog

        Returns the Log settings for the WebServer/VirtualHost.

               
        Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
        Privileges Read only
        TypeWebServerLogMBean
        Relationship type: Containment.


        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

               
        Privileges Read/Write
        Typeboolean

        AuthCookieEnabled

        Whether authcookie feature is enabled or not.

               
        Privileges Read/Write
        Typeboolean
        Default Valuetrue
        Secure valuetrue

        CachingDisabled

        Private property that disables caching in proxies.

               
        Privileges Read only
        Typeboolean
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        Charsets

        Provides user defined mapping between internet and Java charset names.

               
        Privileges Read/Write
        Typejava.util.Map

        ChunkedTransferDisabled

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

               
        Privileges Read/Write
        Typeboolean

        ClientIpHeader

        Get the Client IP Header from WebSerevrMBean.

               
        Privileges Read/Write
        Typejava.lang.String

        DebugEnabled

        Indicates whether the debugEnabled attribute is enabled.

        Deprecated. 9.0.0.0 use the ServerDebugMBean

               
        Privileges Read only
        Typeboolean
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        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 /.

               
        Available Since Release 9.0.0.0
        Privileges Read/Write
        Typejava.lang.String

        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.

               
        Privileges Read/Write
        Typeint
        Default Value1000
        Minimum value0
        Maximum value2147483647

        DynamicallyCreated

        Return whether the MBean was created dynamically or is persisted to config.xml

               
        Privileges Read only
        Typeboolean
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        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.

               
        Privileges Read/Write
        Typejava.lang.String

        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.

               
        Privileges Read/Write
        Typeint
        Default Value0

        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.

               
        Privileges Read/Write
        Typeint
        Default Value0

        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.

               
        Privileges Read/Write
        Typeint
        Default Value60
        Minimum value30
        Maximum value360
        Secure value60

        Id

        Return the unique id of this MBean instance

               
        Privileges Read only
        Typelong
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        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

               
        Privileges Read/Write
        Typeboolean
        Default Valuetrue
        Secure valuetrue

        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.

               
        Privileges Read/Write
        Typeint
        Default Value30
        Minimum value5
        Maximum value3600
        Secure value30

        LogFileBufferKBytes

        The maximum size (in kilobytes) of the buffer that stores HTTP requests. When the buffer reaches this size, the server writes the data to the HTTP log file. Use the LogFileFlushSecs property to determine the frequency with which the server checks the size of the buffer.

        The maximum size of the buffer that stores HTTP requests.

        Gets the logFileBufferKBytes attribute of the WebServerMBean object

               
        Privileges Read/Write
        Typeint
        Default Value8
        Minimum value0
        Maximum value1024

        LogFileCount

        The maximum number of log files that this server retains when it rotates the log. (This field is relevant only if you check the Limit Number of Retained Log Files box.)

        The maximum number of log files that the server creates when it rotates the log. Only valid if LogFileLimitEnabled is true and LogRotationType is either Size or Time.

        Deprecated. 9.0.0.0 Use getWebServerLog().getFileCount()

               
        Privileges Read/Write
        Typeint
        Default Value7
        Minimum value1
        Maximum value9999

        LogFileFlushSecs

        The interval at which this server checks the size of the buffer that stores HTTP requests. When the buffer exceeds the size that is specified in the Log Buffer Size field, the server writes the data to the HTTP request log file.

        The interval (in seconds) at which the server checks the size of the buffer that stores HTTP requests. When the buffer exceeds the size that is specified in the LogFileBufferKBytes property, the server writes the data in the buffer to the HTTP request log file.

               
        Privileges Read/Write
        Typeint
        Default Value60
        Minimum value1
        Maximum value360

        LogFileFormat

        The format of the HTTP log file. Both formats are defined by the W3C. With the extended log format, you use server directives in the log file to customize the information that the server records.

        Specifies the format of the HTTP log file. Both formats are defined by the W3C. With the extended log format, you use server directives in the log file to customize the information that the server records.

        Deprecated. 9.0.0.0 Use getWebServerLog().getLogFileFormat().

               
        Privileges Read/Write
        Typejava.lang.String
        Default Valuecommon
        Legal Values
        • common
        • extended

        LogFileLimitEnabled

        Indicates whether the number of files that this WebLogic Server retains to store old messages should be limited. After the server reaches this limit, it overwrites the oldest file.

        Indicates whether a server will limit the number of log files that it creates when it rotates the log. The limit is based on getLogFileCount.

        Deprecated. 9.0.0.0 Use getWebServerLog().getNumberOfFilesLimited()

               
        Privileges Read/Write
        Typeboolean

        LogFileName

        The name of the file that stores HTTP requests. If the pathname is not absolute, the path is assumed to be relative to the root directory of the machine on which this server is running.

        The name of the file that stores the HTTP-request log. If the pathname is not absolute, the path is assumed to be relative to the server's root directory.

        This value is relevant only if HTTP logging is enabled.

        The current logfile is always the one whose name equals value of the this attribute. If you have enabled log file rotation, when the current file exceeds the size or time limit, it is renamed.

        To include a time and date stamp in the file name when the log file is rotated, add java.text.SimpleDateFormat variables to the file name. Surround each variable with percentage (%) characters.

        For example, if the file name is defined to be access_%yyyy%_%MM%_%dd%_%hh%_%mm%.log, the log file will be named access_yyyy_mm_dd_hh_mm.log.

        When the log file is rotated, the rotated file name contains the date stamp. For example, if the log file is rotated on 2 April, 2003 at 10:05 AM, the log file that contains the old messages will be named access_2003_04_02_10_05.log.

        If you do not include a time and date stamp, the rotated log files are numbered in order of creation. For example, access.log00007.

        Deprecated. 9.0.0.0 Use getWebServerLog().getFileName()

               
        Privileges Read/Write
        Typejava.lang.String
        Default Valuelogs/access.log

        LoggingEnabled

        Indicates whether this server logs HTTP requests. (The remaining fields on this page are relevant only if you check this box.)

        Gets the loggingEnabled attribute of the WebServerMBean object

        Deprecated. 9.0.0.0 Use getWebServerLog().isLoggingEnabled().

               
        Privileges Read/Write
        Typeboolean
        Default Valuetrue
        Secure valuetrue

        LogRotationPeriodMins

        The number of minutes at which this server saves old HTTP requests to another log file. This field is relevant only if you set Rotation Type to date.

        The interval (in minutes) at which the server saves old HTTP requests to another log file. This value is relevant only if you use the date-based rotation type.

        Deprecated. 9.0.0.0 Use getWebServerLog().getFileTimeSpan() (hours)

               
        Privileges Read/Write
        Typeint
        Default Value1440
        Minimum value1
        Maximum value2147483647

        LogRotationTimeBegin

        The start time for a time-based rotation sequence of the log file, in the format MM-dd-yyyy-k:mm:ss. (This field is only relevant if you set Rotation Type to >date>.)

        Determines the start time for a time-based rotation sequence. At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in LogRotationPeriodMins.

        Use the following format: MM-dd-yyyy-k:mm:ss where

        If the time that you specify has already past, then the server starts its file rotation immediately.

        By default, rotation starts 24 hours from the time that you restart the server instance.

               
        Privileges Read/Write
        Typejava.lang.String

        LogRotationType

        The criteria for moving old log messages to a separate file.

        Criteria for moving old HTTP requests to a separate log file:

        After the server renames a file, subsequent messages accumulate in a new file with the name that you specified in LogFileName.

        Deprecated. 9.0.0.0 Use getWebServerLog().getRotationType()

               
        Privileges Read/Write
        Typejava.lang.String
        Default Valuesize
        Legal Values
        • size
        • date

        LogTimeInGMT

        Specifies whether the time stamps for HTTP log messages are in Greenwich Mean Time (GMT) regardless of the local time zone that the host computer specifies.

        Use this method to comply with the W3C specification for Extended Format Log Files. The specification states that all time stamps for Extended Format log entries be in GMT.

        This method applies only if you have specified the extended message format.

        Deprecated. 9.0.0.0 Use getWebServerLog().getLogTimeInGMT().

               
        Privileges Read/Write
        Typeboolean

        MaxLogFileSizeKBytes

        The maximum size (in kilobytes) of the HTTP log file. After the log file reaches this size, the server renames it as LogFileName.n. A value of 0 indicates that the log file can grow indefinitely. (This field is relevant only if you set Rotation Type to size.)

        The size that triggers the server to move log messages to a separate file. After the log file reaches the specified size, the next time the server checks the file size, it will rename the current log file as FileName.n and create a new one to store subsequent messages.

        This property is relevant only if you choose to rotate files by size.

        Deprecated. 9.0.0.0 Use getWebServerLog().getFileMinSize()

               
        Privileges Read/Write
        Typeint
        Default Value5000
        Minimum value0

        MaxPostSize

        The maximum post size this server allows for reading HTTP POST and PUT 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:

               
        Privileges Read/Write
        Typeint
        Default Value-1

        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:

               
        Privileges Read/Write
        Typeint
        Default Value-1

        MaxRequestParameterCount

        Max Request Parameter Count this server allows for reading maximum HTTP POST Parameters count in a servlet request.

        Gets the maxRequestParameterCount attribute of the WebServerMBean object

        For more information, see:

               
        Privileges Read/Write
        Typeint
        Default Value10000

        MBeanInfo

        Returns the MBean info for this MBean.

        Deprecated.

               
        Privileges Read only
        Typejavax.management.MBeanInfo
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        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

               
        Privileges Read/Write
        Typejava.lang.String

        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.

               
        Privileges Read/Write
        Typejava.lang.String

        Notes

        Optional information that you can include to describe this configuration.

        WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. 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.

                   
        Privileges Read/Write
        Security rolesWrite access is granted only to the following roles:
        • Deployer
        • Operator
        Typejava.lang.String

        ObjectName

        Returns the ObjectName under which this MBean is registered in the MBean server.

        Deprecated.

               
        Privileges Read only
        Typeweblogic.management.WebLogicObjectName
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        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:

               
        Privileges Read/Write
        Typeint
        Default Value503
        Minimum value100
        Maximum value599

        Parent

        Return the immediate parent for this MBean

               
        Privileges Read/Write
        Type

        PostTimeoutSecs

        Timeout (in seconds) for reading HTTP POST data in a servlet request. If the POST data is chunked, the amount of time the server waits between the end of receiving the last chunk of data and the end of receiving the next chunk of data in an HTTP POST 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

               
        Privileges Read/Write
        Typeint
        Default Value30
        Minimum value0
        Maximum value120
        Secure value30

        Registered

        Returns false if the MBean represented by this object has been unregistered.

        Deprecated.

               
        Privileges Read only
        Typeboolean
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        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.

               
        Privileges Read/Write
        Typeboolean

        SingleSignonDisabled

        Indicates whether the singleSignonDisabled attribute is enabled

               
        Privileges Read/Write
        Typeboolean

        Tags

        Return all tags on this Configuration MBean

               
        Available Since Release 12.2.1.0.0
        Privileges Read/Write
        Typeclass java.lang.String[]

        Type

        Returns the type of the MBean.

               
        Privileges Read only
        Typejava.lang.String
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        URLResource

        Adds a URL connection factory resource into JNDI.

               
        Privileges Read/Write
        Typejava.util.Map

        UseHeaderEncoding

               
        Privileges Read/Write
        Typeboolean

        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.

               
        Privileges Read/Write
        Typeboolean
        Default Valuetrue

        VirtualHostNames

        The list of host names, separated by line breaks, for which this virtual host will serve requests.

               
        Privileges Read/Write
        Typeclass java.lang.String[]

        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:

               
        Privileges Read/Write
        Typeboolean

        WriteChunkBytes

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

        Gets the writeChunkBytes attribute of the WebServerMBean object

               
        Privileges Read only
        Typeint
        Default Value512


        Operations

        This section describes the following operations:


        addTag

        Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

           
        Operation Name"addTag"
        ParametersObject [] {  tag }

        where:

        • tag is an object of type java.lang.String that specifies:

          tag to be added to the MBean

        SignatureString [] { "java.lang.String" }
        Returns boolean
        Exceptions
        • java.lang.IllegalArgumentException
          IllegalArgumentException if the tag contains illegal punctuation

        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.

           
        Operation Name"addTarget"
        ParametersObject [] {  target }

        where:

        • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

          The feature to be added to the Target attribute

        SignatureString [] { "weblogic.management.configuration.TargetMBean" }
        Returns boolean
        Exceptions
        • javax.management.InvalidAttributeValueException
        • weblogic.management.DistributedManagementException

        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

           
        Operation Name"freezeCurrentValue"
        ParametersObject [] {  attributeName }

        where:

        • attributeName is an object of type java.lang.String that specifies:

          attributeName

        SignatureString [] { "java.lang.String" }
        Returns void
        Exceptions
        • javax.management.AttributeNotFoundException
        • javax.management.MBeanException

        getInheritedProperties

        Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

           
        Operation Name"getInheritedProperties"
        ParametersObject [] {  propertyNames }

        where:

        • propertyNames is an object of type [Ljava.lang.String; that specifies:

          properties to check

        SignatureString [] { "[Ljava.lang.String;" }
        Returns class

        isInherited

        Check if the value of a property is inherited from template mbean or not.

           
        Operation Name"isInherited"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          the name of the property

        SignatureString [] { "java.lang.String" }
        Returns boolean

        isSet

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

           
        Operation Name"isSet"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          property to check

        SignatureString [] { "java.lang.String" }
        Returns boolean

        removeTag

        Remove a tag from this Configuration MBean

           
        Operation Name"removeTag"
        ParametersObject [] {  tag }

        where:

        • tag is an object of type java.lang.String that specifies:

          tag to be removed from the MBean

        SignatureString [] { "java.lang.String" }
        Returns boolean
        Exceptions
        • java.lang.IllegalArgumentException
          IllegalArgumentException if the tag contains illegal punctuation

        removeTarget

        Removes the value of the addTarget attribute.

        For more information, see:

           
        Operation Name"removeTarget"
        ParametersObject [] {  target }

        where:

        • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

          target

        SignatureString [] { "weblogic.management.configuration.TargetMBean" }
        Returns boolean
        Exceptions
        • javax.management.InvalidAttributeValueException
        • weblogic.management.DistributedManagementException

        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

           
        Operation Name"restoreDefaultValue"
        ParametersObject [] {  attributeName }

        where:

        • attributeName is an object of type java.lang.String that specifies:

          attributeName

        SignatureString [] { "java.lang.String" }
        Returns void
        Exceptions
        • javax.management.AttributeNotFoundException

        unSet

        Restore the given property to its default value.

           
        Operation Name"unSet"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          property to restore

        SignatureString [] { "java.lang.String" }
        Returns void