WebAppComponentMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Provides methods for configuring a J2EE web application that is deployed on a WebLogic Server instance. WebLogic Server instantiates this interface only when you deploy a web application.

This interface can configure web applications that are deployed as a WAR file or an exploded directory.

Deprecated. 9.0.0.0 in favor of AppDeploymentMBean

               
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
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.WebAppComponentMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can 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:
      Subtypes The following MBeans extend or implement this MBean type:
        Deprecated Factory Methods and Access Points


          Related MBeans

          This section describes attributes that provide access to other MBeans.


          ActivatedTargets

          List of servers and clusters where this module is currently active. This attribute is valid only for modules deployed via the two phase protocol. Modules deployed with the WLS 6.x deployment protocol do not maintain this attribute. To determine active targets for a module regardless of deployment protocol, use DeployerRuntimeMBean#lookupActiveTargetsForComponent .

          For more information, see:

                 
          Privileges Read only
          TypeTargetMBean[]
          Relationship type: Reference.

          Application

          The application this component is a part of. This is guaranteed to never be null.

                 
          Privileges Read/Write
          TypeApplicationMBean
          Relationship type: Reference.
          Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

          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.

          VirtualHosts

          Provides a means to target your deployments to specific virtual hosts.

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

          WebServers

          Returns a list of the targets on which this deployment is deployed.

          Deprecated. 7.0.0.0 This attribute is being replaced by VirtualHosts attribute. To target an actual web server, the ComponentMBean.Targets attribute should be used.

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


          Attributes

          This section describes the following attributes:


          AuthFilter

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

          Deprecated. 8.0.0.0 Use weblogic.xml.

                 
          Privileges Read/Write
          Typejava.lang.String

          AuthRealmName

          Provides the name of the Realm in the Basic Authentication HTTP dialog box, which pops up on the browsers. authRealmName is now set in weblogic.xml.

          Deprecated. 8.1.0.0 Use weblogic.xml.

                 
          Privileges Read/Write
          Typejava.lang.String
          Default Valueweblogic

          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.

          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

          IndexDirectoryEnabled

          Specifies whether the target should automatically generate an HTML directory listing if no suitable index file is found.

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

          Deprecated. 8.1.0.0 Use weblogic.xml or update using console.

                 
          Privileges Read/Write
          Typeboolean

          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

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

          Parent

          Return the immediate parent for this MBean

                 
          Privileges Read/Write
          Type

          PreferWebInfClasses

          Specifies whether classes loaded in the WEB-INF directory will be loaded in preference to classes loaded in the application or system calssloader.

          Deprecated the setting from console beginning with version 8.1. You must now set this in weblogic.xml.

          Deprecated. 8.0.0.0 Use weblogic.xml.

                 
          Privileges Read/Write
          Typeboolean

          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.

          ServletExtensionCaseSensitive

          Indicates whether servlet extensions should be treated as though they are lower case even if they are written in upper case.

          If True, the server treats all .extensions except .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.

          Deprecated.

                 
          Privileges Read/Write
          Typeboolean

          ServletReloadCheckSecs

          The amount of time (in seconds) that WebLogic Server waits to check if a servlet was modified and needs to be reloaded.

          How often WebLogic checks whether a servlet has been modified, and if so reloads it. When the value is set to -1, the servlet is never reloaded, and when the vlue is set to 0, the servlet is reloaded after each check.

          Deprecated. 8.1.0.0 Use weblogic.xml or update using console.

                 
          Privileges Read/Write
          Typeint
          Default Value1

          SessionMonitoringEnabled

          Specifies whether runtime MBeans will be created for session monitoring.

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

          Deprecated. 8.0.0.0 Use weblogic.xml or update using console.

                 
          Privileges Read/Write
          Typeboolean

          SingleThreadedServletPoolSize

          This provides size of the pool used for single threaded mode servlets. It

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

          Deprecated. 8.1.0.0 Use weblogic.xml or update using console.

                 
          Privileges Read/Write
          Typeint
          Default Value5

          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.

          URI

          A URI that points to the application module, usually on the Administration Server.

          URI can only be set if this is a standalone component; the URI for an application is defined in the application's deployment descriptor.

          *

                 
          Privileges Read/Write
          Typejava.lang.String


          Operations

          This section describes the following operations:


          activated

          Indicates whether component has been activated on a server

             
          Operation Name"activated"
          ParametersObject [] {  target }

          where:

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

            target

          SignatureString [] { "weblogic.management.configuration.TargetMBean" }
          Returns boolean

          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

          addVirtualHost

          Used to add a virtual host to the list of virtual hosts to which deployments may be targeted.

             
          Operation Name"addVirtualHost"
          ParametersObject [] {  target }

          where:

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

            The feature to be added to the VirtualHost attribute

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

          addWebServer

          This adds a target to the list of web servers to which a deployment may be targeted.

          Deprecated. 7.0.0.0 This attribute is being replaced by VirtualHosts attribute

             
          Operation Name"addWebServer"
          ParametersObject [] {  target }

          where:

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

            The feature to be added to the WebServer attribute

          SignatureString [] { "weblogic.management.configuration.WebServerMBean" }
          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

          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

          refreshDDsIfNeeded

             
          Operation Name"refreshDDsIfNeeded"
          ParametersObject [] {   }

          where:

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

            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

            removeVirtualHost

            Used to remove a virtual host from the list of virtual hosts to which deployments may be targeted.

               
            Operation Name"removeVirtualHost"
            ParametersObject [] {  target }

            where:

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

              target

            SignatureString [] { "weblogic.management.configuration.VirtualHostMBean" }
            Returns boolean
            Exceptions
            • weblogic.management.DistributedManagementException

            removeWebServer

            This removes a target from the list of web servers which may be targeted for deployments.

            Deprecated. 7.0.0.0 This attribute is being replaced by VirtualHosts attribute

               
            Operation Name"removeWebServer"
            ParametersObject [] {  target }

            where:

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

              target

            SignatureString [] { "weblogic.management.configuration.WebServerMBean" }
            Returns boolean
            Exceptions
            • 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