View This Library Collection
/management/weblogic/{version}/domainConfig/resourceGroupTemplates/{name}/libraries
View this library collection.
Request
-
name: string
The name property of the instance in the collection.
-
version: string
The version of the WebLogic REST interface.
-
excludeFields(optional): string
The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
-
excludeLinks(optional): string
The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
-
fields(optional): string
The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
-
links(optional): string
The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.
-
Admin: basic
Type:
basicDescription:A user in the Admin security role. -
Deployer: basic
Type:
basicDescription:A user in the Deployer security role. -
Monitor: basic
Type:
basicDescription:A user in the Monitor security role. -
Operator: basic
Type:
basicDescription:A user in the Operator security role.
Response
- application/json
200 Response
Returns a list of library entities.
object-
absoluteAltDescriptorDir(optional):
string
Read Only:
trueThe fully resolved location of this application's alternate descriptor directory on the Administration Server.
Constraints
- not visible for domain scoped mbeans
-
absoluteAltDescriptorPath(optional):
string
Read Only:
trueThe fully resolved location of this application's alternate descriptor on the Administration Server.
Constraints
- not visible for domain scoped mbeans
-
absoluteInstallDir(optional):
string
Read Only:
trueThe fully resolved location of this application's installation root directory on the Administration Server.
Constraints
- not visible for domain scoped mbeans
-
absolutePlanDir(optional):
string
Read Only:
trueThe fully resolved location of this application's deployment plan directory on the Administration Server.
Constraints
- not visible for domain scoped mbeans
-
absolutePlanPath(optional):
string
Read Only:
trueThe fully resolved location of this application's deployment plan on the Administration Server.
Constraints
- not visible for domain scoped mbeans
-
absoluteSourcePath(optional):
string
Read Only:
trueThe fully resolved location of this application's source files on the Administration Server.
Constraints
- not visible for domain scoped mbeans
-
altDescriptorDir(optional):
string
Read Only:
trueThe 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.
Constraints
- not visible for domain scoped mbeans
-
applicationIdentifier(optional):
string
Read Only:
trueThe 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.
Constraints
- not visible for domain scoped mbeans
-
applicationName(optional):
string
Read Only:
trueThe name of the application.
Note that the name of the current MBean is not the name of the application.
Constraints
- not visible for domain scoped mbeans
-
cacheInAppDirectory(optional):
boolean
Constraints
- not visible for domain scoped mbeans
-
compatibilityName(optional):
string
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.
Constraints
- not visible for domain scoped mbeans
-
deploymentOrder(optional):
integer(int32)
Default Value:
100An 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.
Constraints
- not visible for domain scoped mbeans
-
deploymentPrincipalName(optional):
string
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.
Constraints
- not visible for domain scoped mbeans
-
dynamicallyCreated(optional):
boolean
Read Only:
trueDefault Value:falseReturn whether the MBean was created dynamically or is persisted to config.xml
Constraints
- not visible for domain scoped mbeans
-
id(optional):
integer(int64)
Read Only:
trueReturn the unique id of this MBean instance
Constraints
- not visible for domain scoped mbeans
-
installDir(optional):
string
Read Only:
trueThe 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.
Constraints
- not visible for domain scoped mbeans
-
moduleType(optional):
string
The values match those defined by jsr88. This attribute may move to another MBean.
Constraints
- not visible for domain scoped mbeans
-
name(optional):
string
Read Only:
trueThe user-specified name of this MBean instance.
This name is included as one of the key properties in the MBean's
javax.management.ObjectNameName=user-specified-nameConstraints
- legal null
-
notes(optional):
string
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.
-
parallelDeployModules(optional):
boolean
Determines if the modules of applications will be deployed in parallel.
Constraints
- not visible for domain scoped mbeans
-
planDir(optional):
string
Read Only:
trueThe 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.
Constraints
- not visible for domain scoped mbeans
-
planPath(optional):
string
Read Only:
trueThe 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.
Constraints
- not visible for domain scoped mbeans
-
planStagingMode(optional):
string
Read Only:
trueDefault Value:oracle.doceng.json.BetterJsonNull@1349a7f2Allowed Values:[ null, "nostage", "stage", "external_stage" ]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.
Constraints
- not visible for domain scoped mbeans
-
securityDDModel(optional):
string
Read Only:
trueDefault Value:DDOnlyAllowed Values:[ "DDOnly", "CustomRoles", "CustomRolesAndPolicies", "Advanced" ]The security model that is used to secure a deployed module.
To set this value, you can use the
weblogic.Deployercommand-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 weblogic.management.security.RealmMBean#getSecurityDDModel RealmMBean SecurityDDModel).
If you deploy a module by modifying the domain's
config.xmlfile and restarting the server, and if you do not specify a security model value for the module inconfig.xml, the module is secured with theDDOnlymodel, which is the default value of thisAppDeploymentMBeanattribute.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:
The value set by the deployment utility.
The value set as the security realm's default security model.
If you deploy a module by modifying
config.xmland restarting the server, the order of precedence is:The value that you specify for the module in
config.xmlThe default value of this
AppDeploymentMBean SecurityDDModelattribute.
Constraints
- not visible for domain scoped mbeans
-
sourcePath(optional):
string
Read Only:
trueThe 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/appif InstallDir is not null; otherwise, it is resolved relative to the domain root.Use AbsoluteSourcePath to get a fully resolved value.
Constraints
- not visible for domain scoped mbeans
-
stagingMode(optional):
string
Read Only:
trueDefault Value:oracle.doceng.json.BetterJsonNull@2f071900Allowed Values:[ null, "nostage", "stage", "external_stage" ]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.
Constraints
- not visible for domain scoped mbeans
-
tags(optional):
array Items
Title:
ItemsReturn all tags on this Configuration MBean
Constraints
- not visible for domain scoped mbeans
-
targets(optional):
array Target References
Title:
Target ReferencesContains the array of target references.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.
Constraints
- not visible for domain scoped mbeans
-
type(optional):
string
Read Only:
trueReturns the type of the MBean.
Constraints
- unharvestable
-
untargeted(optional):
boolean
Default Value:
falseOnly 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.
Constraints
- not visible for domain scoped mbeans
-
validateDDSecurityData(optional):
boolean
Default Value:
falseThis attribute is not used in the current release.
Constraints
- not visible for domain scoped mbeans
-
versionIdentifier(optional):
string
Read Only:
trueUniquely identifies the application version across all versions of the same application.
If the application is not versioned, this returns null.
Constraints
- not visible for domain scoped mbeans
arrayTarget ReferencesYou 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.
Constraints
- not visible for domain scoped mbeans
-
Array of:
object Target Reference
Title:
Target ReferenceContains the target reference.
objectTarget Reference-
identity(optional):
array Identity
Title:
IdentityDOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
arrayIdentity