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, EAR files and standalone Java EE and non-Java EE 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:


      AbsoluteAltDescriptorDir

      The fully resolved location of this application's alternate descriptor directory on the Administration Server.

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

      AbsoluteAltDescriptorPath

      The fully resolved location of this application's alternate descriptor on the Administration Server.

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

      AbsoluteInstallDir

      The fully resolved location of this application's installation root directory on the Administration 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 Administration 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 Administration 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 Administration Server.

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

      AltDescriptorDir

      The location of this application's configuration area. This directory can contain alternate descriptor files.

      Rules:

      If the alternate descriptor directory is a relative path, it is resolved relative to InstallDir if InstallDir is not null; otherwise, it is resolved relative to the domain root.

      Use AbsoluteAltDescriptorDir to get a fully resolved value.

      For more information, see:

             
      Available Since Release 12.2.1.0.0
      Privileges Read only
      Typejava.lang.String

      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.

      CacheInAppDirectory

             
      Privileges Read/Write
      Typeboolean

      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

      DeploymentPlan

      The contents of this application's deployment plan, returned as a byte[] containing the XML.

                 
      Privileges Read only
      Security rolesRead access is granted only to the following roles:
      • Deployer
      Typebyte[]
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      DeploymentPlanExternalDescriptors

      A zip file containing the external descriptors referenced in the deployment plan.

                 
      Privileges Read only
      Security rolesRead access is granted only to the following roles:
      • Deployer
      Typebyte[]
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      DeploymentPrincipalName

      A string value that indicates the principal that 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 specified, then the anonymous principal will be used.

             
      Privileges Read/Write
      Typejava.lang.String

      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.

      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.

      InstallDir

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

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

      The 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

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

      ParallelDeployModules

      Determines if the modules of applications will be deployed in parallel.

             
      Available Since Release 12.2.1.0.0
      Privileges Read/Write
      Typeboolean

      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:

      If the plan directory is a relative path, it is resolved relative to InstallDir if InstallDir is not null; otherwise, it is resolved relative to the domain root.

      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 the Administration Server.

      Rules:

      If the plan path is a relative path, it is resolved relative to PlanDir if PlanDir is not null; otherwise, it is resolved relative to the domain root.

      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

      PlanStagingMode

      Specifies whether an application's deployment plan is copied from a source on the Administration Server to the Managed Server's staging area during application preparation.

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

      This attribute overrides the server's plan staging mode.

      For more information, see:

             
      Privileges Read only
      Typejava.lang.String
      Legal Values
      • UnsupportedOperationException if called on a runtime implementation.
      • nostage
      • stage
      • external_stage

      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.

      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 another 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:

      If the source path is relative, it is resolved relative to InstallDir/app if InstallDir is not null; otherwise, it is resolved relative to the domain root.

      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

      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 the staging mode for an application is set, it cannot be changed while the application is configured in the domain. The only way to change the staging mode is to undeploy and then redeploy the application.

      This attribute overrides the server's staging mode.

      For more information, see:

             
      Privileges Read only
      Typejava.lang.String
      Legal Values
      • UnsupportedOperationException if called on a runtime implementation.
      • nostage
      • stage
      • external_stage

      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.

      Untargeted

      Only relevant for deployments in resource group templates. This flag, when specified as true, indicates that the application deployment must not be deployed in the referring partition.

             
      Available Since Release 12.2.1.0.0
      Privileges Read/Write
      Typeboolean

      ValidateDDSecurityData

      This attribute is not used in the current 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:


      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 void
      Exceptions
      • javax.management.InvalidAttributeValueException
      • weblogic.management.DistributedManagementException

      createPlan

      Create a deployment plan in the specified directory.

         
      Operation Name"createPlan"
      ParametersObject [] {  planPath }

      where:

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

        planPath

      SignatureString [] { "java.lang.String" }
      ReturnsString

      createPlan

      Create a deployment plan in a default directory

         
      Operation Name"createPlan"
      Parametersnull
      Signaturenull
      ReturnsString

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