AppDeploymentMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean is used to configure all physical package types which can be deployed on a weblogic domain. For instance, EARs, standalone J2EE and non-J2EE modules.

               
Since9.0.0.0
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.AppDeploymentMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:
    Subtypes The following MBeans extend or implement this MBean type:


      Related MBeans

      This section describes attributes that provide access to other MBeans.


        SubDeployments

        Targeting for subcomponents that differs from targeting for the component.

                   
        Factory MethodscreateSubDeployment (java.lang.String name)

        destroySubDeployment (SubDeploymentMBean subDeployment)

        Factory methods do not return objects.

        See Using factory methods.

        Lookup OperationlookupSubDeployment(String name)

        Returns a javax.management.ObjectName for the instance of SubDeploymentMBean named name.

        Privileges Read only
        TypeSubDeploymentMBean[]
        Relationship type: Containment.

        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.


        Attributes

        This section describes the following attributes:


        AbsoluteInstallDir

        The fully resolved location of this application's installation root directory on the admin server.

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

        AbsolutePlanDir

        The fully resolved location of this application's deployment plan directory on the admin server.

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

        AbsolutePlanPath

        The fully resolved location of this application's deployment plan on the admin server.

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

        AbsoluteSourcePath

        The fully resolved location of this application's source files on the admin server.

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

        ApplicationIdentifier

        The Application Identifier of the application version uniquely identifies the application version across all versions of all applications. If the application is not versioned, the Application Identifier is the same as the application name.

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

        ApplicationName

        The name of the application.

        Note that the name of the current MBean is not the name of the application.

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

        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.

        CompatibilityName

        This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean.

        Standalone modules in 8.1 have both an ApplicationMBean name and ComponentMBean name. This attribute stores the name of the latter, to be used when the server creates the transient ComponentMBean for backward compatibility.

               
        Privileges Read/Write
        Typejava.lang.String

        DeploymentOrder

        An integer value that indicates when this unit is deployed, relative to other deployable units on a server, during startup.

        Units with lower values are deployed before those with higher values.

               
        Privileges Read/Write
        Typeint
        Default Value100

        DeploymentPrincipalName

        A string value that indicates what principal should be used when deploying the file or archive during startup and shutdown. This principal will be used to set the current subject when calling out into application code for interfaces such as ApplicationLifecycleListener. If no principal name is specifed, then the anonymous principal will be used.

               
        Privileges Read/Write
        Typejava.lang.String

        InstallDir

        The path to application's install-root directory, relative to the domain/config/deployments directory.

        When the Install Directory is specified, SourcePath, PlanDir, and PlanPath are derived from this path, and need not be specified.

        Default value for this is the name of the deployment.

        For more information, see:

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

        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.

        ModuleType

        The values match those defined by jsr88. This attribute may move to another MBean.

               
        Privileges Read/Write
        Typejava.lang.String

        Name

        Unique identifier for this bean instance.

               
        Privileges Read/Write
        Typejava.lang.String

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

        PlanDir

        The location of this application's configuration area. This directory can contain external descriptor files as specified within the deployment plan document.

        Rules:

        Use AbsolutePlanDir to get a fully resolved value.

        For more information, see:

               
        Privileges Read only
        Typejava.lang.String

        PlanPath

        The path to the deployment plan document on Administration Server.

        Rules:

        Use AbsolutePlanPath to get a fully resolved value.

        If there is no plan, this returns no plan specified.

        For more information, see:

               
        Privileges Read only
        Typejava.lang.String

        Registered

        Returns false if the 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.

        SecurityDDModel

        The security model that is used to secure a deployed module.

        To set this value, you can use the weblogic.Deployer command-line tool, the Deployment Assistant in the Administration Console, the WebLogic Scripting Tool (WLST), or some other JMX client.

        If you deploy a module using one of the previously mentioned tools and you do not specify a security model value, the module is secured with the security realm's default model ( see RealmMBean SecurityDDModel ).

        If you deploy a module by modifying the domain's config.xml file and restarting the server, and if you do not specify a security model value for the module in config.xml, the module is secured with the DDOnly model, which is the default value of this AppDeploymentMBean attribute.

        In summary, the order of precedence for the value of this attribute is as follows:

        For more information, see:

               
        Privileges Read only
        Typejava.lang.String
        Default ValueDDOnly
        Legal Values
        • DDOnly
        • CustomRoles
        • CustomRolesAndPolicies
        • Advanced
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        SourcePath

        The path to the source of the deployable unit on the Administration Server.

        Rules:

        Use AbsoluteSourcePath to get a fully resolved value.

        For more information, see:

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

        StagingMode

        The mode that specifies whether a deployment's files are copied from a source on the Administration Server to the Managed Server's staging area during application preparation.

        Staging mode for an application can only be set the first time the application is deployed. Once staging mode for an application is set, it cannot be changed while the application is configured in the domain. The only way to change staging mode is to undeploy then redeploy the application.

        This attribute overrides the server's staging mode.

        For more information, see:

               
        Privileges Read only
        Typejava.lang.String
        Legal Values
        • callback-polling
        • nostage
        • stage
        • external_stage

        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.

        ValidateDDSecurityData

        This attribute is not used in the current BEA release.

               
        Privileges Read/Write
        Typeboolean

        VersionIdentifier

        Uniquely identifies the application version across all versions of the same application.

        If the application is not versioned, this returns null.

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


        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.

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

        removeTarget

        Removes the value of the Target attribute.

        For more information, see:

           
        Operation Name"removeTarget"
        ParametersObject [] {  target }

        where:

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

          The target to remove

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