LibraryMBean

Overview

Configuration bean for Libraries.

Related MBeans

This section describes attributes that provide access to other MBeans.

SubDeployments

Targeting for subcomponents that differs from targeting for the component.

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.

Attributes

This section describes the following attributes:

AbsoluteAltDescriptorDir

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

AbsoluteAltDescriptorPath

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

AbsoluteInstallDir

The fully resolved location of this application's installation root directory on the Administration Server.

AbsolutePlanDir

The fully resolved location of this application's deployment plan directory on the Administration Server.

AbsolutePlanPath

The fully resolved location of this application's deployment plan on the Administration Server.

AbsoluteSourcePath

The fully resolved location of this application's source files on the Administration 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:

• getInstallDir
• getAbsoluteAltDescriptorDir

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.

ApplicationName

The name of the application.

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

CacheInAppDirectory

CachingDisabled

Private property that disables caching in proxies.

This attribute is not dynamic and requires a server restart to take effect.

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.

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.

DeploymentPlan

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

DeploymentPlanExternalDescriptors

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

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.

DynamicallyCreated

Return whether the MBean was created dynamically or is persisted to config.xml

This attribute is not dynamic and requires a server restart to take effect.

Id

Return the unique id of this MBean instance

This attribute is not dynamic and requires a server restart to take effect.

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:

• getSourcePath
• getPlanDir
• getPlanPath

MBeanInfo

Returns the MBean info for this MBean.

This attribute is not dynamic and requires a server restart to take effect.

Deprecated.

ModuleType

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

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

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

This attribute is not dynamic and requires a server restart to take effect.

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

This attribute is not dynamic and requires a server restart to take effect.

Deprecated.

ParallelDeployModules

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

Parent

Return the immediate parent for this MBean

This attribute is not dynamic and requires a server restart to take effect.

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:

• getInstallDir
• getAbsolutePlanDir

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:

• getPlanDir
• getAbsolutePlanPath

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:

• ServerMBean#getStagingMode

Registered

Returns false if the MBean represented by this object has been unregistered.

This attribute is not dynamic and requires a server restart to take effect.

Deprecated.

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:

• If you deploy a module using a runtime deployment utility, the order of precedence is:

  1. The value set by the deployment utility.

  2. The value set as the security realm's default security model.

• If you deploy a module by modifying config.xml and restarting the server, the order of precedence is:

  1. The value that you specify for the module in config.xml.

  2. The default value of this AppDeploymentMBean SecurityDDModel attribute.

For more information, see:

• RealmMBean#getSecurityDDModel

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:

• getInstallDir
• getAbsoluteSourcePath

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:

• ServerMBean#getStagingMode

Tags

Return all tags on this Configuration MBean

This attribute is dynamic and takes effect immediately.

Type

Returns the type of the MBean.

This attribute is not dynamic and requires a server restart to take effect.

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.

ValidateDDSecurityData

This attribute is not used in the current release.

VersionIdentifier

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

If the application is not versioned, this returns null.

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.

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.

createPlan

Create a deployment plan in the specified directory.

createPlan

Create a deployment plan in a default directory

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

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.

isInherited

Check if the value of a property is inherited from template mbean or not.

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

removeTag

Remove a tag from this Configuration MBean

removeTarget

Removes the value of the Target attribute.

For more information, see:

• addTarget

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

unSet

Restore the given property to its default value.