WebLogic Server 8.1 API Reference

weblogic.management.configuration
Interface WebAppComponentMBean

All Known Subinterfaces:

WebServiceComponentMBean

public interface WebAppComponentMBean

extends ComponentMBean, WebDeploymentMBean

Description of the Interface

Author:

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

Fields inherited from class weblogic.management.configuration.ComponentMBean

CACHING_STUB_SVUID

Fields inherited from class weblogic.management.configuration.WebDeploymentMBean

CACHING_STUB_SVUID

Fields inherited from class weblogic.management.configuration.DeploymentMBean

CACHING_STUB_SVUID, DEFAULT_ORDER, MAX_ORDER, MIN_ORDER

Fields inherited from class weblogic.management.configuration.ConfigurationMBean

CACHING_STUB_SVUID

Fields inherited from class weblogic.management.configuration.DeploymentMBean

CACHING_STUB_SVUID, DEFAULT_ORDER, MAX_ORDER, MIN_ORDER

Fields inherited from class weblogic.management.configuration.ConfigurationMBean

CACHING_STUB_SVUID

Method Summary

java.lang.String	getAuthFilter() Sets the AuthFilter Servlet class, which will be called before and after all authentication and authorization checks in the Web Application.
java.lang.String	getAuthRealmName() Sets the Realm in the Basic Authentication HTTP dialog box, which pops up on the browsers.
int	getServletReloadCheckSecs() How often WebLogic checks whether a servlet has been modified, and if so reloads it.
int	getSingleThreadedServletPoolSize() Defines the size of the pool used for SingleThreadedModel instance pools.
boolean	isCleanupSessionFilesEnabled() Gets the cleanupSessionFilesEnabled attribute of the WebAppComponentMBean object.
boolean	isIndexDirectoryEnabled() Indicates whether or not to automatically generate an HTML directory listing if no suitable index file is found.
boolean	isPreferWebInfClasses() If true, classes located in the WEB-INF directory of a web-app will be loaded in preference to classes loaded in the application or system classloader.
boolean	isServletExtensionCaseSensitive() Treats all .extension except for .html as lower case.
boolean	isSessionDebuggable() Gets the sessionDebuggable attribute of the WebAppComponentMBean object
boolean	isSessionMonitoringEnabled() If true, then runtime MBeans will be created for sessions; otherwise, they will not.
void	setAuthFilter(java.lang.String name) Sets the authFilter attribute of the WebAppComponentMBean object.
void	setAuthRealmName(java.lang.String name) Sets the authRealmName attribute of the WebAppComponentMBean object.
void	setContextPath(java.lang.String p) Sets the contextPath attribute of the WebAppComponentMBean object.
void	setDebugEnabled(boolean deb) Sets the debugEnabled attribute of the WebAppComponentMBean object.
void	setDefaultServlet(java.lang.String svlt) Sets the defaultServlet attribute of the WebAppComponentMBean object.
void	setDocumentRoot(java.lang.String directory) Sets the documentRoot attribute of the WebAppComponentMBean object.
void	setIndexDirectoryEnabled(boolean enable) Sets the indexDirectoryEnabled attribute of the WebAppComponentMBean object.
void	setIndexFiles(java.lang.String[] files) Sets the indexFiles attribute of the WebAppComponentMBean object.
void	setMimeTypeDefault(java.lang.String type) Sets the mimeTypeDefault attribute of the WebAppComponentMBean object.
void	setMimeTypes(java.util.Map types) Sets the mimeTypes attribute of the WebAppComponentMBean object.
void	setPreferWebInfClasses(boolean b) Sets the preferWebInfClasses attribute of the WebAppComponentMBean object
void	setServletClasspath(java.lang.String classPath) Sets the servletClasspath attribute of the WebAppComponentMBean object.
void	setServletExtensionCaseSensitive(boolean enable) Sets the servletExtensionCaseSensitive attribute of the WebAppComponentMBean object.
void	setServletReloadCheckSecs(int secs) Sets the servletReloadCheckSecs attribute of the WebAppComponentMBean object.
void	setSessionCacheSize(int size) Sets the sessionCacheSize attribute of the WebAppComponentMBean object.
void	setSessionCookieComment(java.lang.String comment) Sets the sessionCookieComment attribute of the WebAppComponentMBean object.
void	setSessionCookieDomain(java.lang.String domain) Sets the sessionCookieDomain attribute of the WebAppComponentMBean object.
void	setSessionCookieMaxAgeSecs(int secs) Sets the sessionCookieMaxAgeSecs attribute of the WebAppComponentMBean object.
void	setSessionCookieName(java.lang.String name) Sets the sessionCookieName attribute of the WebAppComponentMBean object.
void	setSessionCookiePath(java.lang.String path) Sets the sessionCookiePath attribute of the WebAppComponentMBean object.
void	setSessionCookiesEnabled(boolean enable) Sets the sessionCookiesEnabled attribute of the WebAppComponentMBean object.
void	setSessionIDLength(int len) Sets the sessionIDLength attribute of the WebAppComponentMBean object.
void	setSessionInvalidationIntervalSecs(int secs) Sets the sessionInvalidationIntervalSecs attribute of the WebAppComponentMBean object.
void	setSessionJDBCConnectionTimeoutSecs(int secs) Sets the sessionJDBCConnectionTimeoutSecs attribute of the WebAppComponentMBean object.
void	setSessionMainAttribute(java.lang.String p) Sets the sessionMainAttribute attribute of the WebAppComponentMBean object.
void	setSessionMonitoringEnabled(boolean e) Sets the sessionMonitoringEnabled attribute of the WebAppComponentMBean object.
void	setSessionPersistentStoreCookieName(java.lang.String name) Sets the sessionPersistentStoreCookieName attribute of the WebAppComponentMBean object
void	setSessionPersistentStoreDir(java.lang.String dir) Sets the sessionPersistentStoreDir attribute of the WebAppComponentMBean object.
void	setSessionPersistentStorePool(java.lang.String poolName) Sets the sessionPersistentStorePool attribute of the WebAppComponentMBean object.
void	setSessionPersistentStoreShared(boolean enable) Sets the sessionPersistentStoreShared attribute of the WebAppComponentMBean object
void	setSessionPersistentStoreTable(java.lang.String tableName) Sets the sessionPersistentStoreTable attribute of the WebAppComponentMBean object
void	setSessionPersistentStoreType(java.lang.String type) Sets the sessionPersistentStoreType attribute of the WebAppComponentMBean object
void	setSessionSwapIntervalSecs(int secs) Sets the sessionSwapIntervalSecs attribute of the WebAppComponentMBean object
void	setSessionTimeoutSecs(int secs) Sets the sessionTimeoutSecs attribute of the WebAppComponentMBean object.
void	setSessionTrackingEnabled(boolean enable) Sets the sessionTrackingEnabled attribute of the WebAppComponentMBean object.
void	setSessionURLRewritingEnabled(boolean enable) Sets the sessionURLRewritingEnabled attribute of the WebAppComponentMBean object.
void	setSingleThreadedServletPoolSize(int siz) Sets the singleThreadedServletPoolSize attribute of the WebAppComponentMBean object.

Methods inherited from interface weblogic.management.configuration.ComponentMBean

activated, getActivatedTargets, getApplication, getDDEditingDisabledReason, getURI, isDDEditingEnabled, refreshDDsIfNeeded, setApplication, setURI

Methods inherited from interface weblogic.management.configuration.WebDeploymentMBean

addVirtualHost, addWebServer, getVirtualHosts, getWebServers, removeVirtualHost, removeWebServer, setVirtualHosts, setWebServers

Method Detail

setSessionCookieMaxAgeSecs

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

Sets the sessionCookieMaxAgeSecs attribute of the WebAppComponentMBean object.

Parameters:

secs - The new sessionCookieMaxAgeSecs value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionInvalidationIntervalSecs

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

Sets the sessionInvalidationIntervalSecs attribute of the WebAppComponentMBean object.

Parameters:

secs - The new sessionInvalidationIntervalSecs value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionJDBCConnectionTimeoutSecs

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

Sets the sessionJDBCConnectionTimeoutSecs attribute of the WebAppComponentMBean object.

Parameters:

secs - The new sessionJDBCConnectionTimeoutSecs value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionTimeoutSecs

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

Sets the sessionTimeoutSecs attribute of the WebAppComponentMBean object.

Parameters:

secs - The new sessionTimeoutSecs value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setMimeTypeDefault

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

Sets the mimeTypeDefault attribute of the WebAppComponentMBean object.

Parameters:

type - The new mimeTypeDefault value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setMimeTypes

public void setMimeTypes(java.util.Map types)
                  throws javax.management.InvalidAttributeValueException

Sets the mimeTypes attribute of the WebAppComponentMBean object.

Parameters:

types - The new mimeTypes value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setDocumentRoot

public void setDocumentRoot(java.lang.String directory)
                     throws javax.management.InvalidAttributeValueException

Sets the documentRoot attribute of the WebAppComponentMBean object.

Parameters:

directory - The new documentRoot value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setDefaultServlet

public void setDefaultServlet(java.lang.String svlt)
                       throws javax.management.InvalidAttributeValueException

Sets the defaultServlet attribute of the WebAppComponentMBean object.

Parameters:

svlt - The new defaultServlet value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

isIndexDirectoryEnabled

public boolean isIndexDirectoryEnabled()

Indicates whether or not to automatically generate an HTML directory listing if no suitable index file is found.

Default Value: false

Old Property: weblogic.httpd.indexDirectories

Returns:

The indexDirectoryEnabled value

setIndexDirectoryEnabled

public void setIndexDirectoryEnabled(boolean enable)

Sets the indexDirectoryEnabled attribute of the WebAppComponentMBean object.

Parameters:

enable - The new indexDirectoryEnabled value

setIndexFiles

public void setIndexFiles(java.lang.String[] files)
                   throws javax.management.InvalidAttributeValueException

Sets the indexFiles attribute of the WebAppComponentMBean object.

Parameters:

files - The new indexFiles value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setServletClasspath

public void setServletClasspath(java.lang.String classPath)
                         throws javax.management.InvalidAttributeValueException

Sets the servletClasspath attribute of the WebAppComponentMBean object.

Parameters:

classPath - The new servletClasspath value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

isServletExtensionCaseSensitive

public boolean isServletExtensionCaseSensitive()

Treats all .extension except for .html as lower case. This is only necessary on WindowsNT. This property is being deprecated. The extension comparision will be case insensitive by default on Win32.

A non-configurable MBean attribute.

Default Value: false

Old Property: weblogic.httpd.servlet.extensionCaseSensitive

Returns:

The servletExtensionCaseSensitive value

setServletExtensionCaseSensitive

public void setServletExtensionCaseSensitive(boolean enable)

Sets the servletExtensionCaseSensitive attribute of the WebAppComponentMBean object.

Parameters:

enable - The new servletExtensionCaseSensitive value

getServletReloadCheckSecs

public int getServletReloadCheckSecs()

How often WebLogic checks whether a servlet has been modified, and if so reloads it. -1 is never reload, 0 is always reload.

Default Value: 1

Old Property: weblogic.httpd.servlet.reloadCheckSecs

Returns:

The servletReloadCheckSecs value

setServletReloadCheckSecs

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

Sets the servletReloadCheckSecs attribute of the WebAppComponentMBean object.

Parameters:

secs - The new servletReloadCheckSecs value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getSingleThreadedServletPoolSize

public int getSingleThreadedServletPoolSize()

Defines the size of the pool used for SingleThreadedModel instance pools.

Default Value: 5

Old Property: weblogic.httpd.servlet.SingleThreadedModelPoolSize

Returns:

The singleThreadedServletPoolSize value

setSingleThreadedServletPoolSize

public void setSingleThreadedServletPoolSize(int siz)
                                      throws javax.management.InvalidAttributeValueException

Sets the singleThreadedServletPoolSize attribute of the WebAppComponentMBean object.

Parameters:

siz - The new singleThreadedServletPoolSize value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getAuthRealmName

public java.lang.String getAuthRealmName()

Sets the Realm in the Basic Authentication HTTP dialog box, which pops up on the browsers.

Default Value: "weblogic"

Old Property: weblogic.httpd.authRealmName

Returns:

The authRealmName value

setAuthRealmName

public void setAuthRealmName(java.lang.String name)
                      throws javax.management.InvalidAttributeValueException

Sets the authRealmName attribute of the WebAppComponentMBean object.

Parameters:

name - The new authRealmName value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getAuthFilter

public java.lang.String getAuthFilter()

Sets the AuthFilter Servlet class, which will be called before and after all authentication and authorization checks in the Web Application.

Default Value: null

Returns:

The authFilter value

setAuthFilter

public void setAuthFilter(java.lang.String name)

Sets the authFilter attribute of the WebAppComponentMBean object.

Parameters:

name - The new authFilter value

setDebugEnabled

public void setDebugEnabled(boolean deb)

Sets the debugEnabled attribute of the WebAppComponentMBean object.

Parameters:

deb - The new debugEnabled value

setSessionURLRewritingEnabled

public void setSessionURLRewritingEnabled(boolean enable)

Sets the sessionURLRewritingEnabled attribute of the WebAppComponentMBean object.

Parameters:

enable - The new sessionURLRewritingEnabled value

setSessionIDLength

public void setSessionIDLength(int len)
                        throws javax.management.InvalidAttributeValueException

Sets the sessionIDLength attribute of the WebAppComponentMBean object.

Parameters:

len - The new sessionIDLength value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionCacheSize

public void setSessionCacheSize(int size)
                         throws javax.management.InvalidAttributeValueException

Sets the sessionCacheSize attribute of the WebAppComponentMBean object.

Parameters:

size - The new sessionCacheSize value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionCookiesEnabled

public void setSessionCookiesEnabled(boolean enable)

Sets the sessionCookiesEnabled attribute of the WebAppComponentMBean object.

Parameters:

enable - The new sessionCookiesEnabled value

setSessionTrackingEnabled

public void setSessionTrackingEnabled(boolean enable)

Sets the sessionTrackingEnabled attribute of the WebAppComponentMBean object.

Parameters:

enable - The new sessionTrackingEnabled value

setSessionCookieComment

public void setSessionCookieComment(java.lang.String comment)
                             throws javax.management.InvalidAttributeValueException

Sets the sessionCookieComment attribute of the WebAppComponentMBean object.

Parameters:

comment - The new sessionCookieComment value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionCookieDomain

public void setSessionCookieDomain(java.lang.String domain)
                            throws javax.management.InvalidAttributeValueException

Sets the sessionCookieDomain attribute of the WebAppComponentMBean object.

Parameters:

domain - The new sessionCookieDomain value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionCookieName

public void setSessionCookieName(java.lang.String name)
                          throws javax.management.InvalidAttributeValueException

Sets the sessionCookieName attribute of the WebAppComponentMBean object.

Parameters:

name - The new sessionCookieName value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionCookiePath

public void setSessionCookiePath(java.lang.String path)
                          throws javax.management.InvalidAttributeValueException

Sets the sessionCookiePath attribute of the WebAppComponentMBean object.

Parameters:

path - The new sessionCookiePath value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionPersistentStoreDir

public void setSessionPersistentStoreDir(java.lang.String dir)
                                  throws javax.management.InvalidAttributeValueException

Sets the sessionPersistentStoreDir attribute of the WebAppComponentMBean object.

Parameters:

dir - The new sessionPersistentStoreDir value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionPersistentStorePool

public void setSessionPersistentStorePool(java.lang.String poolName)
                                   throws javax.management.InvalidAttributeValueException

Sets the sessionPersistentStorePool attribute of the WebAppComponentMBean object.

Parameters:

poolName - The new sessionPersistentStorePool value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionPersistentStoreTable

public void setSessionPersistentStoreTable(java.lang.String tableName)
                                    throws javax.management.InvalidAttributeValueException

Sets the sessionPersistentStoreTable attribute of the WebAppComponentMBean object

Parameters:

tableName - The new sessionPersistentStoreTable value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionPersistentStoreShared

public void setSessionPersistentStoreShared(boolean enable)

Sets the sessionPersistentStoreShared attribute of the WebAppComponentMBean object

Parameters:

enable - The new sessionPersistentStoreShared value

setSessionPersistentStoreType

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

Sets the sessionPersistentStoreType attribute of the WebAppComponentMBean object

Parameters:

type - The new sessionPersistentStoreType value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionPersistentStoreCookieName

public void setSessionPersistentStoreCookieName(java.lang.String name)
                                         throws javax.management.InvalidAttributeValueException

Sets the sessionPersistentStoreCookieName attribute of the WebAppComponentMBean object

Parameters:

name - The new sessionPersistentStoreCookieName value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

setSessionSwapIntervalSecs

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

Sets the sessionSwapIntervalSecs attribute of the WebAppComponentMBean object

Parameters:

secs - The new sessionSwapIntervalSecs value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

isSessionDebuggable

public boolean isSessionDebuggable()

Gets the sessionDebuggable attribute of the WebAppComponentMBean object

Returns:

The sessionDebuggable value

isCleanupSessionFilesEnabled

public boolean isCleanupSessionFilesEnabled()

Gets the cleanupSessionFilesEnabled attribute of the WebAppComponentMBean object.

Returns:

The cleanupSessionFilesEnabled value

setContextPath

public void setContextPath(java.lang.String p)
                    throws javax.management.InvalidAttributeValueException,
                           DistributedManagementException

Sets the contextPath attribute of the WebAppComponentMBean object.

Parameters:

p - The new contextPath value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

DistributedManagementException - Description of the Exception

setSessionMainAttribute

public void setSessionMainAttribute(java.lang.String p)
                             throws javax.management.InvalidAttributeValueException

Sets the sessionMainAttribute attribute of the WebAppComponentMBean object.

Parameters:

p - The new sessionMainAttribute value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

isSessionMonitoringEnabled

public boolean isSessionMonitoringEnabled()

If true, then runtime MBeans will be created for sessions; otherwise, they will not.

Default Value: false

Returns:

The sessionMonitoringEnabled value

setSessionMonitoringEnabled

public void setSessionMonitoringEnabled(boolean e)
                                 throws javax.management.InvalidAttributeValueException

Sets the sessionMonitoringEnabled attribute of the WebAppComponentMBean object.

Parameters:

e - The new sessionMonitoringEnabled value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

isPreferWebInfClasses

public boolean isPreferWebInfClasses()

If true, classes located in the WEB-INF directory of a web-app will be loaded in preference to classes loaded in the application or system classloader. Deprecated the setting from console starting from WLS7.1. Need to set it in weblogic.xml instead.

Default Value: false

Returns:

The preferWebInfClasses value

setPreferWebInfClasses

public void setPreferWebInfClasses(boolean b)

Sets the preferWebInfClasses attribute of the WebAppComponentMBean object

Parameters:

b - The new preferWebInfClasses value