WebLogic Server 6.1 API Reference

weblogic.management.configuration
Interface WebServerMBean

All Known Subinterfaces:

VirtualHostMBean

public interface WebServerMBean

extends DeploymentMBean

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

This MBean represents a virtual host.

Author:

Copyright © 2001 BEA Systems, Inc. All Rights Reserved.

Field Summary

static long

CACHING_STUB_SVUID

Fields inherited from class weblogic.management.configuration.DeploymentMBean

DEFAULT_ORDER, MAX_ORDER, MIN_ORDER

Method Summary

java.util.Map	getCharsets()
java.lang.String	getDefaultServerName() Sets the HTTP defaultServerName
WebAppComponentMBean	getDefaultWebApp()
java.lang.String	getFrontendHost() Sets the HTTP frontendHost
int	getFrontendHTTPPort() Sets the frontendHTTPPort
int	getFrontendHTTPSPort() Sets the frontendHTTPSPort
int	getHttpsKeepAliveSecs() Number of seconds to maintain HTTPS keep-alive before timing out the request.
int	getKeepAliveSecs() Number of seconds to maintain HTTP keep-alive before timing out the request.
int	getLogFileBufferKBytes()
int	getLogFileFlushSecs() Frequency (seconds) with which the log file should be flushed
java.lang.String	getLogFileFormat() Defines the format of HTTP log file (common or extended)
java.lang.String	getLogFileName() Specifies the HTTP request log file.
int	getLogRotationPeriodMins() Defines the period in minutes when the access.log will be rotated.
java.lang.String	getLogRotationTimeBegin() Defines the date when the first rotation of access.log will begin.
java.lang.String	getLogRotationType() Defines how the HTTP log file is rotated [size|date].
boolean	getLogTimeInGMT() 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.
int	getMaxLogFileSizeKBytes() Set maximum access logfile size in K before rotation.
int	getMaxPostSize()
int	getMaxPostTimeSecs()
int	getPostTimeoutSecs()
java.util.Map	getURLResource()
int	getWriteChunkBytes()
boolean	isAuthCookieEnabled()
boolean	isChunkedTransferDisabled()
boolean	isClusteringEnabled()
boolean	isDebugEnabled()
boolean	isEventsEnabled()
boolean	isKeepAliveEnabled()
boolean	isLoggingEnabled()
boolean	isSendServerHeaderEnabled()
boolean	isSingleSignonDisabled()
boolean	isUseHeaderEncoding()
boolean	isUseHighestCompatibleHTTPVersion()
boolean	isWAPEnabled()
void	setAuthCookieEnabled(boolean enable) Enables use of additional secure AuthCookie to make access to https pages with security constraints more secure.
void	setCharsets(java.util.Map charsets) User defined mapping between internet and Java charset names
void	setChunkedTransferDisabled(boolean disable) Disables the use of Chunk Transfer-Encoding in HTTP/1.1
void	setClusteringEnabled(boolean enable) Enables HTTP clustering
void	setDefaultServerName(java.lang.String serverName)
void	setDefaultWebApp(WebAppComponentMBean context) Servlet 2.2 Web Application that maps to the "default" servlet context (where ContextPath = "/")
void	setFrontendHost(java.lang.String hostName)
void	setFrontendHTTPPort(int httpPort)
void	setFrontendHTTPSPort(int httpsPort)
void	setHttpsKeepAliveSecs(int secs)
void	setKeepAliveEnabled(boolean enabled) Returns whether or not HTTP keep-alive is enabled
void	setKeepAliveSecs(int secs)
void	setLogFileBufferKBytes(int kbytes) Sets HTTP request log buffer size
void	setLogFileFlushSecs(int secs)
void	setLogFileFormat(java.lang.String format) Set the format of the HTTP log file, i.e.
void	setLogFileName(java.lang.String fileName)
void	setLoggingEnabled(boolean enable) Enables logging of HTTP requests.
void	setLogRotationPeriodMins(int mins)
void	setLogRotationTimeBegin(java.lang.String when)
void	setLogRotationType(java.lang.String type)
void	setLogTimeInGMT(boolean useGMT)
void	setMaxLogFileSizeKBytes(int kbytes)
void	setMaxPostSize(int bytes) Max Post Size (in bytes) for reading HTTP POST data in a servlet request.
void	setMaxPostTimeSecs(int secs) Max Post Time (in seconds) for reading HTTP POST data in a servlet request.
void	setPostTimeoutSecs(int secs) Timeout (in seconds) for reading HTTP POST data in a servlet request.
void	setSendServerHeaderEnabled(boolean enabled) Returns whether or not to send a response Server header
void	setSingleSignonDisabled(boolean disable) Disables SingleSignon in webapps
void	setURLResource(java.util.Map resource) Adds a URL connection factory resource into JNDI
void	setUseHeaderEncoding(boolean disable) Enables use of Content-Type encoding for specific headers that are known to contain non-ISO-8859_1 characters.
void	setUseHighestCompatibleHTTPVersion(boolean disable) Enables use of the highest compatible HTTP protocol version-string in the response.
void	setWAPEnabled(boolean enable) Enables WAP

Methods inherited from interface weblogic.management.configuration.DeploymentMBean

addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

getNotes, setNotes, setPersistenceEnabled

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Field Detail

CACHING_STUB_SVUID

public static final long CACHING_STUB_SVUID

Method Detail

setLoggingEnabled

public void setLoggingEnabled(boolean enable)

Enables logging of HTTP requests.

A configurable MBean attribute

Default Value: true

Old Property: weblogic.httpd.enableLogFile

isLoggingEnabled

public boolean isLoggingEnabled()

getLogFileFormat

public java.lang.String getLogFileFormat()

Defines the format of HTTP log file (common or extended)

A configurable MBean attribute

Default Value: "common"

Old Property: weblogic.httpd.logFileFormat

Legal Values: "common","extended"

setLogFileFormat

public void setLogFileFormat(java.lang.String format)
                      throws javax.management.InvalidAttributeValueException,
                             DistributedManagementException

Set the format of the HTTP log file, i.e. common or extended.

getLogTimeInGMT

public boolean getLogTimeInGMT()

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.

A configurable MBean attribute

Default Value: false

setLogTimeInGMT

public void setLogTimeInGMT(boolean useGMT)

getLogFileName

public java.lang.String getLogFileName()

Specifies the HTTP request log file.

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.

A configurable MBean attribute

Default Value: "access.log"

Old Property: weblogic.httpd.logFileName

setLogFileName

public void setLogFileName(java.lang.String fileName)
                    throws javax.management.InvalidAttributeValueException

getFrontendHost

public java.lang.String getFrontendHost()

Sets the HTTP frontendHost

A configurable MBean attribute

Default Value: null

Old Property: weblogic.httpd.defaultServerName

setFrontendHost

public void setFrontendHost(java.lang.String hostName)
                     throws javax.management.InvalidAttributeValueException

getFrontendHTTPPort

public int getFrontendHTTPPort()

Sets the frontendHTTPPort

A configurable MBean attribute

Default Value: 0

setFrontendHTTPPort

public void setFrontendHTTPPort(int httpPort)
                         throws javax.management.InvalidAttributeValueException

getFrontendHTTPSPort

public int getFrontendHTTPSPort()

Sets the frontendHTTPSPort

A configurable MBean attribute

Default Value: 0

setFrontendHTTPSPort

public void setFrontendHTTPSPort(int httpsPort)
                          throws javax.management.InvalidAttributeValueException

setLogFileBufferKBytes

public void setLogFileBufferKBytes(int kbytes)
                            throws javax.management.InvalidAttributeValueException

Sets HTTP request log buffer size

A configurable MBean attribute

Default Value: 8

Old Property: weblogic.httpd.logFileBufferKBytes

Legal Minimum Value: 0

Legal Maximum Value: 1024

getLogFileBufferKBytes

public int getLogFileBufferKBytes()

getMaxLogFileSizeKBytes

public int getMaxLogFileSizeKBytes()

Set maximum access logfile size in K before rotation. 0 means no limit.

A configurable MBean attribute

Default Value: 0

Old Property: weblogic.httpd.maxLogFileSizeKBytes

Legal Minimum Value: 0

setMaxLogFileSizeKBytes

public void setMaxLogFileSizeKBytes(int kbytes)
                             throws javax.management.InvalidAttributeValueException

getLogRotationType

public java.lang.String getLogRotationType()

Defines how the HTTP log file is rotated [size|date].

A configurable MBean attribute

Default Value: "size"

Old Property: weblogic.httpd.logRotationType

Legal Values: "size","date"

setLogRotationType

public void setLogRotationType(java.lang.String type)
                        throws javax.management.InvalidAttributeValueException

getLogRotationPeriodMins

public int getLogRotationPeriodMins()

Defines the period in minutes when the access.log will be rotated.

A configurable MBean attribute

Default Value: 1440

Old Property: weblogic.httpd.logRotationPeriodMins

Legal Minimum Value: 1

Legal Maximum Value: 2147483647

setLogRotationPeriodMins

public void setLogRotationPeriodMins(int mins)
                              throws javax.management.InvalidAttributeValueException

getLogFileFlushSecs

public int getLogFileFlushSecs()

Frequency (seconds) with which the log file should be flushed

A configurable MBean attribute

Default Value: 60

Old Property: weblogic.httpd.logFileFlushSecs

Legal Minimum Value: 1

Legal Maximum Value: 360

setLogFileFlushSecs

public void setLogFileFlushSecs(int secs)
                         throws javax.management.InvalidAttributeValueException

getLogRotationTimeBegin

public java.lang.String getLogRotationTimeBegin()

Defines the date when the first rotation of access.log will begin. The format follows java.text.SimpleDateFormat, MM-dd-yyyy-k:mm:ss See the javadocs for more details. For example: 11-24-2000-12:30:00 Note: If not set next rotation is the next log period. If the date has already past, then the DAY_OF_WEEK, HOUR_OF_DAY, MINUTE and SECOND are used with the current date to recalculate. Only valid with date based rotation. See: setLogRotationType().

A configurable MBean attribute

Old Property: weblogic.httpd.logRotationPeriodMins

setLogRotationTimeBegin

public void setLogRotationTimeBegin(java.lang.String when)
                             throws javax.management.InvalidAttributeValueException

setKeepAliveEnabled

public void setKeepAliveEnabled(boolean enabled)

Returns whether or not HTTP keep-alive is enabled

Default Value: true

Old Property: weblogic.httpd.keepAlive.enable

isKeepAliveEnabled

public boolean isKeepAliveEnabled()

getKeepAliveSecs

public int getKeepAliveSecs()

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

Default Value: 30

Old Property: weblogic.httpd.http.keepAliveSecs

Legal Minimum Value: 5

Legal Maximum Value: 120

setKeepAliveSecs

public void setKeepAliveSecs(int secs)
                      throws javax.management.InvalidAttributeValueException

getHttpsKeepAliveSecs

public int getHttpsKeepAliveSecs()

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

Default Value: 60

Old Property: weblogic.httpd.https.keepAliveSecs

Legal Minimum Value: 30

Legal Maximum Value: 360

setHttpsKeepAliveSecs

public void setHttpsKeepAliveSecs(int secs)
                           throws javax.management.InvalidAttributeValueException

setPostTimeoutSecs

public void setPostTimeoutSecs(int secs)
                        throws javax.management.InvalidAttributeValueException

Timeout (in seconds) for reading HTTP POST data in a servlet request.

Default Value: 30

Old Property: weblogic.httpd.postTimeoutSecs

Legal Minimum Value: 0

Legal Maximum Value: 120

getPostTimeoutSecs

public int getPostTimeoutSecs()

setMaxPostTimeSecs

public void setMaxPostTimeSecs(int secs)
                        throws javax.management.InvalidAttributeValueException

Max Post Time (in seconds) for reading HTTP POST data in a servlet request.

Default Value: -1 MaxPostTime < 0 means unlimited

getMaxPostTimeSecs

public int getMaxPostTimeSecs()

setMaxPostSize

public void setMaxPostSize(int bytes)
                    throws javax.management.InvalidAttributeValueException

Max Post Size (in bytes) for reading HTTP POST data in a servlet request.

Default Value: -1 MaxPostSize < 0 means unlimited

getMaxPostSize

public int getMaxPostSize()

setSendServerHeaderEnabled

public void setSendServerHeaderEnabled(boolean enabled)

Returns whether or not to send a response Server header

Default Value: false

isSendServerHeaderEnabled

public boolean isSendServerHeaderEnabled()

setDefaultWebApp

public void setDefaultWebApp(WebAppComponentMBean context)

Servlet 2.2 Web Application that maps to the "default" servlet context (where ContextPath = "/")

Default Value: null

Old Property: weblogic.httpd.defaultWebApp

getDefaultWebApp

public WebAppComponentMBean getDefaultWebApp()

setCharsets

public void setCharsets(java.util.Map charsets)
                 throws javax.management.InvalidAttributeValueException

User defined mapping between internet and Java charset names

Default Value: null

Old Property: weblogic.httpd.charsets

getCharsets

public java.util.Map getCharsets()

setURLResource

public void setURLResource(java.util.Map resource)
                    throws javax.management.InvalidAttributeValueException

Adds a URL connection factory resource into JNDI

Default Value: null

Old Property: weblogic.httpd.URLResource

getURLResource

public java.util.Map getURLResource()

setChunkedTransferDisabled

public void setChunkedTransferDisabled(boolean disable)

Disables the use of Chunk Transfer-Encoding in HTTP/1.1

A configurable MBean attribute

Default Value: false

isChunkedTransferDisabled

public boolean isChunkedTransferDisabled()

setUseHighestCompatibleHTTPVersion

public void setUseHighestCompatibleHTTPVersion(boolean disable)

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.

A configurable MBean attribute

Default Value: false

isUseHighestCompatibleHTTPVersion

public boolean isUseHighestCompatibleHTTPVersion()

setUseHeaderEncoding

public void setUseHeaderEncoding(boolean disable)

Enables use of Content-Type encoding for specific headers that are known to contain non-ISO-8859_1 characters.

A configurable MBean attribute

Default Value: false

isUseHeaderEncoding

public boolean isUseHeaderEncoding()

setAuthCookieEnabled

public void setAuthCookieEnabled(boolean enable)

Enables use of additional secure AuthCookie to make access to https pages with security constraints more secure. The session cookie will not be sufficient to gain access.

A configurable MBean attribute

Default Value: false

isAuthCookieEnabled

public boolean isAuthCookieEnabled()

getWriteChunkBytes

public int getWriteChunkBytes()

isDebugEnabled

public boolean isDebugEnabled()

isEventsEnabled

public boolean isEventsEnabled()

setWAPEnabled

public void setWAPEnabled(boolean enable)

Enables WAP

Default Value: false

isWAPEnabled

public boolean isWAPEnabled()

setSingleSignonDisabled

public void setSingleSignonDisabled(boolean disable)

Disables SingleSignon in webapps

Default Value: false

isSingleSignonDisabled

public boolean isSingleSignonDisabled()

setClusteringEnabled

public void setClusteringEnabled(boolean enable)

Enables HTTP clustering

Default Value: false

Old Property: weblogic.httpd.clustering.enable

isClusteringEnabled

public boolean isClusteringEnabled()

getDefaultServerName

public java.lang.String getDefaultServerName()

Sets the HTTP defaultServerName

A configurable MBean attribute

Default Value: null

Old Property: weblogic.httpd.defaultServerName

setDefaultServerName

public void setDefaultServerName(java.lang.String serverName)
                          throws javax.management.InvalidAttributeValueException