The following sections describe the data models on which the REST resources operate. These data models describe the information exchanged in REST resources.
This entity represents a JSONObject with a property for each property in the properties object, where the key is the property's name the the value is a string containing the property's value.
A unique name that identifies an address provider for Coherence cluster member.
The properties of the weblogic.coherence.descriptor.wl.CoherenceAddressProviderBean entity are as follows:
A unique name that identifies this well known address provider of a Coherence cluster member.
Type: string
Constraints: Read Only, Restart Required
A unique name that identifies all the address providers for a Coherence cluster.
This entity has no properties.
Information that represents a Coherence cache.
The properties of the weblogic.coherence.descriptor.wl.CoherenceCacheBean entity are as follows:
A unique name that identifies this Coherence cache.
Type: string
Constraints: Read Only, Restart Required
The partition to which the Coherence cache belongs to.
Type: string
Constraints: Restart Required
The properties of the weblogic.coherence.descriptor.wl.CoherenceClusterParamsBean entity are as follows:
The cluster listen port used by Coherence; Coherence cluster members use this port to discover and join, or create the cluster. If unspecified, the Coherence cluster multicast listen port will be used.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0, Maximum Value: 65535
Specifies a clustering mode of either Unicast or Multicast. If multicast is undesirable or unavailable in an environment, or when an environment is not properly configured to support multicast, then setting up the Well Known Addresses (WKA) feature is required. All cluster multicast communication is disabled if WKA is enabled.
Type: string
Constraints: Restart Required, Has Default Value: unicast, Legal Values: multicast, unicast
The IP address for the cluster multicast listener.
Type: string
Constraints: Restart Required
Check if security framework is enabled
Type: boolean
Constraints: Restart Required
Sets the time-to-live (TTL) setting for the multicast message. The TTL setting designates how far multicast UDP/IP packets can travel on a network. The TTL is expressed in terms of how many hops a packet survives; each network interface, router, and managed switch is considered one hop. The TTL value should be set to the lowest integer value that works. Setting the value too high can use unnecessary bandwidth on other LAN segments and can even cause the operating system or network devices to disable multicast traffic.
Typically, setting the TTL value to 1 works on a simple switched backbone. A value of 2 or more may be required on an advanced backbone with intelligent switching. A value of 0 is used for single server clusters that are used for development and testing.
Type: int
Constraints: Restart Required, Has Default Value: 4, Minimum Value: 0, Maximum Value: 255
Specify the underlying transport protocol to use for cluster communication. The TMB, SDMB, or IMB are only applicable to Exalogic environment.
Type: string
Constraints: Restart Required, Has Default Value: udp, Legal Values: udp, tcp, ssl, tmb, sdmb, imb
A unique name that identifies a well known address of a Coherence cluster member. Other members can use this address to enroll into the cluster.
The properties of the weblogic.coherence.descriptor.wl.CoherenceClusterWellKnownAddressBean entity are as follows:
The IP address.
Type: string
Constraints: Restart Required
A unique name that identifies this well known address of a Coherence cluster member.
Type: string
Constraints: Read Only, Restart Required
A unique name that identifies all the well known addresses for a Coherence cluster.
This entity has no properties.
Bean to configure Federation configuration to be used.
The properties of the weblogic.coherence.descriptor.wl.CoherenceFederationParamsBean entity are as follows:
The federation topology.
Type: string
Constraints: Restart Required, Has Default Value: none, Legal Values: none, active-active, active-passive, passive-active
The Coherence Cluster Listen Port of the remote participant.
Type: int
Constraints: Restart Required, Has Default Value: 7574
The Coherence Cluster Name of the remote participant cluster.
Type: string
Constraints: Restart Required
The list of remote participant hosts, who will be added as participants in the federation topology.
Type: array of string
Constraints: Restart Required
Parameters to define an instance of a Coherence com.tangosol.net.security.IdentityAsserter.
The properties of the weblogic.coherence.descriptor.wl.CoherenceIdentityAsserterBean entity are as follows:
The class that implements com.tangosol.net.security.IdentityAsserter. If className is empty, no IdentityAsserter will be configured.
Type: string
Constraints: Restart Required, Legal Null: true
The properties of the weblogic.coherence.descriptor.wl.CoherenceInitParamBean entity are as follows:
A unique name that identifies this initialization parameter.
Type: string
Constraints: Read Only, Restart Required
The parameter type.
Type: string
Constraints: Restart Required, Has Default Value: string, Legal Values: string, java.lang.String, boolean, java.lang.Boolean, int, java.lang.Integer, long, java.lang.Long, double, java.lang.Double, decimal, java.math.BigDecimal, file, java.io.File, date, java.sql.Date, time, java.sql.Time, datetime, java.sql.Timestamp
The parameter value.
Type: string
Constraints: Restart Required, Has Default Value:
Information needed to access key material for Coherence Identity from the keystore.
The properties of the weblogic.coherence.descriptor.wl.CoherenceKeystoreParamsBean entity are as follows:
The string alias used to store and retrieve the Coherence Identity private key in the keystore. This private key is associated with the Coherence Identity digital certificate. If this alias is null, the Server SSL identity alias will be used.
Type: string
Constraints: Restart Required, Has Default Value: null
The passphrase used to retrieve the private key for the Coherence Identity specified in the server configured keystore. This passphrase is assigned to the private key when the private key is generated.
Note that when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the CoherencePrivateKeyPassPhrase attribute.
Decrypts the value and returns the unencrypted passphrase.
Type: string
Constraints: Restart Required, Encrypted, Has Default Value: null, Legal Null: true
The properties of the weblogic.coherence.descriptor.wl.CoherenceLoggingParamsBean entity are as follows:
Specifies whether custom Coherence logging is enabled.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The logger name for Coherence logs.
Type: string
Constraints: Restart Required, Has Default Value: com.oracle.coherence, Legal Null: true
The Coherence logs message format.
Type: string
Constraints: Restart Required, Has Default Value: {date}/{uptime} {product} {version} <{level}> (thread={thread}, member={member}): {text}
Bean to override default Persistence environments in Coherence
The properties of the weblogic.coherence.descriptor.wl.CoherencePersistenceParamsBean entity are as follows:
The active directory for the default persistence environment. If no value is specified, the directory which will be used is the coherence/active sub-directory under Domain Home directory.
Type: string
Constraints: Restart Required
The default persistence mode.
Type: string
Constraints: Restart Required, Has Default Value: on-demand, Legal Values: on-demand, active
The snapshot directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/snapshot sub-directory under Domain Home directory.
Type: string
Constraints: Restart Required
The trash directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/trash sub-directory under Domain Home directory.
Type: string
Constraints: Restart Required
Information that represents a Coherence service.
The properties of the weblogic.coherence.descriptor.wl.CoherenceServiceBean entity are as follows:
A unique name that identifies this Coherence service.
Type: string
Constraints: Read Only, Restart Required
The partition to which the Coherence service belongs to.
Type: string
Constraints: Restart Required
A socket address for the Coherence Address Provider
The properties of the weblogic.coherence.descriptor.wl.CoherenceSocketAddressBean entity are as follows:
The IP address.
Type: string
Constraints: Restart Required
A unique name that identifies this Address Socket of an Address Provider.
Type: string
Constraints: Read Only, Restart Required
The listen port.
Type: int
Constraints: Restart Required, Minimum Value: 1, Maximum Value: 65535
The top of the Coherence Cluster System Resource bean tree.
The properties of the weblogic.coherence.descriptor.wl.WeblogicCoherenceBean entity are as follows:
The timestamp at which the custom cluster configuration file was last updated.
Type: long
Constraints: Read Only, Restart Required
The name of a custom Coherence operational configuration override file.
Type: string
Constraints: Read Only, Restart Required
A unique name that identifies this system resource in the WebLogic domain.
Type: string
Constraints: Read Only, Restart Required
The version of this file.
Type: string
Constraints: Restart Required
WLDF action configuration bean. This is a configuration point for action extensions developed outside of WebLogic.
A WLDF action extension is an action that is managed by, but not owned by, to WLDF. It must have a "type" associated with it, which must be provided to the WLDFWatchNotificationBean#createAction(String, String) method when an instance of this object is created. An instance of a WLDFActionBean defines a single instance configuration of an action extension, which can be referenced from WLDFWatchBean instances like any other action/notification type.
It acts as a container of an action properties, each property being a name/value pair. An action can have simple properties of intrinsic Java types (String, int, float, etc), encrypted properties, Map properties, and array properties.
Map and array properties can not contain nested collections or complex objects; that is, the leaf values of those objects must be simple values represented as String values.
WLDF will map these properties to the proper configuration points on the target action instance. Each action type will have different configuration points, so consult the documentation for those actions to see what the valid configuration properties are for that action type.
The properties of the weblogic.diagnostics.descriptor.WLDFActionBean entity are as follows:
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Defines the action type.
Type: string
Constraints: Read Only
Represents a named property that consists of an array of values.
The properties of the weblogic.diagnostics.descriptor.WLDFArrayPropertyBean entity are as follows:
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
Returns the array of values of this property.
Type: array of string
Constraints: Has Default Value: []
Represents a set of WLDFPropertyBean and WLDFEncryptedPropertyBean instances, akin to a java.util.Properties object.
The properties of the weblogic.diagnostics.descriptor.WLDFConfigurationPropertiesBean entity are as follows:
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
Parent interface of all child beans of WLDFConfigurationPropertiesBean.
The properties of the weblogic.diagnostics.descriptor.WLDFConfigurationPropertyBean entity are as follows:
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
Represents an encrypted configuration property
The properties of the weblogic.diagnostics.descriptor.WLDFEncryptedPropertyBean entity are as follows:
Returns the decrypted value of the property.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the ValueEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the ValueEncrypted attribute to the encrypted value.
Using this attribute is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Type: string
Constraints: Encrypted, Has Default Value:
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
Defines the set of types (beans) that are harvested. The WLDF framework allows the harvesting of all designated server-local Weblogic Server runtime MBeans, and most customer MBeans that are registered in the local server's runtime MBean server. Configuration MBeans cannot be harvested.
The properties of the weblogic.diagnostics.descriptor.WLDFHarvestedTypeBean entity are as follows:
Specifies whether this type is enabled. Note that enabling a type will have no effect unless the Harvester component is also enabled.
A true value means that this type is harvested. A false value indicates that that this type is not harvested.
Type: boolean
Constraints: Has Default Value: true
The harvested attributes for this type. If a list of attributes is provided, only those attributes are harvested; otherwise all harvestable attributes are harvested.
Type: array of string
Constraints: Has Default Value: null
The harvested instances of this type.
The configuration of a type can optionally provide a set of identifiers for specific instances. If this list is provided, only the provided instances are harvested; otherwise all instances of the type are harvested.
The identifier for an instance must be a valid JMX ObjectName or an ObjectName pattern.
Type: array of string
Constraints: Has Default Value: null
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Specifies whether this type is known at startup. Normally, if a type is not available, the Harvester will keep looking for it. If a type is designated as "known", the Harvester issues a validation fault if the type cannot be immediately resolved.
A true value means that this type is known. A false value indicates that this type may not be known.
This flag is useful for WebLogic Server types, where the type information is always available. In this case, setting the flag to true results in earlier detection and reporting of problems.
This flag is optional, but is recommended for WebLogic Server types.
Type: boolean
Constraints: Has Default Value: false
The type name. For WebLogic Server runtime MBeans, the type name is the fully qualified name of the defining interface. For customer MBeans, the type name is the fully qualified MBean implementation class.
Type: string
Constraints: Restart Required, Legal Null: true
The namespace for the harvested type definition.
Type: string
Constraints: Has Default Value: ServerRuntime, Legal Values: ServerRuntime, DomainRuntime, Legal Null: true
Configures the behavior of the Harvester component of the WebLogic Diagnostic Framework (WLDF).
The properties of the weblogic.diagnostics.descriptor.WLDFHarvesterBean entity are as follows:
Specifies whether the Harvester component is enabled.
If true, all types that are both configured and enabled are harvested. If false, nothing is harvested.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The interval, in milliseconds, between samples.
Type: long
Constraints: Has Default Value: 300000, Minimum Value: 1000
The properties of the weblogic.diagnostics.descriptor.WLDFHeapDumpActionBean entity are as follows:
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Indicates whether or not to include the set of live objects in the heap dump capture.
Type: boolean
Constraints: Has Default Value: true
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Use this interface to configure an image action, which will be sent when a diagnostic policy evaluates to true
Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.
The properties of the weblogic.diagnostics.descriptor.WLDFImageNotificationBean entity are as follows:
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The length of time, in minutes, during which no diagnostic images requests will be accepted; that is, the minimum amount of time between image capture requests.
Type: int
Constraints: Minimum Value: 0
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Use this interface to configure server-scope and application-scope instrumentation for diagnostic monitors that will execute diagnostic code at selected locations in server or application code.
The properties of the weblogic.diagnostics.descriptor.WLDFInstrumentationBean entity are as follows:
The state of the instrumentation behavior for the server or application. If false, there will no weaving (inserting of diagnostic code) in the application or server code during class loading. In addition, if woven classes are already loaded, disabling instrumentation will disable all the monitors in this scope.
Type: boolean
Pattern expressions for classes that will be excluded from this instrumentation scope. If specified, classes matching given patterns will not be instrumented.
Type: array of string
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Pattern expressions for classes that are included in this instrumentation scope. If specified, only included classes will be instrumented. If not specified, all classes loaded within the application and which are not explicitly excluded are eligible for instrumentation.
A pattern can end with an asterisk (), in which case it will match with all classes whose fully qualified classname starts with the prefix of the pattern. For example, weblogic.rmi.* will match with all classes in weblogic.rmi and its subpackages.
Type: array of string
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
This interface defines a diagnostic monitor, which is applied at the specified locations within the included classes in an instrumentation scope.
The properties of the weblogic.diagnostics.descriptor.WLDFInstrumentationMonitorBean entity are as follows:
The diagnostic actions attached to this monitor. Actions are relevant only for delegating and custom monitors. Valid actions are: TraceAction, DisplayArgumentsAction, MethodInvocationStatisticsAction, MethodMemoryAllocationStatisticsAction, StackDumpAction, ThreadDumpAction, TraceElapsedTimeAction, and TraceMemoryAllocationAction
Type: array of string
Optional description of this monitor.
Type: string
Specifies whether dye filtering is enabled for the diagnostic actions associated with this monitor.
Type: boolean
The dye mask for all diagnostic actions associated with this monitor.
Type: string
Specifies whether the monitor and its associated diagnostics actions are enabled.
Type: boolean
Constraints: Has Default Value: true
Pattern expressions for classes that will be excluded for this instrumentation monitor. If specified, classes matching given patterns will not be instrumented with this monitor.
Type: array of string
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Pattern expressions for classes that are included for this instrumentation monitor. If specified, only included classes will be instrumented with this monitor. If not specified, all classes loaded within the application and which are not explicitly excluded are eligible for instrumentation with this monitor.
A pattern can end with an asterisk (), in which case it will match with all classes whose fully qualified classname starts with the prefix of the pattern. For example, weblogic.rmi.* will match with all classes in weblogic.rmi and its subpackages.
Type: array of string
Attached actions are applied at selected locations: before, after, or around pointcuts. This is relevant only for custom monitors. (A location where diagnostic code is added is called a diagnostic joinpoint. A set of joinpoints, identified by an expression, is called a pointcut.)
Once a location type is set, it cannot be changed.
Type: string
Constraints: Restart Required, Has Default Value: before, Legal Values: before, after, around
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The pointcut expression for this monitor. (A location where diagnostic code is added is called a diagnostic joinpoint. A set of joinpoints, identified by an expression, is called a pointcut.)
Setting a pointcut expression is relevant only for custom monitors; for standard and delegating monitors, this definition is implicitly defined by WLDF.
Once a pointcut expression is set, it cannot be changed.
Type: string
Constraints: Restart Required
Properties for this monitor. Properties are name=value pairs, one pair per line. For example, USER1=foo ADDR1=127.0.0.1
Type: string
Use this interface to define a JMS action, which is sent when a diagnostic policy evaluates to true
Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.
The properties of the weblogic.diagnostics.descriptor.WLDFJMSNotificationBean entity are as follows:
The JNDI name of the JMS connection factory. If a name has not been specified, the default JMS connection factory is used.
Type: string
Constraints: Has Default Value: weblogic.jms.ConnectionFactory, Legal Null: true
The JNDI name of the JMS destination.
Type: string
Constraints: Legal Null: true
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Use this interface to define a JMX notification, which is sent when a diagnostic policy evaluates to true
Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.
The properties of the weblogic.diagnostics.descriptor.WLDFJMXNotificationBean entity are as follows:
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The JMX notification type assigned to the resulting JMX notification.
Type: string
Constraints: Has Default Value: weblogic.diagnostics.watch.defaultNotificationType
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Configures an action that can record a customized log record using the WebLogic Server NonCatalogLogger. The custom log message set via setMessage(String) can be either a literal String or a compound EL expression.
The properties of the weblogic.diagnostics.descriptor.WLDFLogActionBean entity are as follows:
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Returns the customized log message for this action.
Type: string
Constraints: Legal Null: true
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The severity of the log message recorded by this action.
default weblogic.i18n.logging.Severities.NOTICE_TEXT legalValues weblogic.i18n.logging.Severities.INFO_TEXT, weblogic.i18n.logging.Severities.WARNING_TEXT, weblogic.i18n.logging.Severities.ERROR_TEXT, weblogic.i18n.logging.Severities.NOTICE_TEXT, weblogic.i18n.logging.Severities.CRITICAL_TEXT, weblogic.i18n.logging.Severities.ALERT_TEXT, weblogic.i18n.logging.Severities.EMERGENCY_TEXT
Type: string
Constraints: Has Default Value: Notice, Legal Values: Info, Warning, Error, Notice, Critical, Alert, Emergency
Returns the customized log message for this action.
Type: string
Constraints: Legal Null: true
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Represents a simple unencrypted configuration property.
The properties of the weblogic.diagnostics.descriptor.WLDFPropertyBean entity are as follows:
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
Specifies the value of the property.
Type: string
Constraints: Has Default Value:
Use this interface to define a REST action, which is sent when a diagnostic policy evaluates to true
Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.
The properties of the weblogic.diagnostics.descriptor.WLDFRESTNotificationBean entity are as follows:
Configures the Accept header of the HTTP request to the REST end point. The response entity of the REST invocation is ignored by the server.
Type: string
Constraints: Has Default Value: application/json, Legal Values: application/json, text/plain, text/xml, text/html
Allows customizing the JSON object delivered to the REST end point.
Type: java.util.Properties
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
The REST end point URL which will be invoked with the action payload.
Type: string
The HTTP authentication mode when invoking the REST end point URL.
Type: string
Constraints: Has Default Value: None, Legal Values: None, Basic
The HTTP authentication password when the REST end point is secured.
Type: string
Constraints: Restart Required, Encrypted
The HTTP authentication user name when the REST end point is secured.
Type: string
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The REST method for invoking the end point.
Type: string
Constraints: Has Default Value: PUT, Legal Values: PUT, POST
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
The top of the WebLogic Diagnostic Framework (WLDF) module bean tree.
All WLDF modules have a WLDFResourceBean as their root bean (a bean with no parent).
The properties of the weblogic.diagnostics.descriptor.WLDFResourceBean entity are as follows:
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
Use this interface to define a SMTP action, which is sent when a diagnostic policy evaluates to true
Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.
The properties of the weblogic.diagnostics.descriptor.WLDFSMTPNotificationBean entity are as follows:
The body for the mail message. If the body is not specified, a body is created from the action information.
Type: string
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The JNDI name of the mail session. This name must match the attribute in the corresponding MailSessionMBean.
Type: string
Constraints: Legal Null: true
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The address of the recipient or recipients of the SMTP action mail. The address uses the syntax defined in RFC822. Typical address syntax is of the form userhostdomain or Personal Name. An address can include multiple recipients, separated by commas or spaces.
For more information, refer to the javax.mail.internet.InternetAddress.parse method.
Type: array of string
The subject for the mail message. If the subject is not specified, a subject is created from the action information.
Type: string
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Use this interface to define an SNMP action, which is sent when a diagnostic policy evaluates to true
Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.
The properties of the weblogic.diagnostics.descriptor.WLDFSNMPNotificationBean entity are as follows:
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Defines a scale-down event that can be assigned to a WLDF policy.
The properties of the weblogic.diagnostics.descriptor.WLDFScaleDownActionBean entity are as follows:
Indicates the name of the cluster to perform the scaling action on.
Type: string
Constraints: Legal Null: true
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
Indicates the number of instances to scale by when the action is invoked.
Type: int
Constraints: Has Default Value: 1, Minimum Value: 1
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Defines a scale-up event that can be assigned to a WLDF policy.
The properties of the weblogic.diagnostics.descriptor.WLDFScaleUpActionBean entity are as follows:
Indicates the name of the cluster to perform the scaling action on.
Type: string
Constraints: Legal Null: true
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
Indicates the number of instances to scale by when the action is invoked.
Type: int
Constraints: Has Default Value: 1, Minimum Value: 1
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Defines a timer schedule for use with WLDF policies and actions and Harvester.
Each field uses syntax as defined by the EJB Timer ScheduleExpression class.
The properties of the weblogic.diagnostics.descriptor.WLDFScheduleBean entity are as follows:
Indicates the day of the month for the schedule.
Defaults to "*" (every day).
Type: string
Constraints: Has Default Value: *
Indicates the day of the week for the schedule.
Defaults to "*" (every day).
Type: string
Constraints: Has Default Value: *
Indicates the hour(s) of the day for the schedule.
Defaults to "*" (every hour).
Type: string
Constraints: Has Default Value: *
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Indicates the minutes of the hour for the schedule.
Defaults to every five minutes of the hour.
Type: string
Constraints: Has Default Value: */5
Indicates the month for the schedule.
Defaults to "*" (every month).
Type: string
Constraints: Has Default Value: *
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
Indicates the second(s) of the minute for the schedule.
Defaults to "0" (at the "0" second of each minute).
Type: string
Constraints: Has Default Value: 0
Indicates the time zone for the schedule.
Defaults to the default time zone for the local VM.
Type: string
Constraints: Has Default Value: null, Legal Null: true
Indicates the year for the schedule.
Defaults to "*" (every year).
Type: string
Constraints: Has Default Value: *
Configures an action that can execute an external command-line process. This action type can be used to execute custom scripts when a policy rule is triggered.
Note that any child process forked by an action of this type will have all the rights and privileges of the WebLogic Server process that spawns it. Care must be taken that the target script is available and can be read/executed by the system-level identity that owns the WebLogic Server process.
The properties of the weblogic.diagnostics.descriptor.WLDFScriptActionBean entity are as follows:
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
A map of environment variables to set for the child process.
Type: java.util.Properties
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
An array of ordered command-line arguments to the target script.
Type: array of string
The full path to the script to execute.
Type: string
Constraints: Legal Null: true
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
The working directory for the child process. If not set the working directory will be the same as the WebLogic Server parent process.
Type: string
The properties of the weblogic.diagnostics.descriptor.WLDFThreadDumpActionBean entity are as follows:
Specifies whether this action is enabled.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The number of thread dumps to capture.
Type: int
Constraints: Has Default Value: 3, Minimum Value: 1, Maximum Value: 20
The delay, in seconds, to pause betweeen thread dump captures.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 1
The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Defines policies and actions.
Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.
The properties of the weblogic.diagnostics.descriptor.WLDFWatchBean entity are as follows:
For automatic alarms, the time period, in milliseconds, to wait after the policy evaluates to true before the alarm is automatically reset.
The default reset period is 60000 milliseconds, which is equivalent to 60 seconds.
Type: int
Constraints: Has Default Value: 60000, Minimum Value: 1000
The alarm type for the policy: manual or automatic. The default alarm type is manual.
Once a manually set alarm has triggered, it must be reset through the WebLogic Server Administration Console or programmatically before it can trigger again. An automatic reset alarm will reset after the specified time period has elapsed.
Type: string
Constraints: Has Default Value: None, Legal Values: None, ManualReset, AutomaticReset
Specifies whether this policy is enabled.
Type: boolean
Constraints: Has Default Value: true
Returns the expression language type used by the policy, either "EL" or "WLDF" (deprecated).
Type: string
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The actions enabled for this policy.
Type: array of weblogic.diagnostics.descriptor.WLDFNotificationBean references
The expression used to evaluate the policy.
Type: string
Constraints: Legal Null: true
The expression type for the policy: HARVESTER_RULE_TYPE refers to harvested data, LOG_RULE_TYPE refers to server log entry data, DOMAIN_LOG_RULE_TYPE refers to domain log entry data, and EVENT_DATA_RULE_TYPE refers to instrumentation event data. The default type is HARVESTER_RULE_TYPE
For information on policy expressions, see "Using the Diagnostics Framework for Oracle WebLogic Server" at http://docs.oracle.com/middleware/home/index.html
Type: string
Constraints: Has Default Value: Harvester, Legal Values: Harvester, Log, DomainLog, EventData
The severity level of the actions sent when this policy evaluates to true. When set, this level overrides the default value provided in the parent MBean. However, if no severity level is set (null), the value provided in the parent MBean is returned.
The severity levels are the same levels used by the logging framework and the weblogic.logging.Severities class.
Type: string
Constraints: Has Default Value: Notice, Legal Values: Info, Warning, Error, Notice, Critical, Alert, Emergency
Configures and controls the WebLogic Diagnostic Framework (WLDF) policy and action component; creates and deletes policy definitions; and defines the rules that apply to specific policies.
Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.
The properties of the weblogic.diagnostics.descriptor.WLDFWatchNotificationBean entity are as follows:
Specifies whether the policy and action component is enabled.
If true (the default), all configured policies are activated, incoming data or events are evaluated against the policies, and actions are generated when policy conditions are met. If false, all policies are rendered inactive.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The threshold severity level of log messages evaluated by log policies. Messages with a lower severity than this value will be ignored and not evaluated against the policies.
Do not confuse LogWatchSeverity with Severity. LogWatchSeverity filters which log messages will be evaluated; Severity sets the default severity level for an action.
Type: string
Constraints: Has Default Value: Warning, Legal Values: Info, Warning, Error, Notice, Critical, Alert, Emergency
The name of the WebLogic Diagnostic Framework (WLDF) bean.
Type: string
Constraints: Read Only
The actions defined in this deployment.
Type: array of weblogic.diagnostics.descriptor.WLDFNotificationBean references
Constraints: Read Only, Restart Required
The default action severity level for all policies. When a policy triggers, the severity level is delivered with the action.
The severity levels are the same levels used by the logging framework and the weblogic.logging.Severities class. If no level is specified, the default value is Notice
Type: string
Constraints: Has Default Value: Notice, Legal Values: Info, Warning, Error, Notice, Critical, Alert, Emergency
This package provides parameters that govern JMS server behavior with regard to a client. For example, setting the client Id when using a particular connection factory.
The properties of the weblogic.j2ee.descriptor.wl.ClientParamsBean entity are as follows:
Acknowledge policy for non-transacted sessions that use the CLIENT_ACKNOWLEDGE mode. All indicates that calling acknowledge on a message acknowledges all unacknowledged messages received on the session. Previous specifies that calling acknowledge on a message acknowledges only unacknowledged messages up to, and including, the given message.
This parameter works around a change in the JMS specification and only applies to implementations that use the CLIENT_ACKNOWLEDGE acknowledge mode for a non-transacted session. Specifically, the specification allowed users to acknowledge all messages before and including the message being acknowledged. The specification was changed so that acknowledging any message acknowledges all messages ever received (even those received after the message being acknowledge).
ACKNOWLEDGE_PREVIOUS retains the old behavior (acknowledge all message up to and including the message being acknowledged). Whereas, ACKNOWLEDGE_ALL yields the new behavior, where all messages received by the given session are acknowledged regardless of which message is being used to effect the acknowledge.
This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: string
Constraints: Has Default Value: All, Legal Values: All, Previous
Specifies whether a connection factory creates message consumers that allow a close() or stop() method to be issued within its onMessage() method call.
If selected (set to true) on a custom connection factory, an onMessage() method callback is allowed to issue a close() method on its own Session, Connection and JMSContext objects, or a stop() call on its own Connection and JMSContext objects. If false, these calls will throw an exception.
Default JMS Connection Factories ("java:comp/DefaultJMSConnectionFactory", "weblogic.jms.ConnectionFactory", or "weblogic.jms.XAConnectionFactory") set this option to false and it cannot be modified.
Note: The onMessage() method of the Message Listener is allowed to call close() on its own MessageConsumer and JMSConsumer even when AllowCloseInOnMessage is set to false.
This value is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: boolean
Constraints: Has Default Value: true
An optional Client ID for applications that use this JMS connection factory. If the Client ID Policy is set to Restricted (the default), then configuring a Client ID on the connection factory prevents more than one JMS client from using a connection from this factory.
This attribute is rarely configured and should normally be left at the default (blank), as JMS application programs can set their Client IDs dynamically using the standard JMS APIs javax.jms.JMSContext.setClientID() or javax.jms.Connection.setClientID(). The JMS application message processing containers (such as MDBs) normally make the Client ID configurable as part of container configuration.
This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: string
Constraints: Legal Null: true
The Client ID Policy indicates whether more than one JMS connection can use the same Client ID.
The valid values are:
CLIENT_ID_POLICY_RESTRICTED - The default. Only one connection that uses this policy can exist in a cluster at any given time for a particular Client ID (if a connection already exists with a given Client ID, attempts to create new connections using this policy with the same Client ID fail with an exception).
CLIENT_ID_POLICY_UNRESTRICTED - Connections created using this policy can specify any Client ID, even when other restricted or unrestricted connections already use the same Client ID. The Unrestricted Client ID capability was added in WebLogic 10.3.4 (11gR1PS3).
Notes:
WebLogic JMS applications can override the Client ID Policy specified on the connection factory configuration by casting a javax.jms.JMSContext instance to weblogic.jms.extensions.WLJMSContext or a javax.jms.Connection instance to weblogic.jms.extension.WLConnection and calling setClientID(String clientID, String clientIDPolicy)
Two connections with the same Client ID are treated as two different independent connections if they have a different Client ID Policy. This means a cluster can host a single Restricted Client ID Policy connection, and also concurrently host multiple Unrestricted Client ID Policy connections that have the same Client ID as the Restricted connection.
Two durable subscriptions with the same Client ID and Subscription Name are treated as two different independent subscriptions if they have a different Client ID Policy. Similarly, two Sharable non-durable subscriptions with the same Client Id are treated as two different independent subscriptions if they have a different Client ID Policy.
Durable subscriptions created using an Unrestricted Client Id must be unsubscribed using the weblogic.jms.extensions.WLJMSContext.unsubscribe(Topic topic, String name) instead of javax.jms.JMSContext.unsubscribe(String name) or using the weblogic.jms.extensions.WLSession.unsubscribe(Topic topic, String name), instead of javax.jms.Session.unsubscribe(String name)
This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: string
Constraints: Has Default Value: Restricted, Legal Values: Restricted, Unrestricted
The maximum number of messages that can exist for an asynchronous session and that have not yet been passed to the message listener. When the Synchronous Prefetch Mode is enabled, this value also affects synchronous sessions with a message consumer that will prefetch messages in one server access.
A value of -1 indicates that there is no limit on the number of messages. In this case, however, the limit is set to the amount of remaining virtual memory.
When the number of messages reaches the MessagesMaximum value:
For multicast sessions, new messages are discarded according the policy specified by the OverrunPolicy parameter and a DataOverrunException is thrown.
For non-multicast sessions, new messages are flow-controlled, or retained on the server until the application can accommodate the messages.
For multicast sessions, when a connection is stopped, messages will continue to be delivered, but only until the MessagesMaximum value is reached. Once this value is reached, messages will be discarded based on the Overrun policy.
This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: int
Constraints: Has Default Value: 10
The policy to use when the number of outstanding multicast messages reaches the value specified in MessagesMaximum and some messages must be discarded.
Keep New - Indicates that the most recent messages are given priority over the oldest messages, and the oldest messages are discarded, as needed.
Keep Old - Indicates that the oldest messages are given priority over the most recent messages, and the most recent messages are discarded, as needed.
Message age is defined by the order of receipt, not by the JMSTimestamp value.
This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: string
Constraints: Has Default Value: KeepOld, Legal Values: KeepOld, KeepNew
The maximum length of time, in milliseconds, that any synchronous JMS calls, such as a producer.send(), consumer.receive(), or session.createBrowser(), will block the calling thread before giving up on a JMS client reconnect in progress.
This attribute is effective only if the Reconnect Policy option is set to either Producers or All. A value of 0 will cause synchronous JMS calls to not wait for any reconnect in progress; a value of -1 will cause an infinite wait for a reconnect.
This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: long
Constraints: Has Default Value: 60000
Specifies which types of JMS clients will be explicitly and implicitly refreshed after a lost network connection with a server or upon a server reboot. For example, selecting the Producers option will explicitly refresh JMS Producers and implicitly refresh any related Session and Connection clients.
None Do not refresh any JMS clients derived from this connection factory.
Producers Refresh all JMS Producer clients derived from this connection factory. This option does not refresh Consumers, QueueBrowsers, or Connections with a configured Client ID for a durable subscriber.
All Refresh all JMS Consumer and Producer clients derived from this connection factory, including Connections with a configured Client ID for a durable subscriber. This option does not refresh QueueBrowser clients.
This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: string
Constraints: Has Default Value: producer
Specifies the subscription sharing policy on this connection. Although this attribute is dynamic, the new values only take effect on future connections and have no impact to existing connections created before the value was changed.
The valid values are:
Exclusive - The default. All subscribers created using this connection factory cannot share subscriptions with any other subscribers.
Sharable - Subscribers created using this connection factory can share their subscriptions with other subscribers, regardless of whether those subscribers are created using the same connection factory or a different connection factory. Consumers can share a non-durable subscriptions only if they have the same Client ID and Client ID Policy; consumers can share a durable subscription only if they have the same Client ID, Client ID Policy, and Subscription Name. The Sharable Subscription Sharing capability was added in WebLogic 10.3.4 (11gR1PS3).
Notes:
WebLogic JMS applications can override the Subscription Sharing Policy specified on the connection factory configuration by casting a javax.jms.JMSContext instance to weblogic.jms.extensions.WLJMSContext or a javax.jms.Connection instance to weblogic.jms.extensions.WLConnection and calling setSubscriptionSharingPolicy(String subscriptionSharingPolicy)
Most applications with a Sharable Subscription Sharing Policy will also use an Unrestricted Client ID Policy in order to ensure that multiple connections with the same client ID can exist.
Two durable subscriptions with the same Client ID and Subscription Name are treated as two different independent subscriptions if they have a different Client ID Policy. Similarly, two Sharable non-durable subscriptions with the same Client ID are treated as two different independent subscriptions if they have a different Client ID Policy.
Durable subscriptions created using an Unrestricted Client Id must be unsubscribed using weblogic.jms.extensions.WLJMSContext.unsubscribe(Topic topic, String name), instead of javax.jms.JMSContext.unsubscribe(String name) or using weblogic.jms.extensions.WLSession.unsubscribe(Topic topic, String name), instead of javax.jms.Session.unsubscribe(String name), regardless of the Subscription Sharing Policy (Exclusive or Sharable).
This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: string
Constraints: Has Default Value: Exclusive, Legal Values: Exclusive, Sharable
Specifies whether a synchronous consumer will prefetch messages (that is, messages sent from the server to the client) in one server access.
Disabled - Indicates that message prefetching is disabled.
Enabled - Indicates that a synchronous consumer (queue receiver or topic subscriber) will prefetch messages. The amount of prefetched messages cannot exceed the maximum number of messages defined by the Messages Maximum parameter.
Topic Subscriber Only - Indicates that only a synchronous topic subscriber will prefetch messages. The amount of prefetched messages cannot exceed the maximum number of messages defined by the Messages Maximum parameter.
Synchronous message prefetching does not support the following conditions, and will throw a JMS Exception when encountered:
User (XA) transactions for synchronous message receives
Multiple synchronous consumers per session (regardless of queue or topic)
This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: string
Constraints: Has Default Value: disabled
The maximum length of time, in milliseconds, that JMS clients (particularly asynchronous consumers) will continue to try to reconnect to the server after either the initial network disconnect or the last synchronous call attempt, whichever occurred most recently, before giving up retrying.
This attribute is effective only if the ReconnectPolicy attribute is set to either Producers or All. The default value of -1 means that that it will keep trying to reconnect indefinitely; a value of 0 means that there would be exactly one retry attempt.
This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: long
Constraints: Has Default Value: -1
If a client does not specify certain parameters then the values that those parameters will take can be controlled with a default delivery parameters bean.
The properties of the weblogic.j2ee.descriptor.wl.DefaultDeliveryParamsBean entity are as follows:
The number of bytes for the serialized message body so any message exceeds this limit will trigger message compression when the message is sent or received by the JMS message producer or consumer.
The compression will occur either:
On the JMS message producer's JVM if the JMS message producer's JVM is not collocated with the JMS provider's JVM and the message body size exceeds the threshold limit.
On the JMS provider's JVM when the JMS message consumer's JVM is not collocated with the JMS provider's JVM and the message body size exceeds the threshold limit.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
The default delivery mode used for messages when a delivery mode is not explicitly defined.
All messages with a DefaultDeliveryMode of null that are produced on a connection created with this factory will receive this value. Message producers can get the delivery mode explicitly by calling the javax.jms.MessageProducer.getDeliveryMode() method.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: string
Constraints: Has Default Value: Persistent, Legal Values: Persistent, Non-Persistent
The default priority used for messages when a priority is not explicitly defined.
All messages with a DefaultPriority of -1 that are produced on a connection created with this factory will receive this value. Message producers can get the priority explicitly by calling the javax.jms.MessageProducer.getPriority() method.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: int
Constraints: Has Default Value: 4, Minimum Value: 0, Maximum Value: 9
The delay time, in milliseconds, before rolled back or recovered messages are redelivered.
All messages consumed by a consumer created with this factory that have a DefaultRedeliveryDelay of -1 will use this value.
Message consumers can get the redelivery delay explicitly by calling the weblogic.jms.extensions.WLSession.getRedliveryDelay() method.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: long
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 9223372036854775807
The delay time, in milliseconds, between when a message is produced and when it is made visible on its destination.
All messages produced by a producer created with this factory that have a DefaultTimeToDeliver of -1 will use this value. Message producers can get the Time-to-Deliver explicitly by calling the weblogic.jms.extensions.WLMessageProducer.getTimeToDeliver() method.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: string
Constraints: Has Default Value: 0
The maximum length of time, in milliseconds, that a message exists. This value is used for messages when both the time-to-live is not explicitly set by the sender application that is using this connection factory and the time-to-live is not explicitly overridden by the destination's TimeToLiveOverride attribute . A value of 0 indicates that the message has an infinite amount time to live.
Message producer applications can set the time-to-live explicitly by calling the standard JMS javax.jms.MessageProducer.setTimeToLive(long) method. Note that programmatically setting time-to-live using javax.jms.Message.setJMSExpiration() has no effect - the message setter is ignored by the JMS send call as required by the JMS specification.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.
Type: long
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 9223372036854775807
The default Unit-of-Order name for producers that connect using this connection factory. A Unit-of-Order allows for messages to be processed in a certain order, even among multiple recipients.
System-generated indicates that WebLogic Server will automatically generate a Unit-of-Order name. User-Generated indicates that the Unit-of-Order name will come from the name specified name in the Unit-of-Order Name field. If None is selected, no message ordering is enforced.
Type: string
Constraints: Restart Required, Legal Null: true
The maximum length of time, in milliseconds, that a sender will wait when there isn't enough available space (no quota) on a destination to accommodate the message being sent.
The default time is 10 milliseconds. A value of 0 indicates that the sender does not want to wait for space.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections or their producers. It only affects new connections made with this connection factory. Producers inherit the setting from the connection factory used to create their session and connection. The value can then be overridden at run time by setting the value on the producer.
Type: long
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 9223372036854775807
These parameters control what should happen to messages when failures occur. They allow the adminstrator to control error destinations, logging and other actions that might be taken when a message can not be delivered or when other failures are detected
The properties of the weblogic.j2ee.descriptor.wl.DeliveryFailureParamsBean entity are as follows:
The name of the target error destination for messages that have expired or reached their redelivery limit. If no error destination is configured, then such messages are simply dropped. If a message has expired or reached its redelivery limit, and the Expiration Policy is set to Redirect, then the message is moved to the specified Error Destination.
For standalone destinations, an error destination must be another standalone destination that is targeted to the same JMS server as the destinations for which the error destination is defined. For uniform distributed destinations (UDDs), the error destination must be another UDD that shares the same subdeployment (i.e., targets) as the current UDD.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Type: weblogic.j2ee.descriptor.wl.DestinationBean reference
The policy that defines what information about the message is logged when the Expiration Policy is set to Log. The valid logging policy values are:
%header% - All JMS header fields are logged.
%properties% - All user-defined properties are logged.
JMSDeliveryTime - This WebLogic JMS-specific extended header field is logged.
JMSRedeliveryLimit - This WebLogic JMS-specific extended header field is logged.
foo - Any valid JMS header field or user-defined property is logged.
When specifying multiple values, enter them as a comma-separated list. The %header% and %properties% values are not case sensitive. For example, you could use "%header%,%properties%" for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use "%header, name, address, city, state, zip"
Note: The JMSMessageID field is always logged and cannot be turned off. Therefore, if the Expiration Logging Policy is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the JMSMessageID of the message.
Type: string
Constraints: Has Default Value: null
The message Expiration Policy to use when an expired message is encountered on a destination. The valid expiration policies are:
None - Same as the Discard policy; expired messages are simply removed from the destination.
Discard - Removes expired messages from the messaging system. The removal is not logged and the message is not redirected to another location. If no value is defined for a given destination (i.e., None), then expired messages are discarded.
Log - Removes expired messages from the system and writes an entry to the server log file indicating that the messages have been removed from the system. The actual information that is logged is defined by the Expiration Logging Policy.
Redirect - Moves expired messages from their current location to the Error Destination defined for the destination. The message retains its body, and all of its properties. The message also retains all of its header fields, but with the following exceptions:
The destination for the message becomes the error destination.
All property overrides associated with the error destination are applied to the redirected message.
If there is no Time-To-Live Override value for the error destination, then the message receives a new Expiration Time of zero (indicating that it will not expire again).
It is illegal to use the Redirect policy when there is no valid error destination defined for the destination. Similarly, it is illegal to remove the error destination for a destination that is using the Redirect policy.
Note: The Maximum Message quota is only enforced for sending new messages. It is ignored when moving messages because of the Redirect policy.
Type: string
Constraints: Has Default Value: Discard, Legal Values: Discard, Log, Redirect
The number of redelivery tries a message can have before it is moved to the error destination. This setting overrides any redelivery limit set by the message sender. If the redelivery limit is configured, but no error destination is configured, then persistent and non-persistent messages are simply dropped (deleted) when they reach their redelivery limit.
The default value (-1) specifies that the destination will not override the message sender's redelivery limit setting.
Note: WebLogic Server supports the JMSXDeliveryCount message property, which specifies the number of message delivery attempts, where the first attempt is 1, the next attempt is 2, and so on. WebLogic Server makes a best effort to persist the delivery count, so that the delivery count does not reset back to 1 after a server reboot.
This attribute is dynamically configurable, but only incoming messages are impacted; previously sent messages continue to use their original redelivery limit.
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 2147483647
This is used to find the template bean for this destination
Type: weblogic.j2ee.descriptor.wl.TemplateBean reference
Constraints: Read Only, Restart Required
Many delivery parameters can be set by the JMS client. These overrides, if set, will cause those specific parameters to be ignored and replaced by the value set here.
The properties of the weblogic.j2ee.descriptor.wl.DeliveryParamsOverridesBean entity are as follows:
The delivery mode assigned to all messages that arrive at the destination regardless of the DeliveryMode specified by the message producer.
A value of No-Delivery specifies that the DeliveryMode will not be overridden.
Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Type: string
Constraints: Has Default Value: No-Delivery, Legal Values: Persistent, Non-Persistent, No-Delivery
The priority assigned to all messages that arrive at this destination, regardless of the Priority specified by the message producer. The default value (-1) specifies that the destination will not override the Priority set by the message producer.
Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9
The delay, in milliseconds, before rolled back or recovered messages are redelivered, regardless of the RedeliveryDelay specified by the consumer and/or connection factory. Redelivered queue messages are put back into their originating destination; redelivered topic messages are put back into their originating subscription. The default value (-1) specifies that the destination will not override the RedeliveryDelay setting specified by the consumer and/or connection factory.
Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: Changing the RedeliveryDelay override only affects future rollbacks and recovers, it does not affect rollbacks and recovers that have already occurred.
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9223372036854775807
This is used to find the template bean for this destination
Type: weblogic.j2ee.descriptor.wl.TemplateBean reference
Constraints: Read Only, Restart Required
The default delay, either in milliseconds or as a schedule, between when a message is produced and when it is made visible on its target destination, regardless of the delivery time specified by the producer and/or connection factory. The default value (-1) specifies that the destination will not override the TimeToDeliver setting specified by the producer and/or connection factory. The TimeToDeliver override can be specified either as a long or as a schedule.
Note: Changing the TimeToDeliver override only affects future message delivery, it does not affect message delivery of already produced messages.
Type: string
Constraints: Has Default Value: -1
The time-to-live assigned to all messages that arrive at this destination, regardless of the TimeToLive value specified by the message producer. The default value (-1) specifies that this setting will not override the TimeToLive setting specified by the message producer.
Range of Values: Between 0 and a positive 64-bit integer.
Note: This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9223372036854775807
Destination Key beans control the sorting criteria of JMS destinations
The properties of the weblogic.j2ee.descriptor.wl.DestinationKeyBean entity are as follows:
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The expected property type for this destination key.
Gets the "key-type" element
Type: string
Constraints: Restart Required, Has Default Value: String, Legal Values: Boolean, Byte, Short, Int, Long, Float, Double, String
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Specifies a message property name or the name of a message header field on which to sort messages. Message header field keys ignore the key type and reference message header fields rather than message properties.
Note: For better performance, use message header fields as sorting keys, rather than message properties.
Range of Values:
The JMS Property name (including user properties) or message header fields that can be sorted on are:
JMSMessageID
JMSTimestamp
JMSCorrelationID
JMSPriority
JMSExpiration
JMSType
JMSRedelivered
JMSDeliveryTime
JMS_BEA_Size
JMS_BEA_UnitOfOrder
This attribute is not dynamically configurable. Gets the "property" element
Type: string
Constraints: Restart Required, Has Default Value: JMSMessageID
The direction (Ascending or Descending) in which this key will sort messages.
Selecting the Ascending option for the JMSMessageID property implies a FIFO (first in, first out) sort order (the default for destinations). Select the Descending option for a LIFO (last in, first out) sort order.
This attribute is not dynamically configurable.
Gets the "sort-order" element.
Type: string
Constraints: Restart Required, Has Default Value: Ascending, Legal Values: Ascending, Descending
Many clients producing messages can cause the server to fall behind in processing messages. The flow control parameters can help by slowing down production of messages. Using flow control can help the overall throughput of the system.
The properties of the weblogic.j2ee.descriptor.wl.FlowControlParamsBean entity are as follows:
Specifies whether a producer created using a connection factory allows flow control. If true, the associated message producers will be slowed down if a JMS server or a destination reaches its specified upper byte or message threshold.
Type: boolean
Constraints: Has Default Value: true
The adjustment period of time, in seconds, when a producer adjusts its flow from the FlowMaximum number of messages to the FlowMinimum amount, or vice versa.
When a producer is flow controlled, it is slowed down from its FlowMaximum to its FlowMinimum over the specified FlowInterval amount of seconds.
Type: int
Constraints: Has Default Value: 60, Minimum Value: 0, Maximum Value: 2147483647
The maximum number of messages-per-second allowed for a producer that is experiencing a threshold condition. When a producer is flow controlled it will never be allowed to go faster than the FlowMaximum messages per second.
If a producer is not currently limiting its flow when a threshold condition is reached, the initial flow limit for that producer is set to FlowMaximum. If a producer is already limiting its flow when a threshold condition is reached (the flow limit is less than FlowMaximum), then the producer will continue at its current flow limit until the next time the flow is evaluated.
Note: Once a threshold condition has subsided, the producer is not permitted to ignore its flow limit. If its flow limit is less than the FlowMaximum, then the producer must gradually increase its flow to the FlowMaximum each time the flow is evaluated. When the producer finally reaches the FlowMaximum, it can then ignore its flow limit and send without limiting its flow.
Type: int
Constraints: Has Default Value: 500, Minimum Value: 1, Maximum Value: 2147483647
The minimum number of messages-per-second allowed for a producer that is experiencing a threshold condition. This is the lower boundary of a producer's flow limit. That is, WebLogic JMS will not further slow down a producer whose message flow limit is at its FlowMinimum.
When a producer is flow controlled it will never be required to go slower than FlowMinimum messages per second.
Type: int
Constraints: Has Default Value: 50, Minimum Value: 1, Maximum Value: 2147483647
The number of steps used when a producer is adjusting its flow from the Flow Maximum amount of messages to the Flow Minimum amount, or vice versa. Specifically, the Flow Interval adjustment period is divided into the number of Flow Steps (for example, 60 seconds divided by 6 steps is 10 seconds per step).
Also, the movement (i.e., the rate of adjustment) is calculated by dividing the difference between the Flow Maximum and the Flow Minimum into steps. At each Flow Step, the flow is adjusted upward or downward, as necessary, based on the current conditions, as follows:
The downward movement (the decay) is geometric over the specified period of time (Flow Interval) and according to the specified number of Flow Steps. (For example, 100, 50, 25, 12.5)
The movement upward is linear. The difference is simply divided by the number of steps.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 1, Maximum Value: 2147483647
Specifies whether message producers created using this connection factory are allowed to do one-way message sends to improve typical non-persistent, non-transactional messaging performance. When enabled, the associated queue senders and/or topic publishers can send messages without internally waiting for a response from the target destination's host JMS server.
One-way sends are supported only when the connection factory hosting the producer and the JMS server hosting the target destination are targeted to the same WebLogic Server instance. In addition, one-way sends are not supported for higher quality-of-service (QOS) features, such as XA, transacted sessions, persistent messaging, unit-of-order, unit-of-work, distributed destinations, and client-side store-and-forward. If the producer and target destination are in separate domains, or if any of these higher QOS features are detected, then the one-way mode setting will be ignored and standard two-way sends will be used instead.
Disabled One-way send is disabled.
Enabled One-way send is permitted for queue senders or topic publishers.
Topic Only Only topic publishers are permitted to do one-way sends.
Notes:
One-way message sends are disabled if your connection factory is configured with XA Connection Factory Enabled. This setting disables one-way sends whether or not the sender actually uses transactions.
To benefit from one-way performance, the default One-Way Send Window Size value must also be configured higher. After every OneWaySendWindowSize - 1 number of messages, a two-way is used instead of a one-way, so all messages are actually two-way when the OneWaySendWindowSize = 1
Type: string
Constraints: Has Default Value: disabled
Specifies the maximum number of sent messages per window when One-Way Send Mode is set to allow queue senders and/or topic publishers to make one-way sends. The window size determines when a two-way message is required to regulate the producer before it can continue making additional one-way sends.
To benefit from one-way performance, the default One-Way Send Window Size value must be configured higher in addition to enabling one-way sends. After every OneWaySendWindowSize - 1 number of messages, a two-way is used instead of a one-way, so all messages are actually two-way when the OneWaySendWindowSize = 1
Type: int
Constraints: Has Default Value: 1, Minimum Value: 1, Maximum Value: 2147483647
This bean represents a connection factory from a remote JNDI context.
The properties of the weblogic.j2ee.descriptor.wl.ForeignConnectionFactoryBean entity are as follows:
Controls connection health checking for JMS resource reference pools that access this JMS foreign connection factory mapping. The default value is Enabled
Oracle recommends selecting Disabled only when directed to do so by customer support.
Type: string
Constraints: Restart Required, Has Default Value: enabled
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name that the remote object will be bound to in the local server's JNDI tree. This is the name that should be used to look up the object on the local server.
Type: string
Constraints: Restart Required
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
The password used in conjunction with the user name specified in the Username parameter to access the remote connection factory.
Type: string
Constraints: Restart Required, Encrypted
The name of the remote object that will be looked up in the remote JNDI directory.
Type: string
Constraints: Restart Required
The user name that is passed when opening a connection to the remote server (represented by this foreign connection factory).
Type: string
Constraints: Restart Required
This bean represents a destination from a remote JNDI context.
The properties of the weblogic.j2ee.descriptor.wl.ForeignDestinationBean entity are as follows:
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name that the remote object will be bound to in the local server's JNDI tree. This is the name that should be used to look up the object on the local server.
Type: string
Constraints: Restart Required
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
The name of the remote object that will be looked up in the remote JNDI directory.
Type: string
Constraints: Restart Required
This bean represents foreign resources.
The properties of the weblogic.j2ee.descriptor.wl.ForeignServerBean entity are as follows:
Any Credentials that must be set for the JNDI provider. These Credentials will be part of the properties will be passed directly to the constructor for the JNDI provider's InitialContext class.
Some foreign providers require other properties to be set while obtaining an initial naming context. These properties can be set with a property bean
Type: string
Constraints: Encrypted
The URL that WebLogic Server will use to contact the JNDI provider. The syntax of this URL depends on which JNDI provider is being used. For WebLogic JMS, leave this field blank if you are referencing WebLogic JMS objects within the same cluster.
This value corresponds to the standard JNDI property, java.naming.provider.url
Note: If this value is not specified, look-ups will be performed on the JNDI server within the WebLogic Server instance where this connection factory is deployed.
Type: string
Constraints: Restart Required, Legal Null: true
Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.
When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of the class that must be instantiated to access the JNDI provider. This class name depends on the JNDI provider and the vendor that are being used.
This value corresponds to the standard JNDI property, java.naming.factory.initial
Note: This value defaults to weblogic.jndi.WLInitialContextFactory, which is the correct value for WebLogic Server.
Type: string
Constraints: Has Default Value: weblogic.jndi.WLInitialContextFactory
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Gets the name of the sub-deployment to use when targeting this entity
Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.
Type: string
Constraints: Restart Required
The group params bean represents items that may be templated based on the sub-deployment of the host DestinationBean. While many attributes of a Destination can be templated regardless of where the Destination is targeted, others cannot. Those elements that must be templated based on the target group of the destination are represented in this bean. A Destination will use the values in a GroupParamsBean if and only if the corresponding value is not explicitly set in the DestinationBean AND the sub-deployment-name of the Destination matches the sub-deployment-name attribute of this bean AND this GroupParamsBean is a child of the template pointed to by the Destination.
The properties of the weblogic.j2ee.descriptor.wl.GroupParamsBean entity are as follows:
Gets the name of the error destination that should be used for members who have the same sub-deployment-name. If this value is not set then the value from the templates DeliveryFailureParamsBean will be used if it is set.
Type: weblogic.j2ee.descriptor.wl.DestinationBean reference
The name of the subdeployment that template parameters apply to. A subdeployment with the specified name must exist in the topic or queue for the parameters to apply.
Type: string
Constraints: Read Only, Restart Required
Contains the connection pool parameters of a data source.
Configuration parameters for a data source's connection pool are specified using the connection pool parameters bean.
The properties of the weblogic.j2ee.descriptor.wl.JDBCConnectionPoolParamsBean entity are as follows:
Specifies level of JDBC debugging for XA drivers, where larger values in the range provide more debugging information.
Type: int
Constraints: Restart Required, Has Default Value: 10, Minimum Value: 0, Maximum Value: 100
The number of seconds between attempts to establish connections to the database.
If you do not set this value, data source creation fails if the database is unavailable. If set and if the database is unavailable when the data source is created, WebLogic Server will attempt to create connections in the pool again after the number of seconds you specify, and will continue to attempt to create the connections until it succeeds.
When set to , connection retry is disabled.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
The maximum number of connections that may be harvested when the connection harvesting occurs. The range of valid values is 1 to MaxCapacity.
Type: int
Constraints: Has Default Value: 1, Minimum Value: 1
Specifies the number of available connections (trigger value) used to determine when connection harvesting occurs.
Harvesting occurs when the number of available connections is below the trigger value for a connection pool.
The range of valid values is -1 to MaxCapacity
Default value is -1
Setting the value to -1 disables connection harvesting.
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1
The class name of the connection labeling callback. This is automatically passed to registerConnectionLabelingCallback when the datasource is created. The class must implement oracle.ucp.ConnectionLabelingCallback
Type: string
Constraints: Restart Required
The number of seconds after which a call to reserve a connection from the connection pool will timeout.
When set to , a call will never timeout.
When set to -1, a call will timeout immediately.
Type: int
Constraints: Has Default Value: 10, Minimum Value: -1, Maximum Value: 2147483647
Specifies the number of reconnect failures allowed before WebLogic Server disables a connection pool to minimize the delay in handling the connection request caused by a database failure. Zero means it is disabled.
Type: int
Constraints: Has Default Value: 2, Minimum Value: 0
Specifies the number of test failures allowed before WebLogic Server closes all unused connections in a connection pool to minimize the delay caused by further database testing. Zero means it is disabled.
Type: int
Constraints: Has Default Value: 2, Minimum Value: 0
Enables Set Client ID on connection for the data source. When an application requests a database connection, WebLogic Server sets a light-weight client ID on the database connection.
By default, it uses the credential mapping to map WebLogic Server user IDs to database user IDs. However, if use-database-credentials is set to true, then the credential mapping is not done and the ID is used directly as a database user ID.
It is currently supported for IBM DB2 driver and Oracle thin driver. Support for this feature will be dropped in a future Oracle thin driver release. Oracle recommends using proxy authentication instead of this feature.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies the absolute name of the application class used to intercept method calls to the JDBC driver. The application specified must implement the weblogic.jdbc.extensions.DriverInterceptor interface.
Weblogic Server will invoke the preInvokeCallback(), postInvokeExceptionCallback(), and postInvokeCallback() methods of the registered application before and after invoking any method inside the JDBC driver. You can use this feature to profile JDBC driver usage and monitor:
Methods being executed
Any exceptions thrown
Time spent inside the driver executing methods
Type: string
Constraints: Restart Required
Specifies a comma-separated list of error codes that are treated as fatal errors. These errors include deployment errors that cause a server to fail to boot and connection errors that prevent a connection from being put back in the connection pool.
This optional attribute is used to define fatal error codes, that when specified as the exception code within a SQLException (retrieved by sqlException.getErrorCode()), indicate that a fatal error has occurred and the connection is no longer usable. For Oracle databases the following fatal error codes are predefined within WLS and do not need to be placed in the configuration file:
3113: "end-of-file on communication channel"
3114: "not connected to ORACLE"
1033: "ORACLE initialization or shutdown in progress"
1034: "ORACLE not available"
1089: "immediate shutdown in progress - no operations are permitted"
1090: "shutdown in progress - connection is not permitted"
17002: "I/O exception"
Type: string
Constraints: Restart Required
The maximum number of connection requests that can concurrently block threads while waiting to reserve a connection from the data source's connection pool.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
Enables identity-based-connection-pooling for the data source. When an application requests a database connection, WebLogic Server picks or creates a physical connection with requested DBMS identity based on a map of WebLogic user IDs and database IDs.
You must also specify the map of WebLogic Server user IDs to database user IDs (credential mapping).
Type: boolean
Constraints: Restart Required, Has Default Value: false
Enables the data source to be shutdown even if connections obtained from the pool are still in use.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The number of inactive seconds on a reserved connection before WebLogic Server reclaims the connection and releases it back into the connection pool.
You can use the Inactive Connection Timeout feature to reclaim leaked connections - connections that were not explicitly closed by the application. Note that this feature is not intended to be used in place of properly closing connections.
When set to , the feature is disabled.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
SQL statement to execute that will initialize newly created physical database connections. Start the statement with SQL followed by a space.
If the Init SQL value begins with "SQL ", then the rest of the string following that leading token will be taken as a literal SQL statement that will be used to initialize database connections. If the Init SQL value does not begin with "SQL ", the value will be treated as the name of a table and the following SQL statement will be used to initialize connections:
"select count(*) from InitSQL"
The table InitSQL must exist and be accessible to the database user for the connection. Most database servers optimize this SQL to avoid a table scan, but it is still a good idea to set InitSQL to the name of a table that is known to have few rows, or even no rows.
Type: string
Constraints: Restart Required
The number of physical connections to create when creating the connection pool in the data source. If unable to create this number of connections, creation of the data source will fail.
Type: int
Constraints: Has Default Value: 1, Minimum Value: 0, Maximum Value: 2147483647
The number of seconds to delay before creating each physical database connection. This delay supports database servers that cannot handle multiple connection requests in rapid succession.
The delay takes place both during initial data source creation and during the lifetime of the data source whenever a physical database connection is created.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
The maximum number of physical connections that this connection pool can contain.
Type: int
Constraints: Has Default Value: 15, Minimum Value: 1, Maximum Value: 2147483647
The minimum number of physical connections that this connection pool can contain after it is initialized.
Default: InitialCapacity
Used only for connection pool shrinking calculations.
For compatibility, InitialCapacity is used if MinCapacity is not configured.
Once a data source has gone through a suspend/resume, the larger value of either MinCapacity or InitialCapacity is used.
Type: int
Constraints: Has Default Value: 1, Minimum Value: 0, Maximum Value: 2147483647
Enables an option to improve performance by enabling execute threads to keep a pooled database connection even after the application closes the logical connection.
When enabled:
WebLogic Server pins a database connection from the connection pool to an execution thread the first time an application uses the thread to reserve a connection. When the application finishes using the connection and calls connection.close(), WebLogic Server keeps the connection with the execute thread and does not return it to the connection pool. When an application subsequently requests a connection using the same execute thread, WebLogic Server provides the connection already reserved by the thread.
There is no locking contention on the connection pool that occurs when multiple threads attempt to reserve a connection at the same time. There is no contention for threads that attempt to reserve the same connection from a limited number of database connections.
If an application concurrently reserves more than one connection from the connection pool using the same execute thread, WebLogic Server creates additional database connections and pins them to the thread.
The maximum capacity of the connection pool (maximum number of database connections created in the connection pool) becomes the number of execute threads used to request a connection multiplied by the number of concurrent connections each thread reserves. This may exceed the Maximum Capacity specified for the connection pool. You may need to consider this larger number of connections in your system design and ensure that your database allows for additional associated resources. If your system cannot handle the additional resource requirements or if you see database resource errors after enabling PinnedToThread, Oracle recommends not using PinnedToThread. See Using Pinned-To-Thread Property to Increase Performance
Type: boolean
Constraints: Restart Required, Has Default Value: false
The number of seconds that a JDBC connection needs to be held by an application before triggering a connection leak diagnostic profiling record.
When set to , the timeout is disabled. This attribute only applies when the connection leak diagnostic profiling option is enabled.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
The number of seconds between when WebLogic Server harvests profile data.
When set to , harvesting of data is disabled.
Type: int
Constraints: Has Default Value: 300, Minimum Value: 0, Maximum Value: 2147483647
Specifies that type of profile data to be collected for the JDBC subsystem.
You can specify combinations of the following profile types:
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_CONN_USAGE - Profile threads currently using connections from the pool of connections in the data source.
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_CONN_RESV_WAIT - Profile threads currently waiting to reserve a connection from the data source.
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_CONN_LEAK - Profile threads that have reserved a connection from the data source and the connection leaked (was not properly returned to the pool of connections).
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_CONN_RESV_FAIL - Profile threads that attempt to reserve a connection from the data source but fail.
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_STMT_CACHE_ENTRY - Profile prepared and callable statements added to the statement cache, and profile the threads that originated the cached statements.
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_STMT_USAGE - Profile threads currently executing SQL statements from the statement cache.
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_CONN_LAST_USAGE - Profile the previous thread that last used the connection. This information is useful when debugging problems with connections infected with pending transactions that cause subsequent XA operations on the connections to fail.
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_CONN_MT_USAGE - Profile threads that erroneously use a connection previously obtained by a different thread.
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_CONN_UNWRAP_USAGE - Profile threads that have obtained the JDBC delegate object by invoking unwrap or weblogic.common.wrapper.Wrapper.getVendorObj.
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_CONN_LOCALTX_LEAK - Profile threads that close JDBC connections that have an active local database transaction.
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_NONE - Disable profiling for the data source.
weblogic.jdbc.common.internal.JDBCConstants.PROFILE_TYPE_ALL - Enable all profile types for the data source.
Type: int
Constraints: Has Default Value: 0
Specifies whether a connection will be removed from the connection pool after the application uses the underlying vendor connection object.
If you disable removing infected connections, you must make sure that the database connection is suitable for reuse by other applications.
When set to true (the default), the physical connection is not returned to the connection pool after the application closes the logical connection. Instead, the physical connection is closed and recreated.
When set to false, when the application closes the logical connection, the physical connection is returned to the connection pool and can be reused by the application or by another application.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The number of seconds within a connection use that WebLogic Server trusts that the connection is still viable and will skip the connection test, either before delivering it to an application or during the periodic connection testing process.
This option is an optimization that minimizes the performance impact of connection testing, especially during heavy traffic.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 2147483647
The number of seconds to wait before shrinking a connection pool that has incrementally increased to meet demand.
When set to , shrinking is disabled.
Type: int
Constraints: Has Default Value: 900, Minimum Value: 0, Maximum Value: 2147483647
The number of prepared and callable statements stored in the cache. (This may increase server performance.)
WebLogic Server can reuse statements in the cache without reloading the statements, which can increase server performance. Each connection in the connection pool has its own cache of statements.
Setting the size of the statement cache to 0 turns off statement caching.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 1024
The algorithm used for maintaining the prepared statements stored in the statement cache.
Options are:
LRU - when a new prepared or callable statement is used, the least recently used statement is replaced in the cache.
FIXED - the first fixed number of prepared and callable statements are cached.
Type: string
Constraints: Restart Required, Has Default Value: LRU, Legal Values: LRU, FIXED
The time after which a statement currently being executed will time out.
StatementTimeout relies on underlying JDBC driver support. WebLogic Server passes the time specified to the JDBC driver using the java.sql.Statement.setQueryTimeout() method. If your JDBC driver does not support this method, it may throw an exception and the timeout value is ignored.
A value of -1 disables this feature.
A value of means that statements will not time out.
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 2147483647
Enables WebLogic Server to test a connection before giving it to a client. (Requires that you specify a Test Table Name.)
The test adds a small delay in serving the client's request for a connection from the pool, but ensures that the client receives a viable connection.
Type: boolean
Constraints: Has Default Value: false
The number of seconds a WebLogic Server instance waits between attempts when testing unused connections. (Requires that you specify a Test Table Name.) Connections that fail the test are closed and reopened to re-establish a valid physical connection. If the test fails again, the connection is closed.
In the context of multi data sources, this attribute controls the frequency at which WebLogic Server checks the health of data sources it had previously marked as unhealthy.
When set to , the feature is disabled.
Type: int
Constraints: Has Default Value: 120, Minimum Value: 0, Maximum Value: 2147483647
The name of the database table to use when testing physical database connections. This name is required when you specify a Test Frequency and enable Test Reserved Connections.
The default SQL code used to test a connection is select count(*) from TestTableName
Most database servers optimize this SQL to avoid a table scan, but it is still a good idea to set the Test Table Name to the name of a table that is known to have few rows, or even no rows.
If the Test Table Name begins with SQL, then the rest of the string following that leading token will be taken as a literal SQL statement that will be used to test connections instead of the standard query. For example: SQL BEGIN; Null; END;
For an Oracle database, you can reduce the overhead of connection testing by setting Test Table Name to SQL PINGDATABASE which uses the pingDatabase() method to test the Oracle connection. For any JDBC 4.0 database, it is possible to use "SQL ISVALID" to use the isValid() method on the connection.
Type: string
By default, SQL objects for CallableStatement, PreparedStatement, ResultSet, Statement, and DatabaseMetaData are wrapped with a WebLogic wrapper. Wrapping allows features like debugging and connection usage to be performed by the server.
When false, wrapping is disabled. This improves performance, in some cases significantly, and allows for the application to use the native driver objects directly. A value of false also disables data type wrapping.
Type: boolean
Constraints: Restart Required, Has Default Value: true
By default, data type objects for Array, Blob, Clob, NClob, Ref, SQLXML, and Struct, plus ParameterMetaData and ResultSetMetaData objects are wrapped with a WebLogic wrapper. This allows for features like debugging and connection usage to be done by the server.
The wrapping can be turned off by setting this value to false. This improves performance, in some cases significantly, and allows for the application to use the native driver objects directly.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The top of the JDBC data source bean tree.
JDBC data sources all have a JDBCDataSourceBean as their root bean (a bean with no parent). The schema namespace that corresponds to this bean is "http://xmlns.oracle.com/weblogic/jdbc-data-source"
The properties of the weblogic.j2ee.descriptor.wl.JDBCDataSourceBean entity are as follows:
The data source type. Valid types are:
GENERIC - generic data source
MDS - multi data source
AGL - Active GridLink data source
UCP - Universal Connection Pool data source
PROXY - proxy for multiple tenant data sources
Type: string
Constraints: Restart Required, Legal Values: GENERIC, MDS, AGL, UCP, PROXY
Gets the Id value
Type: long
Constraints: Read Only, Restart Required
A unique name that identifies this data source in the WebLogic domain.
Type: string
Constraints: Restart Required
Gets the "version" attribute
Type: string
Constraints: Restart Required
Contains the basic usage parameters of a data source.
Configuration parameters for the basic usage of a data source are specified using a data source parameters bean.
The properties of the weblogic.j2ee.descriptor.wl.JDBCDataSourceParamsBean entity are as follows:
The JNDI path for this Data Source. By default, the JNDI name is the name of the data source.
Applications that look up the JNDI path get a javax.sql.DataSource instance that corresponds to this data source.
Type: array of string
Constraints: Restart Required
The algorithm determines the connection request processing for the multi data source.
You can specify one of the following algorithm types:
Failover
Connection requests are sent to the first data source in the list; if the request fails, the request is sent to the next data source in the list, and so forth. The process is repeated until a valid connection is obtained, or until the end of the list is reached, in which case an exception is thrown.
Load balancing
The multi data source distributes connection requests evenly to its member data sources. With this algorithm, the multi data source also provides failover processing. That is, if a request fails, the multi data source sends the request to the next data source in the list until a valid connection is obtained, or until the end of the list is reached, in which case an exception is thrown.
Type: string
Constraints: Restart Required, Has Default Value: Failover, Legal Values: Load-Balancing, Failover
The name of the application class to handle the callback sent when a multi data source is ready to failover or fail back connection requests to another data source within the multi data source.
The name must be the absolute name of an application class that implements the weblogic.jdbc.extensions.ConnectionPoolFailoverCallback interface.
Type: string
Constraints: Restart Required, Has Default Value: null
The list of data sources to which the multi data source will route connection requests. The order of data sources in the list determines the failover order.
Type: string
Constraints: Has Default Value: null
For multi data sources with the failover algorithm, enables the multi data source to failover connection requests to the next data source if all connections in the current data source are in use.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Determines the transaction protocol (global transaction processing behavior) for the data source. Options include:
TwoPhaseCommit - Standard XA transaction processing. Requires an XA driver.
LoggingLastResource - A performance enhancement for one non-XA resource.
EmulateTwoPhaseCommit - Enables one non-XA resource to participate in a global transaction, but has some risk to data.
OnePhaseCommit - One-phase XA transaction processing using a non-XA driver. This is the default setting.
None - Support for local transactions only.
Type: string
Constraints: Restart Required, Has Default Value: OnePhaseCommit, Legal Values: TwoPhaseCommit, LoggingLastResource, EmulateTwoPhaseCommit, OnePhaseCommit, None
Enables WebLogic Server to keep the physical database connection associated with the logical connection when committing a global transaction instead releasing it and getting another physical connection when needed.
Setting this option to true may require additional connections to be configured on the database.
Use this setting to work around specific problems with JDBC XA drivers.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The name of the switching callback class for a Proxy data source.
This class implements the weblogic.jdbc.extensions.DataSourceSwitchingCallback interface.
Type: string
Constraints: Restart Required, Has Default Value: null
Specifies the switching properties passed to the switching callback method for a Proxy data source.
Type: string
Constraints: Has Default Value: null
Specifies the scoping of the data source.
You can specify one of the following scopes:
Global
Specifies that the data source is bound in the cluster-wide JNDI tree with the JNDIName specified so that the data source is available for use to any JDBC client across the cluster.
This is the default setting.
Application
Specifies that the data source is bound in the application's local namespace with the JNDIName specified so that the data source is available for use only by JDBC clients within the application. This can only be used for packaged datasources and is ignored for JDBC System resources.
Type: string
Constraints: Restart Required, Has Default Value: Global, Legal Values: Global, Application
Contains the driver parameters of a data source.
Configuration parameters for the JDBC Driver used by a data source are specified using a driver parameters bean.
The properties of the weblogic.j2ee.descriptor.wl.JDBCDriverParamsBean entity are as follows:
The full package name of JDBC driver class used to create the physical database connections in the connection pool in the data source.
For example: oracle.jdbc.OracleDriver
The driver must be the name of a class that implements the java.sql.Driver interface. Check the driver documentation to find the full pathname.
Note that the driver class must be in the classpath of any server to which the data source is deployed.
Type: string
Constraints: Restart Required
The password attribute passed to the JDBC driver when creating physical database connections.
The value is stored in an encrypted form in the descriptor file and when displayed in an administration console.
Type: string
Constraints: Restart Required, Encrypted
The URL of the database to connect to. The format of the URL varies by JDBC driver.
The URL is passed to the JDBC driver to create the physical database connections.
Type: string
Constraints: Restart Required
Specifies whether the database credentials are to be obtained from the credential mapper using the "user" property as the key. When true, the credentials are obtained from the credential mapper. When false, the database user name and password are obtained from the "user" property and Password element, respectively.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies that WebLogic Server should use the XA interface of the JDBC driver.
If the JDBC driver class used to create database connections implements both XA and non-XA versions of a JDBC driver, you can set this attribute to indicate that WebLogic Server should treat the JDBC driver as an XA driver or as a non-XA driver.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Contains the Oracle database-related parameters of a data source.
Configuration parameters for a data source's Oracle-specific behavior are specified using a Oracle parameters bean.
The properties of the weblogic.j2ee.descriptor.wl.JDBCOracleParamsBean entity are as follows:
Indicates a configured Active GridLink datasource. This attributed is set to true when using the console to create an Active GridLink datasource. It is ignored if FanEnabled is true or OnsNodeList is a non-null string.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies the affinity policy for the datasource.
Options include:
Transaction: Transaction affinity
Session: Web-session affinity
Data: Data affinity
The default value is Session.
Type: string
Constraints: Restart Required, Has Default Value: Session, Legal Values: Transaction, Session, Data, None
The name of the Connection Initialization Callback class.
This name is automatically passed to registerConnectionInitializationCallback when a data source is created. The class must implement oracle.ucp.jdbc.ConnectionInitializationCallback
Type: string
Constraints: Restart Required
Enables the data source to subscribe to and process Oracle FAN events.
This attribute is only applicable for RAC configurations that publish FAN notification events using the ONS protocol.
Type: boolean
Constraints: Has Default Value: false
A comma-separate list of ONS daemon listen addresses and ports to which connect to for receiving ONS-based FAN events. It is required when connecting to Oracle 11g databases and optional when connecting to Oracle database releases 12c and higher.
Type: string
Constraints: Restart Required
The location of the Oracle wallet file in which the SSL certificates are stored. Only required when the ONS client is configured to communicate with ONS daemons using SSL.
Type: string
Constraints: Restart Required
The wallet password attribute that is included as part of the ONS client configuration string. This attribute is only required when ONS is configured to use the SSL protocol.
The value is stored in an encrypted form in the descriptor file and when displayed in an administration console.
Type: string
Constraints: Restart Required, Encrypted
Deprecated.
Type: boolean
Constraints: Has Default Value: false
Enables the Oracle JDBC optimize UTF-8 conversion option.
Type: boolean
Enables Oracle JDBC Proxy Authentication.
Only applicable for the Oracle driver.
Requires WebLogic Server user IDs are mapped to database user IDs using credential mapping.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The amount of time, in seconds, a data source allows for Application Continuity replay processing before timing out and ending a replay session context.
When set to zero (0) seconds, replay processing (failover) is disabled, although begin/endRequest are still called. You can use this for collecting coverage and measuring performance.
The default value is 3600 seconds.
See oracle.ucp.jdbc.ConnectionInitializationCallback
Type: int
Constraints: Has Default Value: 3600, Minimum Value: 0, Maximum Value: 2147483647
If enabled, Oracle database credentials are used in getConnection instead of application server credentials. The database credentials are used to get a proxy session without requiring any work in the credential mapper.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Contains a list of JDBC properties.
This entity has no properties.
Represents a specific JDBC property.
The properties of the weblogic.j2ee.descriptor.wl.JDBCPropertyBean entity are as follows:
The plaintext value of the encrypted property value.
The value is stored in an encrypted form in the descriptor file and when displayed in an administration console.
setEncryptedValue('string') works in online WLST but not offline WLST. Use setEncryptedValueEncrypted(encrypt('string')) for online or offline WLST.
Type: string
Constraints: Restart Required, Encrypted
The name of the property. The name of each property must be unique in the list of properties.
Type: string
Constraints: Read Only, Restart Required
The value of the property defined as a system property.
Type: string
Constraints: Restart Required
The value of the property.
Type: string
Constraints: Restart Required
Contains the XA-related parameters of a data source.
Configuration parameters for a data source's XA-related behavior are specified using a XA parameters bean.
The properties of the weblogic.j2ee.descriptor.wl.JDBCXAParamsBean entity are as follows:
Enables WebLogic Server to keep the logical JDBC connection open for a global transaction when the physical XA connection is returned to the connection pool.
Select this option if the XA driver used to create database connections or the DBMS requires that a logical JDBC connection be kept open while transaction processing continues (although the physical XA connection can be returned to the connection pool).
Only applies to data sources that use an XA driver.
Use this setting to work around specific problems with JDBC XA drivers.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Enables WebLogic Server to associate the same XA database connection from the connection pool with a global transaction until the transaction completes.
Only applies to connection pools that use an XA driver.
Use this setting to work around specific problems with JDBC XA drivers.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies whether the XA driver requires a distributed transaction context when closing various JDBC objects (result sets, statements, connections, and so forth). Only applies to connection pools that use an XA driver.
When enabled, SQL exceptions that are thrown while closing the JDBC objects without a transaction context will be suppressed.
Use this setting to work around specific problems with JDBC XA drivers.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies that a dedicated XA connection is used for commit and rollback processing for a global transaction.
Only applies to data sources that use an XA driver.
Use this setting to work around specific problems with JDBC XA drivers.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies that the transaction manager calls recover on the resource only once. Only applies to data sources that use an XA driver.
Use this setting to work around specific problems with JDBC XA drivers.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Enables JTA resource health monitoring for an XA data source. When enabled, if an XA resource fails to respond to an XA call within the period specified in MaxXACallMillis, WebLogic Server marks the data source as unhealthy and blocks any further calls to the resource.
This property applies to XA data sources only, and is ignored for data sources that use a non-XA driver.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Determines the duration in seconds for which the transaction manager will perform recover operations on the resource. A value of zero indicates that no retries will be performed.
Type: int
Constraints: Restart Required, Has Default Value: 0
The number of seconds between XA retry operations if XARetryDurationSeconds is set to a positive value.
Type: int
Constraints: Restart Required, Has Default Value: 60
Enables WebLogic Server to set a transaction branch timeout based on the value for XaTransactionTimeout.
When enabled, the WebLogic Server Transaction Manager calls XAResource.setTransactionTimeout() before calling XAResource.start, and passes either the XA Transaction Timeout value or the global transaction timeout.
You may want to set a transaction branch timeout if you have long-running transactions that exceed the default timeout value on the XA resource.
Note: To use this feature, the resource manager (typically, the JDBC driver) must support the javax.transaction.xa.XAResource.setTransactionTimeout() method.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The number of seconds to set as the transaction branch timeout.
If set, this value is passed as the transaction timeout value in the XAResource.setTransactionTimeout() call on the XA resource manager, typically the JDBC driver.
When this value is set to , the WebLogic Server Transaction Manager passes the global WebLogic Server transaction timeout in seconds in the method.
If set, this value should be greater than or equal to the global WebLogic Server transaction timeout.
Note: You must enable XaSetTransactionTimeout to enable setting the transaction branch timeout.
Type: int
Constraints: Restart Required, Has Default Value: 0
The top of the JMS module bean tree.
JMS modules all have a JMSBean as their root bean (a bean with no parent). The schema namespace that corresponds to this bean is "http://xmlns.oracle.com/weblogic/weblogic-jms"
The properties of the weblogic.j2ee.descriptor.wl.JMSBean entity are as follows:
Optional information that you can include to describe this JMS module.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
The version of this file.
Type: int
Constraints: Restart Required, Has Default Value: 1
Connection factories are used to create connections for JMS clients. Connection factories can configure properties of the connections returned to the JMS client.
The properties of the weblogic.j2ee.descriptor.wl.JMSConnectionFactoryBean entity are as follows:
The global JNDI name used to look up a connection factory within a clustered JNDI namespace.
In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the Local JNDI Name setting.
If not specified, then the connection factory is not bound into a clustered JNDI namespace.
Type: string
Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.
When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The local JNDI name used to look up the connection factory within the JNDI namespace of the server where the connection factory is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.
If not specified, then the connection factory is not bound into the local JNDI namespace.
Type: string
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Gets the name of the sub-deployment to use when targeting this entity
Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.
Type: string
Constraints: Restart Required
The load-balancing parameters allow client to choose how they wish to distribute the work to the configured servers.
The properties of the weblogic.j2ee.descriptor.wl.LoadBalancingParamsBean entity are as follows:
Specifies whether non-anonymous producers created through a connection factory are load balanced within a distributed destination on a per-call basis.
If enabled, the associated message producers are load balanced on every send() or publish()
If disabled, the associated message producers are load balanced on the first send() or publish()
Type: boolean
Constraints: Has Default Value: true
Specifies whether a server instance that is load balancing consumers or producers across multiple members destinations of a distributed destination, will first attempt to load balance across any other physical destinations that are also running on the same server instance.
Type: boolean
Constraints: Has Default Value: true
These parameters control what should happen to messages logging. They allow the adminstrator to control logging.
The properties of the weblogic.j2ee.descriptor.wl.MessageLoggingParamsBean entity are as follows:
Specifies whether the module logs information about the message life cycle.
Type: boolean
Constraints: Has Default Value: false
Defines which information about the message is logged.
Valid values are:
%header% - All JMS header fields are logged.
%properties% - All user-defined properties are logged.
JMSDeliveryTime - This WebLogic JMS-specific extended header field is logged.
JMSRedeliveryLimit - This WebLogic JMS-specific extended header field is logged.
foo - Any valid JMS header field or user-defined property is logged.
When specifying multiple values, enter them as a comma-separated list. The %header% and %properies% values are not case sensitive. For example, you could use "%header%,%properties%" for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use "%header, name, address, city, state, zip"
Note: The JMSMessageID field is always logged and cannot be turned off. Therefore, if the Message Logging Format is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the JMSMessageID of the message. Gets the message-logging-format element.
Type: string
Constraints: Has Default Value: null
Finds the template bean for this destination.
Type: weblogic.j2ee.descriptor.wl.TemplateBean reference
Constraints: Read Only, Restart Required
Topics with certain quality of service allowments can receive a signifigant performance boost by using multicast to receive messages rather than using a connection oriented protocol like TCP. These parameters can be configured with the bean returned.
The properties of the weblogic.j2ee.descriptor.wl.MulticastParamsBean entity are as follows:
The IP address that this topic uses to transmit messages to multicast consumers.
Type: string
Constraints: Restart Required, Has Default Value:
The IP port that this topic uses to transmit messages to multicast consumers.
Type: int
Constraints: Restart Required, Has Default Value: 6001, Minimum Value: 1, Maximum Value: 65535
The number of routers that a message traverses en route to a consumer. A value of 1 limits the message to one subnet (which prevents it from traversing any routers).
This value is independent of the JMSExpirationTime value.
Type: int
Constraints: Restart Required, Has Default Value: 1, Minimum Value: 0, Maximum Value: 255
Finds the template bean for this destination.
Type: weblogic.j2ee.descriptor.wl.TemplateBean reference
Constraints: Read Only, Restart Required
When interfacing with a remote naming context it may be necessary to set key/value properties. This bean represents a single key/value pairing.
The properties of the weblogic.j2ee.descriptor.wl.PropertyBean entity are as follows:
Gets the key of this bean
Type: string
Constraints: Read Only, Restart Required
Gets the value associated with this bean
Type: string
Queues are used for asynchronous peer communications. A message delivered to a queue will be distributed to one consumer. Several aspects of a queues behavior can be configured with a queue bean.
The properties of the weblogic.j2ee.descriptor.wl.QueueBean entity are as follows:
A reference name for a destination or a member of a distributed destination that provides a way to lookup that destination without JNDI using javax.jms.Session createQueue or createTopic. See "How to Lookup a Destination" in Programming JMS for more information on how to use this attribute.
This name must be unique within the scope of the JMS server to which this destination is targeted. However, it does not need to be unique within the scope of an entire JMS module or WebLogic Cluster. For example, two queues can have the same destination name as long as those queues are targeted to different JMS servers.
Note: Since this name must be unique within the scope of a JMS server, verify whether other JMS modules may contain destination names that conflict with this name. It is the responsibility of the deployer to resolve the destination names targeted to JMS servers.
Type: string
Constraints: Restart Required, Has Default Value: null
The global JNDI name used to look up the destination within the JNDI namespace.
In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the Local JNDI Name parameter.
If not specified, the destination name will not be advertised through the global JNDI namespace.
Type: string
Constraints: Has Default Value: null
Specifies whether a user can send messages to a destination using Store-and-Forward.
All All users can send messages to this destination using Store-and-Forward.
None Remote users can not send messages to a destination using Store-and-Forward.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages sent after the update has been made.
Type: string
Constraints: Restart Required, Has Default Value: All, Legal Values: All, None
Specifies whether messages landing on this destination should attach the credential of the sending user. You should consult the JMSXUserID documentation in Programming WebLogic JMS before using this feature.
Supports The JMSXUserID property is set with the security principal of the sending user if requested. The sender can request its identity to be attached to its messages by using a connection factory with the AttachJMSXUserID security property enabled.
Never The JMSXUserID property is never set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
Always The JMSXUserID property is always set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages received after the update has been made.
Type: string
Constraints: Has Default Value: supports, Legal Values: supports, never, always
Specifies whether consumption is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Consumption Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Consumption Paused is explicitly disabled for this destination.
true Consumption Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.
When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.
This field is recommended for advanced use. Generally, it is recommended to set a message unit-of-order using application calls or connection factory configuration. When relying on a destination default unit order to enforce ordering with a distributed destination, the application must be aware that unit-of-order routing doesn't apply. Instead the application must specifically ensure that any particular set of messages that must be processed in order are all sent to the same specific member destination even in the event of process failures or service migration.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The list of potential destination keys for sorting the messages that arrive on a JMS destination.
The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.
Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "Ascending" (FIFO) for the sort order.
Type: array of string
Constraints: Restart Required
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Specifies the maximum length of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the expiration policy defined for undeliverable messages.
Note: An error destination for UOW messages cannot be configured with a Unit-of-Work Handling Policy of Single Message Delivery value.
This attribute is effective only if the Unit-of-Work Handling Policy is set to Single Message Delivery value. A value of -1 means that UOW messages will never expire.
Type: int
Constraints: Has Default Value: -1
Specifies whether new message insertion is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Insertion Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Insertion Paused is explicitly disabled for this destination.
true Insertion Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The local JNDI name used to look up the destination within the JNDI namespace of the server where the destination resource is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.
A destination can have both a local JNDI name and a (global) JNDI name.
Type: string
Constraints: Has Default Value: null
The maximum size of a message that is accepted from producers on this destination.
The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: JMSCorrelationID and JMSType. Producers sending messages that exceed the configured maximum message size for the destination receive a ResourceAllocationException
The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
Controls how long destinations are willing to wait to create full batches of available messages (if at all) for delivery to consumers. At the minimum value, batching is disabled; at the default value, less-than-full batches will not wait and are delivered immediately with currently available messages; tuning higher than the default value controls the maximum wait time for additional messages before less-than-full batches are delivered to consumers.
The maximum message count of a full batch is controlled by the JMS connection factory's Messages Maximum setting.
Type: int
Constraints: Has Default Value: 25, Minimum Value: 0, Maximum Value: 100
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Specifies whether new message production is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Production Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Production Paused is explicitly disabled for this destination.
true Production Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
A Quota controls the allotment of system resources available to destinations. For example, the number of bytes a destination is allowed to store can be configured with a Quota.
Type: weblogic.j2ee.descriptor.wl.QuotaBean reference
Gets the name of the sub-deployment to use when targeting this entity
Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.
Type: string
Constraints: Restart Required
The JMS template from which the destination is derived. A template provides an efficient means of defining multiple destinations with similar configuration values.
If a JMS template is specified, destination parameters that are set to their default values will instead inherit their values from the JMS template at run-time. However, if a JMS template is not defined, then the configuration values for the destination must be specified as part of the destination.
Although you can dynamically modify the configuration of a JMS template, the configuration values on a destination are static.
Type: weblogic.j2ee.descriptor.wl.TemplateBean reference
Constraints: Restart Required
Specifies whether the Unit-of-Work (UOW) feature is enabled for this destination. A UOW is a set of messages that are processed as a single unit.
Pass-Through By default, this destination does not treat messages as part of a UOW.
Single Message Delivery This value should only be selected if UOW consumers are receiving messages on this destination. When selected, UOW messages are formed into a list and are consumed as an ObjectMessage containing the list.
Type: string
Constraints: Has Default Value: PassThrough, Legal Values: PassThrough, SingleMessageDelivery
Quota beans control the allotment of system resources available to destinations. For example, the number of bytes a destination is allowed to store can be configured with a QuotaBean.
The properties of the weblogic.j2ee.descriptor.wl.QuotaBean entity are as follows:
The total number of bytes that can be stored in a destination that uses this quota.
A value of zero means that no messages can be placed on a destination without exceeding the quota. A value of -1 prevents WebLogic Server from imposing a limit.
Because excessive bytes volume can cause memory saturation, Oracle recommends that the maximum corresponds to the amount of system memory that is available after accounting for the rest of your application load.
No consideration is given to messages that are pending; that is, messages that are in-flight, delayed, or otherwise inhibited from delivery still count against the message and/or bytes quota.
.
This attribute is dynamic and can be changed at any time. If the quota is lowered and the quota object is now over quota, then subsequent requests for quota will be denied until quota is available. If the quota is raised, then this may allow the quota object to satisfy existing requests for quota.
Note: If a JMS template is used for distributed destination members, then this maximum applies only to those specific members and not the distributed destination set as a whole.
Type: long
Constraints: Has Default Value: 9223372036854775807, Minimum Value: -1, Maximum Value: 9223372036854775807
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The total number of messages that can be stored in a destination that uses this quota.
A value of zero means that no messages can be placed on a destination without exceeding the quota. A value of -1 prevents WebLogic Server from imposing a limit.
Because excessive bytes volume can cause memory saturation, Oracle recommends that the maximum corresponds to the amount of system memory that is available after accounting for the rest of your application load.
No consideration is given to messages that are pending; that is, messages that are in-flight, delayed, or otherwise inhibited from delivery still count against the message and/or bytes quota.
.
This attribute is dynamic and can be changed at any time. If the quota is lowered and the quota object is now over quota, then subsequent requests for quota will be denied until quota is available. If the quota is raised, then this may allow the quota object to satisfy existing requests for quota.
Note: If a JMS template is used for distributed destination members, then this maximum applies only to those specific members and not the distributed destination set as a whole.
Type: long
Constraints: Has Default Value: 9223372036854775807, Minimum Value: -1, Maximum Value: 9223372036854775807
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
For destinations that use this quota, this policy determines whether to deliver smaller messages before larger ones when a destination has exceeded its message quota.
FIFO (first-in, first-out) indicates that requests for quota are submitted in the order they are received. If a given request for quota cannot be satisfied, and the client requesting the quota is willing to wait, then that request will block all other requests for quota until the request is satisfied or times out. This prevents smaller messages from being delivered when larger requests are already waiting for space.
Preemptive indicates that subsequent requests can preempt previously unsatisfied requests. That is, if there is sufficient quota for the current request, then that space is used even if there are other requests waiting for quota. When quota is limited, the Preemptive policy can result in the starvation of larger requests.
Type: string
Constraints: Has Default Value: FIFO, Legal Values: FIFO, Preemptive
Indicates whether this quota is shared by multiple destinations that refer to it.
If Shared is enabled (the default), all destinations referring to the quota object compete for resources the resources defined by that object. If one destination consumes a large number of messages or bytes, then this will prevent other destinations from obtaining quota.
If Shared is disabled, the quota object behaves as a template. Each destination referring to the quota object gets its own internal instance of the object for tracking quota.
Destinations within the same JMS module may share quotas in any way they want. However, quota sharing only takes place for destinations within the same JMS server. In other words, if destinations and both share the same quota , and the quota has Shared enabled, then and will only share quota if both are deployed to the same JMS server.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Store-and-Forward (SAF) Error Handling defines the action to be taken when the delivery of a JMS message fails to be forwarded to a remote destination.
The properties of the weblogic.j2ee.descriptor.wl.SAFErrorHandlingBean entity are as follows:
Specifies the error destination when Policy is set to Redirect
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: weblogic.j2ee.descriptor.wl.SAFDestinationBean reference
Constraints: Restart Required
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Specifies how information is logged when Policy is set to Log
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: string
Constraints: Restart Required
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
The error handling policy for this SAF error handling resource.
Discard - By default, expired messages are simply removed from the system. The removal is not logged and the message is not redirected to another location.
Log - Removes expired messages and writes an entry to the server log file indicating that the messages were removed from the system. You define the actual information that will be logged in the Log Format field.
Redirect - Moves expired messages from their current location into the Error Destination defined for imported SAF destinations.
Always-Forward - Ignores the SAF Default Time-to-Live value set on the imported destination and the expiration time set on the message, and so forwards the message to a remote destination even after it has expired.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: string
Constraints: Restart Required, Has Default Value: Discard, Legal Values: Discard, Log, Redirect, Always-Forward, Legal Null: true
Store-and-Forward (SAF) Imported Destinations is a collection of a SAF queues and topics that reside in a different cluster or server. These sets of SAF queues and topics refer to the same SAF Remote Context. They can also share the same JNDI prefix, Time-To-Live default, and SAF Error Handling name.
The properties of the weblogic.j2ee.descriptor.wl.SAFImportedDestinationsBean entity are as follows:
Specifies the string that will prefix the local JNDI name of a remote destination.
Any change to this prefix affects only incoming messages; stored messages are not affected.
Type: string
Specifies the error handling configuration used for the imported destinations.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: weblogic.j2ee.descriptor.wl.SAFErrorHandlingBean reference
Constraints: Restart Required
Specifies the remote context used for the imported destinations.
Changing the remote context name affects both stored messages and incoming messages.
Type: weblogic.j2ee.descriptor.wl.SAFRemoteContextBean reference
Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.
When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Gets the name of the sub-deployment to use when targeting this entity
Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.
Type: string
Constraints: Restart Required
Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. The expiration time set on JMS messages will override this value unless the SAF Default Time-to-Live Enabled field is switched on, which then overrides the expiration time in JMS messages on imported destinations.
Any change to this value affects only incoming messages; stored messages are not affected.
Type: long
Constraints: Has Default Value: 3600000, Minimum Value: -1
Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.
Hash indicates that message producers use the hash code of a message Unit-of-Order to find a SAF agent.
PathService indicates that message producers use the Path Service to find a SAF agent.
Type: string
Constraints: Restart Required, Has Default Value: Hash, Legal Values: Hash, PathService
Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the SAF Default Time-to-Live field.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: boolean
Constraints: Has Default Value: false
Store-and-Forward (SAF) Login Context specifies the remote URL and user credentials needed to log into and get authenticated and authorized in a remote cluster or server.
The properties of the weblogic.j2ee.descriptor.wl.SAFLoginContextBean entity are as follows:
Specifies the URL to connect to when using this SAF Login Context.
SAFImportedDestinations are associated with a SAFRemoteContext that has a SAFLoginContext. This SAFLoginContext defines the URL to connect to.
Type: string
The password for the username used to log into the remote URL.
When Password is specified for a SAFLoginContext, then SAFPrincipalName is not specified.
Type: string
Constraints: Encrypted, Legal Null: true
The name used to log into the remote URL.
When Username is specified for a SAFLoginContext, then SAFPrincipalName is not specified.
Type: string
Constraints: Legal Null: true
Store-and-Forward (SAF) queues are used for asynchronous and disconnected peer communications. A message delivered to a SAF queue will be forwarded to a remote JMS queue. Several aspects of a SAF queue's behavior can be configured with a SAF Destination bean.
The properties of the weblogic.j2ee.descriptor.wl.SAFQueueBean entity are as follows:
Specifies the error handling configuration used by this SAF destination.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: weblogic.j2ee.descriptor.wl.SAFErrorHandlingBean reference
Constraints: Restart Required
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The local JNDI name of the remote destination.
Type: string
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Specifies the quality-of-service for non-persistent messages.
Exactly-Once indicates that messages will be forwarded to the remote side once and only once except for any occurrence of server crashes.
At-Least-Once indicates that messages will be forwarded to the remote side at least once. No message will be lost except for any occurrence of server crashes. However, messages may appear in the remote endpoint more than once.
At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: string
Constraints: Has Default Value: At-Least-Once, Legal Values: At-Most-Once, At-Least-Once, Exactly-Once, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Specifies the quality-of-service for persistent messages.
Exactly-Once indicates that messages will be forwarded to the remote side once and only once
At-Least-Once indicates that messages will be forwarded to the remote side at least once. Messages may appear in the remote endpoint more than once.
At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: string
Constraints: Has Default Value: Exactly-Once, Legal Values: At-Most-Once, At-Least-Once, Exactly-Once, Legal Null: true
The remote JNDI name of the remote destination.
Type: string
Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. The expiration time set on JMS messages will override this value unless the SAF Default Time-to-Live Enabled field is switched on, which then overrides the expiration time in JMS messages on imported destinations.
Any change to this value affects only incoming messages; stored messages are not affected.
Type: long
Constraints: Minimum Value: -1
Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.
Hash indicates that producers use the hash code of a message Unit-of-Order to find a SAF agent.
PathService indicates that producers use the Path Service to find a SAF agent.
Type: string
Constraints: Restart Required, Legal Values: Hash, PathService, Legal Null: true
Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the SAF Default Time-to-Live field.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: boolean
Store-and-Forward (SAF) Remote Context specifies the SAF Login Context that the SAF Imported Queue or Topic use to connect to the remote Destination. SAF Remote Context also specifies the SAF Remote Context configured in the remote cluster or server that is used by the producer of the reply-to JMS Destination specified in the message sent to a SAF Imported Destination.
The properties of the weblogic.j2ee.descriptor.wl.SAFRemoteContextBean entity are as follows:
The number of bytes for a serialized message body so that any message that exceeds this limit triggers message compression when the message is about to be sent across a SAF agent's JVM boundary.
The compression will occur on the sending-side SAF agent's JVM if the message body size exceeds the threshold limit.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Specifies the SAF Remote Context Name used by the replyTo destination in the remote cluster or server.
Type: string
Store-and-Forward (SAF) topics are used for asynchronous and disconnected peer communications. A message delivered to a SAF topic will be forwarded to a remote JMS topic. Several aspects of a SAF topic's behavior can be configured with a SAFDestination bean.
The properties of the weblogic.j2ee.descriptor.wl.SAFTopicBean entity are as follows:
Specifies the error handling configuration used by this SAF destination.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: weblogic.j2ee.descriptor.wl.SAFErrorHandlingBean reference
Constraints: Restart Required
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
The local JNDI name of the remote destination.
Type: string
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Specifies the quality-of-service for non-persistent messages.
Exactly-Once indicates that messages will be forwarded to the remote side once and only once except for any occurrence of server crashes.
At-Least-Once indicates that messages will be forwarded to the remote side at least once. No message will be lost except for any occurrence of server crashes. However, messages may appear in the remote endpoint more than once.
At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: string
Constraints: Has Default Value: At-Least-Once, Legal Values: At-Most-Once, At-Least-Once, Exactly-Once, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Specifies the quality-of-service for persistent messages.
Exactly-Once indicates that messages will be forwarded to the remote side once and only once
At-Least-Once indicates that messages will be forwarded to the remote side at least once. Messages may appear in the remote endpoint more than once.
At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: string
Constraints: Has Default Value: Exactly-Once, Legal Values: At-Most-Once, At-Least-Once, Exactly-Once, Legal Null: true
The remote JNDI name of the remote destination.
Type: string
Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. The expiration time set on JMS messages will override this value unless the SAF Default Time-to-Live Enabled field is switched on, which then overrides the expiration time in JMS messages on imported destinations.
Any change to this value affects only incoming messages; stored messages are not affected.
Type: long
Constraints: Minimum Value: -1
Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.
Hash indicates that producers use the hash code of a message Unit-of-Order to find a SAF agent.
PathService indicates that producers use the Path Service to find a SAF agent.
Type: string
Constraints: Restart Required, Legal Values: Hash, PathService, Legal Null: true
Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the SAF Default Time-to-Live field.
Any change to this parameter affects only incoming messages; stored messages are not affected.
Type: boolean
Some clients may wish to customize the security information associated with them. They can use the security parameters bean to do so.
The properties of the weblogic.j2ee.descriptor.wl.SecurityParamsBean entity are as follows:
Specifies whether WebLogic Server attaches the authenticated user name to sent messages.
If enabled, the system will attach the authenticated username onto sent messages if the destination supports this behavior. The username is placed in the JMSXUserID user property. You should consult the JMSXUserID documentation in Programming WebLogic JMS before using this feature.
When dynamically changed this will affect all connections made using this connection factory after the change was made.
Type: boolean
Constraints: Has Default Value: false
Template beans contain default values for destination attributes. If a destination defines a template and does not explicitly set the value of an attribute, then that attribute will take its value from the defined template.
The properties of the weblogic.j2ee.descriptor.wl.TemplateBean entity are as follows:
Specifies whether messages landing on destinations that use this template should attach the credential of the sending user.
Supports The JMSXUserID property is set with the security principal of the sending user if requested. The sender can request its identity to be attached to its messages by using a ConnectionFactory with AttachJMSXUserID="true"
Never The JMSXUserID property is never be set with the security principal of the sending user.
Always The JMSXUserID property is always set with the security principal of the sending user.
This property is dynamically configurable. A dynamic change will only affect messages received after the update has been made.
Type: string
Constraints: Has Default Value: supports, Legal Values: supports, never, always
Specifies whether message consumption is paused on destinations that use this template at server startup.
false Paused message consumption at server startup is disabled on this template.
true Paused message consumption at server startup is enabled on this template.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.
This field is recommended for advanced use. Generally, it is recommended to set a message unit-of-order using application calls or connection factory configuration. When relying on a destination default unit order to enforce ordering with adistributed destination, the application must be aware that unit-of-order routing doesn't apply. Instead the application must specifically ensure that any particular set of messages that must be processed in order are all sent to the same specific member destination even in the event of process failures or service migration.
Type: boolean
Constraints: Has Default Value: false
The list of potential destination keys for sorting messages that arrive on destinations that use this JMS template.
The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.
Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "Ascending" (FIFO) for the sort order.
Type: array of string
Constraints: Restart Required
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Specifies the maximum amount of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the template's expiration policy defined for undeliverable messages.
Note: A template's error destination for UOW messages cannot be configured to use the Single Message Delivery value.
Type: int
Constraints: Has Default Value: -1
Specifies whether new message insertion is paused on destinations that use this template at server startup.
false Paused message insertion at server startup is disabled on this template.
true Paused message insertion at server startup is enabled on this template.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The maximum size of a message that will be accepted from producers on this destination. The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: JMSCorrelationID and JMSType
Producers sending messages that exceed the configured maximum message size for the destination receive a ResourceAllocationException .
The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
Maximum Message Size is dynamically configurable, but only incoming messages are affected; stored messages are not affected.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
Controls how long destinations that use this template are willing to wait to create full batches of available messages (if at all) for delivery to consumers. At the minimum value, batching is disabled; at the default value, less-than-full batches will not wait and are delivered immediately with currently available messages; tuning higher than the default value controls the maximum wait time for additional messages before less-than-full batches are delivered to consumers.
The maximum message count of a full batch is controlled by the JMS connection factory's MessagesMaximum setting.
Type: int
Constraints: Has Default Value: 25, Minimum Value: 0, Maximum Value: 100
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Specifies whether new message production on destinations that use this template is paused on at server startup.
false Paused message production at server startup is disabled on this template.
true Paused message production at server startup is enabled on this template.
Type: boolean
Constraints: Restart Required, Has Default Value: false
A Quota controls the allotment of system resources available to destinations. For example the number of bytes a destination is allowed to store can be configured with a QuotaBean.
Type: weblogic.j2ee.descriptor.wl.QuotaBean reference
Specifies whether a user can send messages to destinations that use this template using Store-and-Forward.
All All users can send messages to destinations using Store-and-Forward.
None Remote users cannot send messages to destinations using Store-and-Forward.
This property is dynamically configurable. A dynamic change will only affect messages sent after the update has been made.
Type: string
Constraints: Restart Required, Has Default Value: All, Legal Values: All, None
Specifies whether the Unit-of-Work (UOW) feature is enabled for destinations that use this template. A UOW is a set of messages that are processed as a single unit.
Pass-Through By default, destinations that use this template do not treat messages as part of a UOW.
Single Message Delivery This value should only be selected if UOW consumers are receiving messages on destinations that use this template. When selected, UOW messages are formed into a list and are consumed as an ObjectMessage containing the list.
Type: string
Constraints: Has Default Value: PassThrough, Legal Values: PassThrough, SingleMessageDelivery
Thresholds are a point that must be exceeded in order to produce a given effect. These action points may cause logging or flow control or other actions, as defined by the specific points whose values have been exceeded.
The properties of the weblogic.j2ee.descriptor.wl.ThresholdParamsBean entity are as follows:
The upper threshold (total number of bytes in this destination) that triggers logging or flow control events. The value of java.lang.Long.MAX_VALUE disables logging and flow control events for the destination.
If the number of bytes exceeds this threshold, the triggered events are:
Log Messages
A message is logged on the server indicating a high threshold condition.
Flow Control
If flow control is enabled, the destination becomes armed and instructs producers to begin decreasing their message flow.
Range of Values: <= BytesMaximum; >BytesThresholdLow
Any change to this threshold affects only incoming messages; stored messages are not affected.
Type: long
Constraints: Has Default Value: 9223372036854775807, Minimum Value: 0, Maximum Value: 9223372036854775807
The lower threshold (total number of bytes in this destination) that triggers logging or flow control events. The value of java.lang.Long.MAX_VALUE disables logging and flow control events for the destination.
If the number of bytes falls below this threshold, the triggered events are:
Log Messages
A message is logged on the server indicating a low threshold condition.
Flow Control
If flow control is enabled, the destination becomes disarmed and instructs producers to begin increasing their message flow.
Range of Values: < BytesThresholdHigh
Any change to this threshold affects only incoming messages; stored messages are not affected.
Type: long
Constraints: Has Default Value: 9223372036854775807, Minimum Value: 0, Maximum Value: 9223372036854775807
The upper threshold (total number of messages in this destination) that triggers logging or flow control events. The value of java.lang.Long.MAX_VALUE disables logging and flow control events for the destination.
If the number of messages exceeds this threshold, the triggered events are:
Log Messages
A message is logged on the server indicating a high threshold condition.
Flow Control
If flow control is enabled, the destination becomes armed and instructs producers to begin decreasing their message flow.
Range of Values: <= MessagesMaximum; >MessagesThresholdLow
Any change to this threshold affects only incoming messages; stored messages are not affected.
Type: long
Constraints: Has Default Value: 9223372036854775807, Minimum Value: 0, Maximum Value: 9223372036854775807
The lower threshold (total number of messages in this destination) that triggers logging or flow control events. The value of java.lang.Long.MAX_VALUE disables logging and flow control events for the destination.
If the number of messages falls below this threshold, the triggered events are:
Log Messages
A message is logged on the server indicating a low threshold condition.
Flow Control
If flow control is enabled, the destination becomes disarmed and instructs producers to begin increasing their message flow.
Range of Values: < MessagesThresholdHigh
Any change to this threshold affects only incoming messages; stored messages are not affected.
Type: long
Constraints: Has Default Value: 9223372036854775807, Minimum Value: 0, Maximum Value: 9223372036854775807
Finds the template bean for this destination.
Type: weblogic.j2ee.descriptor.wl.TemplateBean reference
Constraints: Read Only, Restart Required
Topics are used for asynchronous peer communications. A message delivered to a topic will be distributed to all topic consumers. Several aspects of a topics behavior can be configured with a topic bean.
The properties of the weblogic.j2ee.descriptor.wl.TopicBean entity are as follows:
A reference name for a destination or a member of a distributed destination that provides a way to lookup that destination without JNDI using javax.jms.Session createQueue or createTopic. See "How to Lookup a Destination" in Programming JMS for more information on how to use this attribute.
This name must be unique within the scope of the JMS server to which this destination is targeted. However, it does not need to be unique within the scope of an entire JMS module or WebLogic Cluster. For example, two queues can have the same destination name as long as those queues are targeted to different JMS servers.
Note: Since this name must be unique within the scope of a JMS server, verify whether other JMS modules may contain destination names that conflict with this name. It is the responsibility of the deployer to resolve the destination names targeted to JMS servers.
Type: string
Constraints: Restart Required, Has Default Value: null
The global JNDI name used to look up the destination within the JNDI namespace.
In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the Local JNDI Name parameter.
If not specified, the destination name will not be advertised through the global JNDI namespace.
Type: string
Constraints: Has Default Value: null
Specifies whether a user can send messages to a destination using Store-and-Forward.
All All users can send messages to this destination using Store-and-Forward.
None Remote users can not send messages to a destination using Store-and-Forward.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages sent after the update has been made.
Type: string
Constraints: Restart Required, Has Default Value: All, Legal Values: All, None
Specifies whether messages landing on this destination should attach the credential of the sending user. You should consult the JMSXUserID documentation in Programming WebLogic JMS before using this feature.
Supports The JMSXUserID property is set with the security principal of the sending user if requested. The sender can request its identity to be attached to its messages by using a connection factory with the AttachJMSXUserID security property enabled.
Never The JMSXUserID property is never set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
Always The JMSXUserID property is always set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages received after the update has been made.
Type: string
Constraints: Has Default Value: supports, Legal Values: supports, never, always
Specifies whether consumption is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Consumption Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Consumption Paused is explicitly disabled for this destination.
true Consumption Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.
When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.
This field is recommended for advanced use. Generally, it is recommended to set a message unit-of-order using application calls or connection factory configuration. When relying on a destination default unit order to enforce ordering with a distributed destination, the application must be aware that unit-of-order routing doesn't apply. Instead the application must specifically ensure that any particular set of messages that must be processed in order are all sent to the same specific member destination even in the event of process failures or service migration.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The list of potential destination keys for sorting the messages that arrive on a JMS destination.
The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.
Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "Ascending" (FIFO) for the sort order.
Type: array of string
Constraints: Restart Required
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Specifies the maximum length of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the expiration policy defined for undeliverable messages.
Note: An error destination for UOW messages cannot be configured with a Unit-of-Work Handling Policy of Single Message Delivery value.
This attribute is effective only if the Unit-of-Work Handling Policy is set to Single Message Delivery value. A value of -1 means that UOW messages will never expire.
Type: int
Constraints: Has Default Value: -1
Specifies whether new message insertion is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Insertion Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Insertion Paused is explicitly disabled for this destination.
true Insertion Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The local JNDI name used to look up the destination within the JNDI namespace of the server where the destination resource is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.
A destination can have both a local JNDI name and a (global) JNDI name.
Type: string
Constraints: Has Default Value: null
The maximum size of a message that is accepted from producers on this destination.
The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: JMSCorrelationID and JMSType. Producers sending messages that exceed the configured maximum message size for the destination receive a ResourceAllocationException
The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
Controls how long destinations are willing to wait to create full batches of available messages (if at all) for delivery to consumers. At the minimum value, batching is disabled; at the default value, less-than-full batches will not wait and are delivered immediately with currently available messages; tuning higher than the default value controls the maximum wait time for additional messages before less-than-full batches are delivered to consumers.
The maximum message count of a full batch is controlled by the JMS connection factory's Messages Maximum setting.
Type: int
Constraints: Has Default Value: 25, Minimum Value: 0, Maximum Value: 100
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Specifies whether new message production is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Production Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Production Paused is explicitly disabled for this destination.
true Production Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
A Quota controls the allotment of system resources available to destinations. For example, the number of bytes a destination is allowed to store can be configured with a Quota.
Type: weblogic.j2ee.descriptor.wl.QuotaBean reference
Gets the name of the sub-deployment to use when targeting this entity
Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.
Type: string
Constraints: Restart Required
The JMS template from which the destination is derived. A template provides an efficient means of defining multiple destinations with similar configuration values.
If a JMS template is specified, destination parameters that are set to their default values will instead inherit their values from the JMS template at run-time. However, if a JMS template is not defined, then the configuration values for the destination must be specified as part of the destination.
Although you can dynamically modify the configuration of a JMS template, the configuration values on a destination are static.
Type: weblogic.j2ee.descriptor.wl.TemplateBean reference
Constraints: Restart Required
Specifies whether the Unit-of-Work (UOW) feature is enabled for this destination. A UOW is a set of messages that are processed as a single unit.
Pass-Through By default, this destination does not treat messages as part of a UOW.
Single Message Delivery This value should only be selected if UOW consumers are receiving messages on this destination. When selected, UOW messages are formed into a list and are consumed as an ObjectMessage containing the list.
Type: string
Constraints: Has Default Value: PassThrough, Legal Values: PassThrough, SingleMessageDelivery
The transaction parameters bean controls how transactions are handled.
The properties of the weblogic.j2ee.descriptor.wl.TransactionParamsBean entity are as follows:
Indicates whether a XA queue or XA topic connection factory is returned, instead of a queue or topic connection factory. An XA connection factory can be used to create an XAConnection, which in turn may be used to create an XASession, which in turn may be used to obtain an XAResource for use inside a transaction manager.
In addition, this attribute indicates whether or not a connection factory creates sessions that are JTA aware. If true, the associated message producers and message consumers look into the running thread for a transaction context. Otherwise, the current JTA transaction will be ignored.
Note: Transacted sessions ignore the current threads transaction context in favor of their own internal transaction, regardless of the setting. This setting only affects non-transacted sessions.
Type: boolean
Constraints: Has Default Value: false
The timeout value (in seconds) for all transactions on connections created with this connection factory.
If a transacted session is still active after the timeout has elapsed, the transaction is rolled back. A value of 0 indicates that the default value will be used. If you have long-running transactions, you might want to adjust the value of this attribute to allow transactions to complete.
Type: long
Constraints: Has Default Value: 3600, Minimum Value: 0, Maximum Value: 2147483647
A uniform distributed queue is a distributed queue whose members are configured as part of its configuration; since members share the same configuration, they are uniform. There is one member on each JMS Server that conforms to the targeting criteria of the uniform distributed queue. For example, if a uniform distributed queue is targeted to a cluster, then one member will be created on each JMS server in the cluster. Members are created and destroyed as the targeting is changed.
The properties of the weblogic.j2ee.descriptor.wl.UniformDistributedQueueBean entity are as follows:
A reference name for a destination or a member of a distributed destination that provides a way to lookup that destination without JNDI using javax.jms.Session createQueue or createTopic. See "How to Lookup a Destination" in Programming JMS for more information on how to use this attribute.
This name must be unique within the scope of the JMS server to which this destination is targeted. However, it does not need to be unique within the scope of an entire JMS module or WebLogic Cluster. For example, two queues can have the same destination name as long as those queues are targeted to different JMS servers.
Note: Since this name must be unique within the scope of a JMS server, verify whether other JMS modules may contain destination names that conflict with this name. It is the responsibility of the deployer to resolve the destination names targeted to JMS servers.
Type: string
Constraints: Restart Required, Has Default Value: null
The global JNDI name used to look up the destination within the JNDI namespace.
In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the Local JNDI Name parameter.
If not specified, the destination name will not be advertised through the global JNDI namespace.
Type: string
Constraints: Has Default Value: null
Specifies whether a user can send messages to a destination using Store-and-Forward.
All All users can send messages to this destination using Store-and-Forward.
None Remote users can not send messages to a destination using Store-and-Forward.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages sent after the update has been made.
Type: string
Constraints: Restart Required, Has Default Value: All, Legal Values: All, None
Specifies whether messages landing on this destination should attach the credential of the sending user. You should consult the JMSXUserID documentation in Programming WebLogic JMS before using this feature.
Supports The JMSXUserID property is set with the security principal of the sending user if requested. The sender can request its identity to be attached to its messages by using a connection factory with the AttachJMSXUserID security property enabled.
Never The JMSXUserID property is never set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
Always The JMSXUserID property is always set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages received after the update has been made.
Type: string
Constraints: Has Default Value: supports, Legal Values: supports, never, always
Specifies whether consumption is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Consumption Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Consumption Paused is explicitly disabled for this destination.
true Consumption Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.
When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.
This field is recommended for advanced use. Generally, it is recommended to set a message unit-of-order using application calls or connection factory configuration. When relying on a destination default unit order to enforce ordering with a distributed destination, the application must be aware that unit-of-order routing doesn't apply. Instead the application must specifically ensure that any particular set of messages that must be processed in order are all sent to the same specific member destination even in the event of process failures or service migration.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The list of potential destination keys for sorting the messages that arrive on a JMS destination.
The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.
Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "Ascending" (FIFO) for the sort order.
Type: array of string
Constraints: Restart Required
The number of seconds after which a uniform distributed queue member with no consumers will wait before forwarding its messages to other uniform distributed queue members that do have consumers.
The default value of -1 disables this feature so that no messages are forwarded to other uniform distributed queue members.
Type: int
Constraints: Has Secure Value: -1, Has Default Value: -1
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Specifies the maximum length of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the expiration policy defined for undeliverable messages.
Note: An error destination for UOW messages cannot be configured with a Unit-of-Work Handling Policy of Single Message Delivery value.
This attribute is effective only if the Unit-of-Work Handling Policy is set to Single Message Delivery value. A value of -1 means that UOW messages will never expire.
Type: int
Constraints: Has Default Value: -1
Specifies whether new message insertion is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Insertion Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Insertion Paused is explicitly disabled for this destination.
true Insertion Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Determines how messages are distributed to the members of this destination.
Choose from the following distribution techniques:
Round-Robin The system maintains an ordering of physical topic members within the set by distributing the messaging load across the topic members one at a time in the order that they are defined in the configuration file. Each WebLogic Server instance maintains an identical ordering, but may be at a different point within the ordering. If weights are assigned to any of the topic members in the set, then those members appear multiple times in the ordering.
Random The weight assigned to the topic members is used to compute a weighted distribution for the members of the set. The messaging load is distributed across the topic members by pseudo-randomly accessing the distribution. In the short run, the load will not be directly proportional to the weight. In the long run, the distribution will approach the limit of the distribution. A pure random distribution can be achieved by setting all the weights to the same value, which is typically set to 1.
Type: string
Constraints: Has Default Value: Round-Robin, Legal Values: Round-Robin, Random
The local JNDI name used to look up the destination within the JNDI namespace of the server where the destination resource is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.
A destination can have both a local JNDI name and a (global) JNDI name.
Type: string
Constraints: Has Default Value: null
The maximum size of a message that is accepted from producers on this destination.
The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: JMSCorrelationID and JMSType. Producers sending messages that exceed the configured maximum message size for the destination receive a ResourceAllocationException
The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
Controls how long destinations are willing to wait to create full batches of available messages (if at all) for delivery to consumers. At the minimum value, batching is disabled; at the default value, less-than-full batches will not wait and are delivered immediately with currently available messages; tuning higher than the default value controls the maximum wait time for additional messages before less-than-full batches are delivered to consumers.
The maximum message count of a full batch is controlled by the JMS connection factory's Messages Maximum setting.
Type: int
Constraints: Has Default Value: 25, Minimum Value: 0, Maximum Value: 100
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Specifies whether new message production is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Production Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Production Paused is explicitly disabled for this destination.
true Production Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
A Quota controls the allotment of system resources available to destinations. For example, the number of bytes a destination is allowed to store can be configured with a Quota.
Type: weblogic.j2ee.descriptor.wl.QuotaBean reference
Determines whether or not the delivery count is reset during message forwarding between distributed queue members.
The default value of true resets the delivery counts on messages when they are forwarded to another distributed queue member.
Type: boolean
Constraints: Has Default Value: true
Gets the name of the sub-deployment to use when targeting this entity
Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.
Type: string
Constraints: Restart Required
The JMS template from which the destination is derived. A template provides an efficient means of defining multiple destinations with similar configuration values.
If a JMS template is specified, destination parameters that are set to their default values will instead inherit their values from the JMS template at run-time. However, if a JMS template is not defined, then the configuration values for the destination must be specified as part of the destination.
Although you can dynamically modify the configuration of a JMS template, the configuration values on a destination are static.
Type: weblogic.j2ee.descriptor.wl.TemplateBean reference
Constraints: Restart Required
Determines how a distributed destination member is selected as the destination for a message that is part of a unit-of-order. Hash, indicates that a message producer computes the member destination from the hashCode of the unit-of-order. PathService indicates that the configured Path Service determines the member destination.
Unit-of-Order Routing can be set programmatically with WLProducer, or administratively on the connection factory or destination.
Unit of Order Routing is not dynamically configurable.
Type: string
Constraints: Restart Required, Has Default Value: Hash
Specifies whether the Unit-of-Work (UOW) feature is enabled for this destination. A UOW is a set of messages that are processed as a single unit.
Pass-Through By default, this destination does not treat messages as part of a UOW.
Single Message Delivery This value should only be selected if UOW consumers are receiving messages on this destination. When selected, UOW messages are formed into a list and are consumed as an ObjectMessage containing the list.
Type: string
Constraints: Has Default Value: PassThrough, Legal Values: PassThrough, SingleMessageDelivery
A uniform distributed topic is a distributed topic whose members are configured as part of its configuration; since members share the same configuration, they are uniform. There is one member on each JMS Server that conforms to the targeting criteria of the uniform distributed topic. For example, if a uniform distributed topic is targeted to a cluster, then one member will be created on each JMS server in the cluster. Members are created and destroyed as the targeting is changed.
The properties of the weblogic.j2ee.descriptor.wl.UniformDistributedTopicBean entity are as follows:
A reference name for a destination or a member of a distributed destination that provides a way to lookup that destination without JNDI using javax.jms.Session createQueue or createTopic. See "How to Lookup a Destination" in Programming JMS for more information on how to use this attribute.
This name must be unique within the scope of the JMS server to which this destination is targeted. However, it does not need to be unique within the scope of an entire JMS module or WebLogic Cluster. For example, two queues can have the same destination name as long as those queues are targeted to different JMS servers.
Note: Since this name must be unique within the scope of a JMS server, verify whether other JMS modules may contain destination names that conflict with this name. It is the responsibility of the deployer to resolve the destination names targeted to JMS servers.
Type: string
Constraints: Restart Required, Has Default Value: null
The global JNDI name used to look up the destination within the JNDI namespace.
In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the Local JNDI Name parameter.
If not specified, the destination name will not be advertised through the global JNDI namespace.
Type: string
Constraints: Has Default Value: null
Specifies whether a user can send messages to a destination using Store-and-Forward.
All All users can send messages to this destination using Store-and-Forward.
None Remote users can not send messages to a destination using Store-and-Forward.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages sent after the update has been made.
Type: string
Constraints: Restart Required, Has Default Value: All, Legal Values: All, None
Specifies whether messages landing on this destination should attach the credential of the sending user. You should consult the JMSXUserID documentation in Programming WebLogic JMS before using this feature.
Supports The JMSXUserID property is set with the security principal of the sending user if requested. The sender can request its identity to be attached to its messages by using a connection factory with the AttachJMSXUserID security property enabled.
Never The JMSXUserID property is never set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
Always The JMSXUserID property is always set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages received after the update has been made.
Type: string
Constraints: Has Default Value: supports, Legal Values: supports, never, always
Specifies whether consumption is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Consumption Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Consumption Paused is explicitly disabled for this destination.
true Consumption Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.
When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.
This field is recommended for advanced use. Generally, it is recommended to set a message unit-of-order using application calls or connection factory configuration. When relying on a destination default unit order to enforce ordering with a distributed destination, the application must be aware that unit-of-order routing doesn't apply. Instead the application must specifically ensure that any particular set of messages that must be processed in order are all sent to the same specific member destination even in the event of process failures or service migration.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The list of potential destination keys for sorting the messages that arrive on a JMS destination.
The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.
Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "Ascending" (FIFO) for the sort order.
Type: array of string
Constraints: Restart Required
The uniform distributed topic message Forwarding Policy specifies whether a sent message is forwarded to all members.
The valid values are:
Replicated - The default. All physical topic members receive each sent message. If a message arrives at one of the physical topic members, a copy of this message is forwarded to the other members of that uniform distributed topic. A subscription on any one particular member will get a copy of any message sent to the uniform distributed topic logical name or to any particular uniform distributed topic member.
Partitioned - The physical member receiving the message is the only member of the uniform distributed topic that is aware of the message. When a message is published to the logical name of a Partitioned uniform distributed topic, it will only arrive on one particular physical topic member. Once a message arrives on a physical topic member, the message is not forwarded to the rest of the members of the uniform distributed destination, and subscribers on other physical topic members do not get a copy of that message. The Partitioned capability was added in WebLogic 10.3.4 (11gR1PS3).
A publisher that uses a logical JNDI name of a Replicated distributed topic is created on one member and every send call publishes messages to the same member regardless the value of the Load Balancing Enabled attribute. This is behavior is backward compatible with previous WebLogic Server releases when using a uniform distributed topic. Under the same conditions, a Partitioned distributed topic publishes to the same member only when the value of the Load Balancing Enabled attribute is set to false. If the value of the Load Balancing Enabled attribute is to true, a publisher to a Partitioned distributed topic publishes messages that are load balanced accross all the members of the uniform distributed topic.
Most new applications will use the new Partitioned forwarding policy in combination with a logical subscription topology on a uniform distributed topic that consists of: (1) a same named physical subscription created directly on each physical member, (2) a Client ID Policy of Unrestricted, and (3) a Subscription Sharing Policy of Sharable. WL 10.3.4 Message Driven Beans (MDBs) provides a Topic Messages Distribution Mode option to automatically setup this kind of topology.
Type: string
Constraints: Restart Required, Has Default Value: Replicated, Legal Values: Partitioned, Replicated
Return the unique identifier of this bean instance.
Type: long
Constraints: Read Only, Restart Required
Specifies the maximum length of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the expiration policy defined for undeliverable messages.
Note: An error destination for UOW messages cannot be configured with a Unit-of-Work Handling Policy of Single Message Delivery value.
This attribute is effective only if the Unit-of-Work Handling Policy is set to Single Message Delivery value. A value of -1 means that UOW messages will never expire.
Type: int
Constraints: Has Default Value: -1
Specifies whether new message insertion is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Insertion Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Insertion Paused is explicitly disabled for this destination.
true Insertion Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Determines how messages are distributed to the members of this destination.
Choose from the following distribution techniques:
Round-Robin The system maintains an ordering of physical topic members within the set by distributing the messaging load across the topic members one at a time in the order that they are defined in the configuration file. Each WebLogic Server instance maintains an identical ordering, but may be at a different point within the ordering. If weights are assigned to any of the topic members in the set, then those members appear multiple times in the ordering.
Random The weight assigned to the topic members is used to compute a weighted distribution for the members of the set. The messaging load is distributed across the topic members by pseudo-randomly accessing the distribution. In the short run, the load will not be directly proportional to the weight. In the long run, the distribution will approach the limit of the distribution. A pure random distribution can be achieved by setting all the weights to the same value, which is typically set to 1.
Type: string
Constraints: Has Default Value: Round-Robin, Legal Values: Round-Robin, Random
The local JNDI name used to look up the destination within the JNDI namespace of the server where the destination resource is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.
A destination can have both a local JNDI name and a (global) JNDI name.
Type: string
Constraints: Has Default Value: null
The maximum size of a message that is accepted from producers on this destination.
The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: JMSCorrelationID and JMSType. Producers sending messages that exceed the configured maximum message size for the destination receive a ResourceAllocationException
The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
Controls how long destinations are willing to wait to create full batches of available messages (if at all) for delivery to consumers. At the minimum value, batching is disabled; at the default value, less-than-full batches will not wait and are delivered immediately with currently available messages; tuning higher than the default value controls the maximum wait time for additional messages before less-than-full batches are delivered to consumers.
The maximum message count of a full batch is controlled by the JMS connection factory's Messages Maximum setting.
Type: int
Constraints: Has Default Value: 25, Minimum Value: 0, Maximum Value: 100
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Type: string
Specifies whether new message production is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Production Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Production Paused is explicitly disabled for this destination.
true Production Paused is explicitly turned on for this destination.
Type: boolean
Constraints: Restart Required, Has Default Value: false
A Quota controls the allotment of system resources available to destinations. For example, the number of bytes a destination is allowed to store can be configured with a Quota.
Type: weblogic.j2ee.descriptor.wl.QuotaBean reference
Gets the name of the sub-deployment to use when targeting this entity
Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.
Type: string
Constraints: Restart Required
The JMS template from which the destination is derived. A template provides an efficient means of defining multiple destinations with similar configuration values.
If a JMS template is specified, destination parameters that are set to their default values will instead inherit their values from the JMS template at run-time. However, if a JMS template is not defined, then the configuration values for the destination must be specified as part of the destination.
Although you can dynamically modify the configuration of a JMS template, the configuration values on a destination are static.
Type: weblogic.j2ee.descriptor.wl.TemplateBean reference
Constraints: Restart Required
Determines how a distributed destination member is selected as the destination for a message that is part of a unit-of-order. Hash, indicates that a message producer computes the member destination from the hashCode of the unit-of-order. PathService indicates that the configured Path Service determines the member destination.
Unit-of-Order Routing can be set programmatically with WLProducer, or administratively on the connection factory or destination.
Unit of Order Routing is not dynamically configurable.
Type: string
Constraints: Restart Required, Has Default Value: Hash
Specifies whether the Unit-of-Work (UOW) feature is enabled for this destination. A UOW is a set of messages that are processed as a single unit.
Pass-Through By default, this destination does not treat messages as part of a UOW.
Single Message Delivery This value should only be selected if UOW consumers are receiving messages on this destination. When selected, UOW messages are formed into a list and are consumed as an ObjectMessage containing the list.
Type: string
Constraints: Has Default Value: PassThrough, Legal Values: PassThrough, SingleMessageDelivery
AdminConsoleMBean is a console specific MBean to configure weblogic administration console attributes.
The properties of the weblogic.management.configuration.AdminConsoleMBean entity are as follows:
Returns the log out URL for the Administration Console in a single sign-on (SSO) environment. Only needed when you use the Console with an SSO provider that requires a log out URL so that it can clean up its SSO session state. See the SSO provider documentation for details on the URL value
Type: string
Constraints: Has Default Value: null
Returns the Cookie Name used by the Administration Console.
Type: string
Constraints: Restart Required, Has Default Value: ADMINCONSOLESESSION
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specify the minimum number of threads that should be dedicated to the Administration Console. These threads are used to interact with managed servers in parallel for improved responsiveness in large domains. 5 is the smallest accepted number.
Type: int
Constraints: Has Default Value: 101, Minimum Value: 5
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Set to true if the Administration Console's session cookie is protected so that it is only visible to the Console. This may prevent use of this shared cookie in other applications.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Returns Session Timeout value (in seconds) for Administration Console.
Type: int
Constraints: Restart Required, Has Default Value: 3600
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The properties of the weblogic.management.configuration.AdminVirtualTargetMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Get the explicit port for this virtual target.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 65535
Host names, separated by line breaks, for which this virtual target will serve requests.
Type: array of string
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The channel name to be used as a reference for creating a partition specific channel.
Type: string
Constraints: Has Default Value: PartitionChannel
The port offset for this virtual target. If set to the minimum value, the port offset is not set.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 65535
Return all tags on this Configuration MBean
Type: array of string
You must select a target from this list of the targets in the current domain. Targets must be either servers or clusters. The deployment will only occur once if the targets overlap. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on server S only once.
Type: array of weblogic.management.configuration.TargetMBean references
Constraints: Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The URI prefix for this virtual target.
Type: string
Constraints: Has Default Value: /
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.
The properties of the weblogic.management.configuration.AppDeploymentMBean entity are as follows:
The fully resolved location of this application's alternate descriptor directory on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
The fully resolved location of this application's alternate descriptor on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
The fully resolved location of this application's installation root directory on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
The fully resolved location of this application's deployment plan directory on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
The fully resolved location of this application's deployment plan on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
The fully resolved location of this application's source files on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
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.
Type: string
Constraints: Read Only
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.
Type: string
Constraints: Read Only, Restart Required
The name of the application.
Note that the name of the current MBean is not the name of the application.
Type: string
Constraints: Read Only, Restart Required
Type: boolean
Constraints: Restart Required
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.
Type: string
Constraints: Restart Required
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.
Type: int
Constraints: Restart Required, Has Default Value: 100
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.
Type: string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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.
Type: string
Constraints: Read Only, Restart Required
The values match those defined by jsr88. This attribute may move to another MBean.
Type: string
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Determines if the modules of applications will be deployed in parallel.
Type: boolean
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.
Type: string
Constraints: Read Only
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.
Type: string
Constraints: Read Only
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.
Type: string
Constraints: Read Only, Has Default Value: null, Legal Values: nostage, stage, external_stage
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 weblogic.management.security.RealmMBean#getSecurityDDModel 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:
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.xml and restarting the server, the order of precedence is:
The value that you specify for the module in config.xml
The default value of this AppDeploymentMBean SecurityDDModel attribute.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: DDOnly, Legal Values: DDOnly, CustomRoles, CustomRolesAndPolicies, Advanced
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.
Type: string
Constraints: Read Only, Restart Required
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.
Type: string
Constraints: Read Only, Has Default Value: null, Legal Values: nostage, stage, external_stage
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
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.
Type: boolean
Constraints: Restart Required, Has Default Value: false
This attribute is not used in the current release.
Type: boolean
Constraints: Has Default Value: false
Uniquely identifies the application version across all versions of the same application.
If the application is not versioned, this returns null.
Type: string
Constraints: Read Only, Restart Required
The properties of the weblogic.management.configuration.AuthConfigProviderMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class represents the configuration for Batch Runtime.
The properties of the weblogic.management.configuration.BatchConfigMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The schema name where the JobRepository tables have been created. Note that if the JobRepository data source is shared by applications, then this schema name must be the same name that the application expects.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean represents the server-wide configuration of COM
The properties of the weblogic.management.configuration.COMMBean entity are as follows:
The address of the primary domain controller this server uses for authenticating clients. (If not specified, COM clients will not be authenticated.)
Type: string
Constraints: Restart Required
Controls the flag that is used to initialize COM in native mode.
By default, when jCOM initializes COM in native mode, it starts COM with the COINIT_MULTITHREADED. This causes COM to use Multi-Threaded Apartment (MTA) thread model. In the MTA model, calls to an object are not synchronized by COM. Multiple clients can concurrently call an object that supports this model on different threads, and the object must provide synchronization in its interface/method implementations using synchronization objects such as events, mutexes, semaphores, etc. MTA objects can receive concurrent calls from multiple out-of-process clients through a pool of COM-created threads belonging to the object's process.
If the server logs a Class Not Registered Message when starting COM in native mode, try setting this property. This will cause jCOM to start COM in native mode, using COINIT_APARTMENTTHREADED option instead of the COINIT_MULTITHREADED option. In a component that is marked as Apartment Threaded, each method of that component will execute on a thread that is associated with that component. This separates the methods into their own "Apartments", with each instance of a component corresponding to one apartment. While there is only one thread inside of a component, each instance of that component will have its own thread apartment.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies whether this server should log memory usage.
Type: boolean
Constraints: Restart Required, Has Default Value: false
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Specifies whether this server should use native DLLs to allow Java objects to interact with COM objects. (Supported on Windows only.)
Type: boolean
Constraints: Restart Required, Has Default Value: false
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.
Type: string
Specifies whether this server should prefetch the next element in a java.lang.Enumeration (that had been improperly converted from a COM VariantEnumeration type) so the correct value is returned when the hasMoreElements() method is called.
Some COM methods return a COM VariantEnumeration type. The java2com tool automatically converts the returned type into a java.lang.Enumeration. This is not a perfect match since COM enumerations have no equivalent to the hasMoreElements() call. The client must continue to call nextElement until a NoSuchElementException occurs. Setting this property will cause jCOM to prefetch the next element in behind the scenes and return the correct value when hasMoreElements is called.
Type: boolean
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies whether verbose logging is enabled.
Type: boolean
Constraints: Restart Required, Has Default Value: false
CapacityMBean defines the maximum number of requests that can be enqueued by all the work managers that share it.
The server starts rejecting requests once the capacity threshold is reached. Note that the capacity includes all requests, queued or executing, from the constrained work set. This constraint is independent of the global queue threshold specified by OverloadProtectionMBean#getSharedCapacityForWorkManagers().
Requests are rejected by performing overload actions. RMI work is rejected by sending back a recoverable exception to the clients. Servlet requests are rejected by sending back a 503 response.
The properties of the weblogic.management.configuration.CapacityMBean entity are as follows:
Total number of requests that can be enqueued.
Type: int
Constraints: Has Default Value: -1
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean is used to specify domain-wide defaults for the CDI container
The properties of the weblogic.management.configuration.CdiContainerMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
This flag may be used to limit implicit Bean discovery
Type: boolean
Constraints: Restart Required, Has Default Value: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Indicates the CDI policy. CDI can be "Enabled" (the default) or "Disabled". If CDI is disabled then no CDI processing will occur including scanning of pojos and initialization of Weld and CDI will not be available to the application via the CDI apis.
Type: string
Constraints: Restart Required, Has Default Value: Enabled, Legal Values: Enabled, Disabled
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean represents the configuration of certificate revocation checking for a specific certificate authority. Default values for attributes in this MBean are derived from CertRevocMBean
The properties of the weblogic.management.configuration.CertRevocCaMBean entity are as follows:
For this CA, determines whether certificate revocation checking is disabled.
Type: boolean
Constraints: Has Default Value: false
For this CA, determines whether the CRL Distribution Point background downloading, to automatically update the local CRL cache, is enabled.
Type: boolean
For this CA, determines the overall timeout for the Distribution Point CRL download, expressed in seconds.
The valid range is 1 thru 300 seconds.
Type: long
Constraints: Minimum Value: 1, Maximum Value: 300
For this CA, determines whether the CRL Distribution Point processing to update the local CRL cache is enabled.
Type: boolean
For this CA, determines the CRL Distribution Point URL to use as failover or override for the URL found in the CRLDistributionPoints extension in the certificate.
Type: string
Constraints: Has Default Value: null
For this CA, determines how getCrlDpUrl is used: as failover in case the URL in the certificate CRLDistributionPoints extension is invalid or not found, or as a value overriding the URL found in the certificate CRLDistributionPoints extension.
Type: string
Constraints: Has Default Value: FAILOVER, Legal Values: FAILOVER, OVERRIDE
Determines the identity of this per-CA configuration using the distinguished name (defined in RFC 2253), which is used in certificates issued by the represented certificate authority.
For example:
"CN=CertGenCAB, OU=FOR TESTING ONLY, O=MyOrganization, L=MyTown, ST=MyState, C=US"
This will be used to match this configuration to issued certificates requiring revocation checking.
Type: string
Constraints: Has Default Value: null
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
For this CA, determines whether certificate path checking should fail, if revocation status could not be determined.
Type: boolean
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
For this CA, determines the certificate revocation checking method order.
NOTE THAT omission of a specific method disables that method.
Type: string
Constraints: Legal Values: OCSP, CRL, OCSP_THEN_CRL, CRL_THEN_OCSP
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
For this CA, determines whether a nonce is sent with OCSP requests, to force a fresh (not pre-signed) response.
Type: boolean
For this CA, determines the explicitly trusted OCSP responder certificate issuer name, when the attribute returned by getOcspResponderExplicitTrustMethod is "USE_ISSUER_SERIAL_NUMBER".
The issuer name is formatted as a distinguished name per RFC 2253, for example "CN=CertGenCAB, OU=FOR TESTING ONLY, O=MyOrganization, L=MyTown, ST=MyState, C=US".
When getOcspResponderCertIssuerName returns a non-null value then the getOcspResponderCertSerialNumber must also be set.
Type: string
Constraints: Has Default Value: null
For this CA, determines the explicitly trusted OCSP responder certificate serial number, when the attribute returned by getOcspResponderExplicitTrustMethod is "USE_ISSUER_SERIAL_NUMBER".
The serial number is formatted as a hexidecimal string, with optional colon or space separators, for example "2A:FF:00".
When getOcspResponderCertSerialNumber returns a non-null value then the getOcspResponderCertIssuerName must also be set.
Type: string
Constraints: Has Default Value: null
For this CA, determines the explicitly trusted OCSP responder certificate subject name, when the attribute returned by getOcspResponderExplicitTrustMethod is "USE_SUBJECT".
The subject name is formatted as a distinguished name per RFC 2253, for example "CN=CertGenCAB, OU=FOR TESTING ONLY, O=MyOrganization, L=MyTown, ST=MyState, C=US".
In cases where the subject name alone is not sufficient to uniquely identify the certificate, then both the getOcspResponderCertIssuerName and getOcspResponderCertSerialNumber may be used instead.
Type: string
Constraints: Has Default Value: null
For this CA, determines whether the OCSP Explicit Trust model is enabled and how the trusted certificate is specified.
The valid values:
Explicit Trust is disabled
Identify the trusted certificate using the subject DN specified in the attribute getOcspResponderCertSubjectName
Identify the trusted certificate using the issuer DN and certificate serial number specified in the attributes getOcspResponderCertIssuerName and getOcspResponderCertSerialNumber, respectively.
Type: string
Constraints: Has Default Value: NONE, Legal Values: NONE, USE_SUBJECT, USE_ISSUER_SERIAL_NUMBER
For this CA, determines the OCSP responder URL to use as failover or override for the URL found in the certificate AIA. The usage is determined by getOcspResponderUrlUsage
Type: string
Constraints: Has Default Value: null
For this CA, determines how getOcspResponderUrl is used: as failover in case the URL in the certificate AIA is invalid or not found, or as a value overriding the URL found in the certificate AIA.
Type: string
Constraints: Has Default Value: FAILOVER, Legal Values: FAILOVER, OVERRIDE
For this CA, determines whether the OCSP response local cache is enabled.
Type: boolean
For this CA, determines the timeout for the OCSP response, expressed in seconds.
The valid range is 1 thru 300 seconds.
Type: long
Constraints: Minimum Value: 1, Maximum Value: 300
For this CA, determines the time tolerance value for handling clock-skew differences between clients and responders, expressed in seconds.
The validity period of the response is extended both into the future and into the past by the specified amount of time, effectively widening the validity interval.
The value is >=0 and <=900. The maximum allowed tolerance is 15 minutes.
Type: int
Constraints: Minimum Value: 0, Maximum Value: 900
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean represents the configuration of the certificate revocation checking across all certificate authorities. Many of the attributes in this MBean may be overridden per certificate authority using the specific CertRevocCaMBean
The properties of the weblogic.management.configuration.CertRevocMBean entity are as follows:
Determines whether certificate revocation checking is enabled.
Type: boolean
Constraints: Has Default Value: false
Determines the refresh period for the CRL local cache, expressed as a percentage of the validity period of the CRL.
For example, for a validity period of 10 hours, a value of 10% specifies a refresh every 1 hour.
The validity period is determined by the CRL, and is calculated as the (next reported update time) - (this update time).
The valid range is 1 through 100.
Type: int
Constraints: Has Default Value: 100, Minimum Value: 1, Maximum Value: 100
Determines the type of CRL cache, related to the physical storage of the CRLs. The ldap CRL cache type can be specified, but is not currently supported.
The value specified in this attribute determines which related CrlCacheType* attributes apply.
Type: string
Constraints: Restart Required, Has Default Value: FILE, Legal Values: FILE, LDAP
Determines whether the CRL Distribution Point background downloading, to automatically update the local CRL cache, is enabled.
Type: boolean
Constraints: Has Default Value: false
Determines the overall timeout for the Distribution Point CRL download, expressed in seconds.
The valid range is 1 thru 300 seconds.
Type: long
Constraints: Has Default Value: 10, Minimum Value: 1, Maximum Value: 300
Determines whether the CRL Distribution Point processing to update the local CRL cache is enabled.
Type: boolean
Constraints: Has Default Value: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Determines whether certificate path checking should fail, if revocation status could not be determined.
Type: boolean
Constraints: Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Determines the certificate revocation checking method order.
NOTE that omission of a specific method disables that method.
Type: string
Constraints: Has Default Value: OCSP_THEN_CRL, Legal Values: OCSP, CRL, OCSP_THEN_CRL, CRL_THEN_OCSP
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Determines whether a nonce is sent with OCSP requests, to force a fresh (not pre-signed) response.
Type: boolean
Constraints: Has Default Value: false
Determines the maximum number of entries supported by the OCSP response local cache. The minimum value is 1.
Type: int
Constraints: Has Default Value: 1024, Minimum Value: 1, Maximum Value: 2147483647
Determines whether the OCSP response local cache is enabled.
Type: boolean
Constraints: Has Default Value: true
Determines the refresh period for the OCSP response local cache, expressed as a percentage of the validity period of the response.
For example, for a validity period of 10 hours, a value of 10% specifies a refresh every 1 hour.
The validity period is determined by the OCSP response, and is calculated as the (next reported update time) - (this update time).
The valid range is 1 through 100.
Type: int
Constraints: Has Default Value: 100, Minimum Value: 1, Maximum Value: 100
Determines the timeout for the OCSP response, expressed in seconds.
The valid range is 1 thru 300 seconds.
Type: long
Constraints: Has Default Value: 10, Minimum Value: 1, Maximum Value: 300
Determines the time tolerance value for handling clock-skew differences between clients and responders, expressed in seconds.
The validity period of the response is extended both into the future and into the past by the specified amount of time, effectively widening the validity interval.
The value is >=0 and <=900. The maximum allowed tolerance is 15 minutes.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 900
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean represents a cluster in the domain. Servers join a cluster by calling ServerMBean.setCluster with the logical name of the cluster. A configuration may define zero or more clusters. They may be looked up by logical name.
The name of a cluster denotes its logical cluster name.
The properties of the weblogic.management.configuration.ClusterMBean entity are as follows:
Return the name of the table to be used for WAN session persistence.
Type: string
Constraints: Restart Required, Has Default Value: WLS_WAN_PERSISTENCE_TABLE
A migratable server could fail to come up on every possible configured machine. This attribute controls how many further attempts, after the first one, should be tried.
Note that each attempt specified here indicates another full circuit of migrations amongst all the configured machines. So for a 3-server cluster, and the default value of 3, a total of 9 migrations will be attempted.
If it is set to -1, migrations will go on forever until the server starts.
Type: int
Constraints: Restart Required, Has Default Value: 3
Interval in seconds until the producer thread will wait for the AsyncSessionQueue to become unblocked. Should be similar to the RequestTimeOut as that will determine the longest that the queue should remain full.
Type: int
Constraints: Has Default Value: 30
Return the name of the table to be used for server migration.
Type: string
Constraints: Restart Required, Has Default Value: ACTIVE
The set of machines (and order of preference) on which Node Manager will restart failed servers. (Requires you to enable each server for automatic migration.)
Each server can specify a subset of these cluster-wide candidates, which limits the machines on which the server can be restarted. Servers can also specify their own order of preference.
Type: array of weblogic.management.configuration.MachineMBean references
Constraints: Restart Required
Specifies whether to honor the WL-Proxy-Client-Cert header coming with the request or not.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
The address that forms a portion of the URL a client uses to connect to this cluster, and that is used for generating EJB handles and entity EJB failover addresses. (This address may be either a DNS host name that maps to multiple IP addresses or a comma-separated list of single address host names or IP addresses.)
Defines the address to be used by clients to connect to this cluster. This address may be either a DNS host name that maps to multiple IP addresses or a comma separated list of single address host names or IP addresses. If network channels are configured, it is possible to set the cluster address on a per channel basis.
Type: string
Constraints: Restart Required
Specifies the channel used to handle communications within a cluster. If no channel is specified the default channel is used.
ClusterBroadcastChannel is only are supported if the unicast messaging type is used.
Type: string
Constraints: Restart Required
Specifies the messaging type used in the cluster.
Multicast messaging is provided for backwards compatibility.
Type: string
Constraints: Restart Required, Has Default Value: unicast, Legal Values: multicast, unicast
Optimizes cross-cluster replication for the type of network that servers in the clusters use for administrative communication.
To enhance the reliability of HTTP sessions, you can configure servers in one cluster to replicate the session data to servers in a different cluster. In such an environment, configure the clusters to be one of the following types:
man
If the clustered servers can send their data through a metro area network (man) in which latency is negligible. With this ClusterType value, servers replicate session state synchronously and in memory only. For example, when serverA in cluster1 starts an HTTP session, its backup server, serverB in cluster2, immediately replicates this session in memory to Server B.
wan
If the clusters are far apart or send their data through a wide area network (wan) that experiences significant network latency. With this ClusterType value, a server replicates session state synchronously to the backup server in the same cluster and asynchronously to a server in the remote cluster. For example, when serverA in cluster1 starts an HTTP session, it sends the data to serverB in cluster1 and then asynchronously sends data to serverX in cluster 2. ServerX will persist the session state in the database.
If you persist session data in a replicating database, and if you prefer to use the database to replicate the data instead of WebLogic Server, choose a cluster type of wan and leave the remote cluster address undefined. WebLogic Server saves the session data to the local database and assumes that the database replicates data as needed.
Type: string
Constraints: Restart Required, Has Default Value: none, Legal Values: none, wan, man
Coherence Cluster associated with this cluster.
Type: weblogic.management.configuration.CoherenceClusterSystemResourceMBean reference
Constraints: Restart Required
The data source used by servers in the cluster during migration. (You must configure each Migratable Server within the cluster to use this data source.)
Type: weblogic.management.configuration.JDBCSystemResourceMBean reference
Constraints: Restart Required
Data source required to support persistence of jobs scheduled with the job scheduler
Type: weblogic.management.configuration.JDBCSystemResourceMBean reference
Constraints: Restart Required
To support HTTP Session failover across data centers, a datasource is required to dump session state on disk.
Type: weblogic.management.configuration.JDBCSystemResourceMBean reference
Constraints: Restart Required
The maximum number of times Database Leasing will try to obtain a valid connection from the Data Source.
Type: int
Constraints: Restart Required, Has Default Value: 1, Minimum Value: 1
The length of time, in milliseconds,Database Leasing will wait before attempting to obtain a new connection from the Data Source when a connection has failed.
Type: long
Constraints: Restart Required, Has Default Value: 1000
Defines the algorithm to be used for load-balancing between replicated services if none is specified for a particular service. The round-robin algorithm cycles through a list of WebLogic Server instances in order. Weight-based load balancing improves on the round-robin algorithm by taking into account a pre-assigned weight for each server. In random load balancing, requests are routed to servers at random.
Type: string
Constraints: Has Default Value: round-robin, Legal Values: round-robin, weight-based, random, round-robin-affinity, weight-based-affinity, random-affinity
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
During automatic migration, if the Cluster Master determines a server to be dead, it waits for this period of time (in milliseconds) before the Cluster Master migrates the service to another server in the cluster.
Type: int
Constraints: Restart Required, Has Default Value: 30000
The name of the HTTP port to which all redirected URLs will be sent.
Sets the FrontendHTTPPort for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.
Type: int
Constraints: Restart Required, Has Default Value: 0
The name of the secure HTTP port to which all redirected URLs will be sent.
Sets the FrontendHTTPSPort for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.
Type: int
Constraints: Restart Required, Has Default Value: 0
The name of the host to which all redirected URLs will be sent.
Sets the HTTP FrontendHost for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct HOST information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.
Type: string
Constraints: Restart Required, Has Default Value: null
Interval in seconds until HTTP Sessions are periodically flushed to secondary server.
Type: int
Constraints: Has Default Value: 3
Interval in milliseconds at which Migratable Servers and Cluster Masters prove their liveness via the database.
Type: int
Constraints: Restart Required, Has Default Value: 10000
Maximum number of periods that a cluster member will wait before timing out a Cluster Master and also the maximum number of periods the Cluster Master will wait before timing out a Migratable Server.
Type: int
Constraints: Restart Required, Has Default Value: 3, Minimum Value: 2
Returns the value of HttpTraceSupportEnabled.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Maximum number of periods that a cluster member will wait before timing out a member of a cluster.
Maximum number of periods that a cluster member will wait before timing out a member of a cluster.
Type: int
Constraints: Restart Required, Has Default Value: 3, Minimum Value: 3
If the cluster link between two clusters goes down, a trigger will run periodically to see if the link is restored. The duration is specified in milliseconds.
Type: int
Constraints: Has Default Value: 30000
The table name to use for storing timers active with the job scheduler
Type: string
Constraints: Restart Required, Has Default Value: WEBLOGIC_TIMERS
Enables faster Automatic Service Migration times with Database Leasing Basis.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Maximum number of seconds that a cluster member will wait to discover and synchronize with other servers in the cluster. Normally, the member will be able to sync in 30 seconds. If the value of this attribute is higher, that does not necessarily mean that it will take longer for the member to warmup. Instead it defines an upper bound on the time that a server will wait to sync with the servers that it has discovered. If the value is set 0, servers will not attempt to discover other running server in the cluster during server initialization
Type: int
Constraints: Minimum Value: 0
Forces unicast messages to be processed in order. There are scenarios where JMS may update JNDI very frequently. It will result in a lot of messages over unicast. Due to the close proximity of messages the probability of out of order handling of messages increases which would trigger frequent state dumps. Frequent JNDI tree refresh may result in NameNotFoundException. Use this property to prevent out of order handling of messages.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Returns all the MigratableTargets for this cluster
Type: array of weblogic.management.configuration.MigratableTargetMBean references
Constraints: Read Only
Controls the mechanism used for server and service migration.
Database -- Requires the availability of a high-availability database, such as Oracle RAC, to store leasing information.
Consensus -- Stores the leasing information in-memory within a cluster member. This option requires Node Manager to be configured and running.
Note: Within a WebLogic Server installation, you can only use one type of leasing. Although it is possible to implement multiple features that use leasing within your environment, each must use the same kind of leasing.
Type: string
Constraints: Restart Required, Has Default Value: database, Legal Values: database, consensus
Controls how long of a pause there should be between the migration attempts described in getAdditionalAutoMigrationAttempts(). Note that this delay only happens when the server has failed to come up on every machine.
Type: long
Constraints: Restart Required, Has Default Value: 180000
The multicast address used by cluster members to communicate with each other.
The valid range is from from 224.0.0.0 to 239.255.255.255. The default value used by WebLogic Server is 239.192.0.0. You should avoid using multicast addresses in the range x.0.0.1
This address should be unique to this cluster and should not be shared by other applications.
Type: string
Constraints: Restart Required, Has Default Value: 239.192.0.0
The multicast socket send/receive buffer size (at least 64 kilobytes).
Returns the multicast socket send/receive buffer size.
Type: int
Constraints: Restart Required, Has Default Value: 64, Minimum Value: 64
Enables multicast data to be encrypted. Only the multicast data is encrypted. Multicast header information is not encrypted.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The multicast port (between 1 and 65535) used by cluster members to communicate with each other.
Defines the multicast port used by cluster members to communicate with each other.
Type: int
Constraints: Restart Required, Has Default Value: 7001, Minimum Value: 1, Maximum Value: 65535
The amount of time (between 0 and 250 milliseconds) to delay sending message fragments over multicast in order to avoid OS-level buffer overflow.
Defines the number of milliseconds to delay sending message fragments over multicast in order to avoid OS-level buffer overflow.
Type: int
Constraints: Restart Required, Has Default Value: 3, Minimum Value: 0, Maximum Value: 250
The number of network hops (between 1 and 255) that a cluster multicast message is allowed to travel.
Defines the number of network hops that a cluster multicast message is allowed to travel. 1 restricts the cluster to one subnet.
Type: int
Constraints: Restart Required, Has Default Value: 1, Minimum Value: 1, Maximum Value: 255
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Number of servers to be listed from this cluster when generating a cluster address automatically. This setting has no effect if Cluster Address is explicitly set.
Type: int
Constraints: Restart Required, Has Default Value: 3, Minimum Value: 1
Indicates if one-way RMI is being used for replication. One-way RMI also requires configuring replication ports on each server in the cluster.
Type: boolean
Constraints: Restart Required, Has Default Value: false
When shutting down servers, sessions are not updated. If the primary and secondary servers of a session are shut down with no session updates, the session will be lost. Turning on PersistSessionsOnShutdown will save any active sessions to the database specified in ClusterMBean#getDataSourceForSessionPersistence() when a server is shutdown. The sessions will not be written at any other time. (For example, they are not saved via this mechanism if there is a server crash.)
This attribute is applicable both to session persistence on server shutdown or session persistence across a WAN.
Rolling upgrade can potentially have a bad interaction with traditional in-memory session replication. As managed servers are shutdown and upgraded, in-memory servlet sessions will be lost if both primary and secondary are rebooted before a new request arrives for the session.
Type: boolean
Constraints: Restart Required
Set the foreign cluster. Cluster infrastructure uses this address to connect to foreign cluster for HTTP Session WAN/MAN failover.
Type: string
Constraints: Restart Required
The channel name to be used for replication traffic. Cluster infrastructure uses this channel to send updates for HTTP sessions and stateful session beans. If none is set then the default channel will be used.
In order for this feature to work, the named channel must exist on all members of the cluster and must be configured to use the same protocol. It is valid for the selected channel to be configured to use a secure protocol.
Type: string
Constraints: Restart Required, Has Default Value: ReplicationChannel
Indicates if timeout should be applied to session replication calls.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Servers in a cluster replicate session data. If a replication channel is defined then the session data will be sent using the replication channel protocol and secured replication settings will be ignored. If no replication channel is defined and secured replication is enabled then session data for in-memory replication will be sent over SSL using the default secured channel. However, this added security for replication traffic comes with a significant cluster performance degradation. It should only be enabled if security is of greater concern than performance degradation.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The servers which have declared membership in this cluster.
Type: array of weblogic.management.configuration.ServerMBean references
Constraints: Read Only, Restart Required
The maximum time, in milliseconds seconds, for services to wait for response from cluster members.
Type: int
Constraints: Restart Required, Has Default Value: 10000
The number of seconds (between 0 and 65534) by which the age of two conflicting services must differ before one is considered older than the other.
Defines the number of seconds by which the age of two conflicting services must differ before one is considered older than the other.
Type: int
Constraints: Has Default Value: 180, Minimum Value: 0, Maximum Value: 65534
Interval in seconds until HTTP Sessions are periodically flushed to the backup cluster to dump session state on disk.
Type: int
Constraints: Has Default Value: 180
When number of sessions to be flushed reaches this threshold limit, sessions will be flushed to the backup cluster before the flush interval. This helps the server to flush sessions faster under load.
Type: int
Constraints: Has Default Value: 10000
Enables increased efficiency with session replication. Enabling this attribute should be used only when configuring a WebLogic domain for Oracle Exalogic.
Type: boolean
Indicates if session state query protocol is enabled. The Session State Query protocol will query the local cluster for the location of a session state instance if a request arrives at a server that is neither the primary or secondary server.
Type: boolean
Constraints: Has Default Value: false
The maximum time, in seconds, for session state query request to wait for response from cluster members.
Type: int
Constraints: Has Default Value: 30, Minimum Value: 1
Return all tags on this Configuration MBean
Type: array of string
If enabled, a server's transaction requests go to servers in the cluster that are already participating in the global transaction.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies if this cluster will receive requests from a proxy plug-in or HttpClusterServlet
Set this attribute to true if the cluster will receive requests from a proxy plug-in or HttpClusterServlet. A call to getRemoteAddr will return the address of the browser client from the proprietary WL-Proxy-Client-IP header instead of the Web server.
Set this attribute to false to disable the weblogic-plugin-enabled parameter, weblogic-plugin-enabled=false, in the config.xmlfile.
Note: If you are using Oracle HTTP Server, the WebLogic Proxy Plug-In, or Oracle Traffic Director to distribute client requests to a Managed Server or a cluster, Oracle recommends setting this attribute to true
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Information that represents a Coherence cache configuration.
The properties of the weblogic.management.configuration.CoherenceCacheConfigMBean entity are as follows:
The JNDI name this resource will be bound to.
Type: string
Constraints: Restart Required
Return the cache configuration file being used by this CoherenceCacheConfigMBean.
Type: string
Constraints: Restart Required
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.
Type: string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The values match those defined by jsr88. This attribute may move to another MBean.
Type: string
Constraints: Restart Required
Unique identifier for this bean instance.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean defines a system-level Coherence cluster resource. It links to a separate descriptor that specifies the definition.
The properties of the weblogic.management.configuration.CoherenceClusterSystemResourceMBean entity are as follows:
The list of hostnames of the managed servers belonging to this Coherence cluster.
Type: array of string
Constraints: Read Only, Restart Required
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.
Type: string
Constraints: Restart Required
The external custom Coherence cluster configuration file.
Type: string
Constraints: Read Only, Restart Required
The time when the custom configuration file used by the cluster was last updated
Type: long
Constraints: Read Only, Restart Required
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.
Type: int
Constraints: Restart Required, Has Default Value: 100
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.
Type: string
Constraints: Restart Required
The name of the file that contains the module configuration. By default the file resides in the DOMAIN_DIR/config/coherence/bean_name directory.
The module file derives its name from the bean name using the following pattern:
<beanName>.xml
Note that this is a read-only property that can only be set when the bean is created.
Type: string
Constraints: Read Only, Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The Coherence Cluster Listen Port of the remote participant.
Type: int
Constraints: Read Only, Restart Required
The Coherence Cluster Name of the remote participant cluster.
Type: string
Constraints: Read Only, Restart Required
The list of remote participant hosts, who will be added as participants in the federation topology.
Type: array of string
Constraints: Read Only, Restart Required
The federation topology.
Type: string
Constraints: Read Only, Restart Required
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The values match those defined by jsr88. This attribute may move to another MBean.
Type: string
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The active directory for the default persistence environment. If no value is specified, the directory which will be used is the coherence/active sub-directory under Domain Home directory.
Type: string
Constraints: Read Only, Restart Required
The default persistence mode.
Type: string
Constraints: Read Only, Restart Required
The snapshot directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/snapshot sub-directory under Domain Home directory.
Type: string
Constraints: Read Only, Restart Required
The trash directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/trash sub-directory under Domain Home directory.
Type: string
Constraints: Read Only, Restart Required
Get the report group file representing the superset of runtime metrics to be collected for this cluster.
Type: string
Constraints: Restart Required, Has Default Value: em/metadata/reports/coherence/report-group.xml
Return the Descriptor for the system resource. This should be overridden by the derived system resources.
Type: weblogic.descriptor.DescriptorBean reference
Constraints: Read Only, Restart Required
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies whether you are using a custom external Coherence cluster configuration file.
Type: boolean
Constraints: Restart Required
This class holds the connection information needed to connect to a Coherence server. Copyright (c) 2014,2015, Oracle and/or its affiliates. All Rights Reserved.
The properties of the weblogic.management.configuration.CoherenceManagementAddressProviderMBean entity are as follows:
The IP address/Host
Type: string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return the server port
Type: int
Constraints: Restart Required, Minimum Value: 1, Maximum Value: 65535
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class is used to hold JMX information about a coherence cluster in both the standalone case and WLS managed cluster case.
The properties of the weblogic.management.configuration.CoherenceManagementClusterMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Get JMX connection password
Type: string
Constraints: Restart Required, Encrypted
Get the report group file representing the superset of metrics this bean will gather.
Type: string
Constraints: Restart Required, Has Default Value: em/metadata/reports/coherence/report-group.xml
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Get the JMX connection username
Type: string
Constraints: Restart Required
This class represents Coherence Operational Configuration for a WLS Server that is part of a Coherence Cluster.
The properties of the weblogic.management.configuration.CoherenceMemberConfigMBean entity are as follows:
Specifies whether Federated Cache Storage is enabled for the Coherence Web cluster member
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether Local Storage is enabled for the Coherence Web cluster member
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies whether or not this member will contribute storage to the Coherence cluster i.e. maintain partitions. This attribute is used only when the WebLogic Server is not part of a WLS Cluster.
Type: boolean
Constraints: Restart Required, Has Default Value: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies the location within a geographic site where this member is hosted.
Type: string
Constraints: Restart Required
Specifies a name used to logically group similar members.
Type: string
Constraints: Restart Required
Specifies the name of the geographic site where this member is hosted.
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The IP address for the Coherence unicast listener.
Type: string
Constraints: Restart Required
The port for the Coherence unicast listener. A value of 0 indicates that the unicast listen port value will be assigned automatically to an ephemeral port.
Type: int
Constraints: Restart Required, Minimum Value: 0, Maximum Value: 65535
Get the upper bound of the unicast port. A positive value indicates the unicast port is automatically incremented if the specified port cannot be bound because it is already in use.
Type: int
Constraints: Restart Required, Minimum Value: 0, Maximum Value: 65535
The CoherencePartitionCacheConfigMBean is used to define which Coherence caches are shared/not-shared in an MT environment as well as specific cache properties that apply to deployments underneath a partition.
Note: the Name attribute is inherited from ConfigurationMBean and is a key only.
The properties of the weblogic.management.configuration.CoherencePartitionCacheConfigMBean entity are as follows:
The name of the GAR application that this setting should apply to.
Type: string
Constraints: Restart Required
The name of the cache that the settings should apply to.
Type: string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies whether you want this cache to be shared.
Type: boolean
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The CoherencePartitionCachePropertyMBean is used to define specific properties, name and value that apply to a CoherenceMTCacheConfigMBean.
Note: the Name attribute is inherited from ConfigurationMBean.
The properties of the weblogic.management.configuration.CoherencePartitionCachePropertyMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Get the value of the parameter
Type: string
Constraints: Restart Required
This class represents a Coherence stand-alone server.
The properties of the weblogic.management.configuration.CoherenceServerMBean entity are as follows:
Returns the timeout value to be used by NodeManagerRuntime when creating a socket connection to the agent. Default set high as SSH agent may require a high connection establishment time.
Type: int
Constraints: Restart Required, Has Default Value: 180000, Minimum Value: 0
Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.
Type: boolean
Constraints: Has Default Value: true
The system-level Coherence cluster resource associated with this server.
Type: weblogic.management.configuration.CoherenceClusterSystemResourceMBean reference
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The WebLogic Server host computer (machine) on which this server is meant to run.
If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager.
You cannot change this value if a server instance is already running.
Type: weblogic.management.configuration.MachineMBean reference
Constraints: Restart Required
An alphanumeric name for this server instance. (Spaces are not valid.)
The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.
The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.
After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.
Type: string
Constraints: Read Only, Restart Required
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.
Type: string
The number of seconds the Node Manager should wait before restarting this server.
After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails.
If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.
Type: int
Constraints: Has Default Value: 3600, Minimum Value: 300, Maximum Value: 2147483647
The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.
Type: int
Constraints: Has Default Value: 2, Minimum Value: 0, Maximum Value: 2147483647
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The IP address for the cluster unicast listener.
This attribute may be used to override the value of the referenced Coherence cluster.
Type: string
The port for the cluster unicast listener.
Type: int
Constraints: Minimum Value: 1, Maximum Value: 65535
Gets the upper bound of the unicast port. A positive value indicates the unicast port is automatically incremented if the specified port cannot be bound because it is already in use.
Type: int
Constraints: Has Default Value: 65535
This bean is used to configure the attributes necessary to start up a server on a remote machine.
The following describes how NodeManager applies each property when starting the Coherence server.
#getJavaVendor
The NodeManager does not pass this value invoking a java command line to start the server. It does pass this value in the environment variable JAVA_VENDOR to the start script.
#getJavaHome
This value can also be specified conveniently in the nodemanager .properties file using the coherence.startup.JavaHome or property. The NodeManager will pass this value to a start script using the JAVA_HOME environment variable. When issuing a java command line to start the server, the NodeManager will use the java executable from the specified location.
#getClassPath
The NodeManager will pass this value to a start script using the JAVA_OPTIONS environment variable containing -Djava.class.path. When issuinga java command line to start the server, the NodeManager will pass -Djava.class.path.
#getMWHome
This value can also be specified conveniently in the nodemanager .properties file using the coherence.startup.MWHome property. The NodeManager does not pass this value directly when starting a server. However, it uses this value to construct an appropriate classpath for starting the server.
#getArguments
This value can also be specified conveniently in the nodemanager .properties file using the coherence.startup.Arguments property. The NodeManager will pass this value to a start script using the JAVA_OPTIONS environment variable. When issuing a java command line to start the server, the NodeManager will pass the arguments as options.
The properties of the weblogic.management.configuration.CoherenceServerStartMBean entity are as follows:
The MWHome directory (path on the machine running Node Manager) to use when starting this server.
Specify the directory on the Node Manager machine under which all of Oracle's MW products were installed. For example, c:\Oracle\Middleware\
Type: string
The arguments to use when starting this server.
These are the first arguments appended immediately after java portion of the startup command. For example, you can set Java heap memory or specify any weblogic.nodemanager.server.provider.WeblogicCacheServer option.
Separate arguments with a space.
Type: string
The classpath (path on the machine running Node Manager) to use when starting this server.
If you need to add user classes to the classpath, in addition you will need to add the following: FEATURES_HOME/weblogic.server.modules.coherence.server_10.3.4.0.jar:COHERENCE_HOME/lib/coherence.jar
where FEATURES_HOME is the features directory (typically $MW_HOME/modules/features) and COHERENCE_HOME the coherence directory (typically $MW_HOME/coherence_3.6) on the Node Manager machine. If you do not specify a classpath the above will be used automatically.
The operating system determines which character separates path elements. On Windows, use a semicolon (;). On UNIX a colon (:).
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The Java home directory (path on the machine running Node Manager) to use when starting this server.
Specify the parent directory of the JDK's bin directory. For example, c:\bea\jdk141
Type: string
The Java Vendor value to use when starting this server.
If the server is part of a cluster and configured for automatic migration across possibly different platforms with different vendors providing the JDKs, then, both JavaVendor and JavaHome should be set in the generated configuration file instead.
Type: string
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
Type: string
Constraints: Read Only, Legal Null: true
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.
Type: string
The directory that this server uses as its root directory. This directory must be on the computer that hosts the Node Manager. If you do not specify a Root Directory value, the domain directory is used by default.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class represents Coherence Tier. A Coherence Tier is formed by one WLS Cluster.
The properties of the weblogic.management.configuration.CoherenceTierMBean entity are as follows:
Specifies whether Federated Cache Storage is enabled for the Coherence Web cluster member
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether Local Storage is enabled for the Coherence*Web cluster tier
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies whether Local Storage is enabled
Type: boolean
Constraints: Restart Required, Has Default Value: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Encapsulates information about a property, such as its value and whether it is encrypted.
The properties of the weblogic.management.configuration.ConfigurationPropertyMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies whether the property should be encrypted.
By default, the value of a property is not encrypted and anyone using the Administration Console can view the value of the property. If this attribute is set to true, then the value of the property on the Administration Console will be set to all asterisks.
Type: boolean
Constraints: Has Default Value: false
Specifies the decrypted value of the property.
Note: In release 10.3.1 of WebLogic Server, the behavior of the MBean encryption algorithm changed. In previous releases, if the newly set value was identical to the existing value, the encrypted value did not change. That is, you would always get the same encrypted value for a given password The action was not treated as a (non-dynamic) change. The behavior has been modified so that use of the setter on any existing encrypted value is considered to be a (dynamic) change, regardless of whether the new value matches the old value. Therefore, even if you set the password to the existing value, the setter now generates a different encrypted value for the given password.
Use this attribute if you have specified that property should be encrypted.
Type: string
Constraints: Encrypted, Has Default Value:
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies the value of the property.
If the property is encrypted, then attribute is null and one should use the EncryptedValue attribute to get the decrypted value.
Type: string
Constraints: Has Default Value:
This mbean defines the mapping between the current context (security principal, group etc) and the request class to use.
The properties of the weblogic.management.configuration.ContextCaseMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The name of the user group whose requests are to be processed by the request class with the name specified in RequestClassName.
Type: string
Constraints: Restart Required
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The name of the request class to be used for processing requests for the specified user and/or group.
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The name of the user whose requests are to be processed by the request class with the name specified in RequestClassName.
Type: string
Constraints: Restart Required
This mbean defines the mapping between the current context (security principal, group) and the request class to use.
ContextRequestClass provides a mapping between security names/groups and request classes. During work schedule, the exact request class is determined by looking at the security information of the caller. ContextRequestClass is not a request class by itself and is used to hold the mapping of request classes.
The properties of the weblogic.management.configuration.ContextRequestClassMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A {@code CpuUtilizationMBean} represents a resource consumption management policy for the "CPU Utilization" resource type.
The "CPU Utilization" resource type tracks the percentage of CPU time utilized by a Domain Partition with respect to the available CPU time to the Server runtime.
Triggers (Usage limits) and Fair share policies can be defined for a "CPU Utilization" resource type through this MBean.
The valid set of recourse action types for the "CPU Utilization" resource type are:
notify
slow
shutdown
The trigger value must be in the range [0..100]%.
The properties of the weblogic.management.configuration.CpuUtilizationMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A CustomResource is an untyped SystemResource for which creator of the bean defines the name of the class that will be used when the resource is deployed on the managed server.
The properties of the weblogic.management.configuration.CustomResourceMBean entity are as follows:
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.
Type: string
Constraints: Restart Required
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.
Type: int
Constraints: Restart Required, Has Default Value: 100
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.
Type: string
Constraints: Restart Required
Returns the interface of the bean that is returned by the #getResource method.
Type: string
Constraints: Restart Required
The name of the file that contains the module. By default the file resides in the DOMAIN_DIR/config directory.
By default, the file name is derived from the bean name using the following pattern:
<beanName>.xml
Note that this is a read-only property that can only be set when the bean is created.
Type: string
Constraints: Read Only, Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The values match those defined by jsr88. This attribute may move to another MBean.
Type: string
Constraints: Restart Required
Unique identifier for this bean instance.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return the Descriptor for the system resource. This should be overridden by the derived system resources.
Type: weblogic.descriptor.DescriptorBean reference
Constraints: Read Only, Restart Required
This is the name of the class that is used to manage the lifecycle of the resource. An instance of the ResourceClass is created and is passed the DescriptorBean. If this value is not set then the resource does not participate in the deployment lifecycle and simply represent a distribution of configuration information to be used by other subsystems.
Type: string
Constraints: Restart Required
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Defines the logging configuration for a DataSource.
The properties of the weblogic.management.configuration.DataSourceLogFileMBean entity are as follows:
Gets the underlying log buffer size in kilobytes
Type: int
Constraints: Has Default Value: 8
The date format pattern used for rendering dates in the log. The DateFormatPattern string conforms to the specification of the java.text.SimpleDateFormat class.
Type: string
Constraints: Legal Null: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)
Type: int
Constraints: Has Default Value: 7, Has Production Mode Default Value: 100, Minimum Value: 1, Maximum Value: 99999
The size (1 - 2097150 kilobytes) that triggers the server to move log messages to a separate file. The default is 500 kilobytes. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as SERVER_NAME.lognnnnn and create a new one to store subsequent messages. (Requires that you specify a file rotation type of Size.)
Type: int
Constraints: Has Default Value: 500, Has Production Mode Default Value: 5000, Minimum Value: 1, Maximum Value: 2097150
The name of the file that stores datasource profile records. Usually it is a computed value based on the name of the parent of this MBean. For example, for a datasource profile log, it is serverName.log
However, if the name of the parent cannot be obtained, the file name is weblogic.log. If you specify a relative pathname, it is interpreted as relative to the server's root directory.
To include a time and date stamp in the file name when the log file is rotated, add java.text.SimpleDateFormat variables to the file name. Surround each variable with percentage () characters.
For example, if the file name is defined to be myjmsserver_%yyyy%_%MM%_%dd%_%hh%_%mm%.log, the log file will be named myserver_yyyy_mm_dd_hh_mm.log
When the log file is rotated, the rotated file name contains the date stamp. For example, if the log file is rotated on 2 April, 2005 at 10:05 AM, the log file that contains the old messages will be named myserver_2005_04_02_10_05.log
If you do not include a time and date stamp, the rotated log files are numbered in order of creation. For example, myjmsserver.log00007
Type: string
Constraints: Restart Required
The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of TIME.)
Type: int
Constraints: Has Default Value: 24, Minimum Value: 1
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.
Type: string
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of SIZE or TIME.)
After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.
If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.
Type: boolean
Constraints: Has Default Value: true, Has Production Mode Default Value: true
Specifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.
Type: boolean
Constraints: Has Default Value: true, Has Production Mode Default Value: false
Determines the start time (hour and minute) for a time-based rotation sequence.
At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.
Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.
Use the following format: H:mm, where
is Hour in day (0-23)
mm is the minute in hour
Type: string
Constraints: Has Default Value: 00:00
Criteria for moving old log messages to a separate file.
NONE Messages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.
SIZE When the log file reaches the size that you specify in FileMinSize, the server renames the file as SERVER_NAME.lognnnnn
TIME At each time interval that you specify in TimeSpan, the server renames the file as SERVER_NAME.lognnnnn
After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.
Type: string
Constraints: Has Default Value: bySize, Legal Values: bySize, byTime, none
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean represents a DataSource within a Weblogic Server instance.
The properties of the weblogic.management.configuration.DataSourceMBean entity are as follows:
The JNDI name of a system resource data source used to override the default datasource.
Type: string
Constraints: Restart Required
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The security protocol used by an RMI client to access a data source. Values are:
Secure: All incoming JDBC calls require administrator authentication. All other subjects, including anonymous, are rejected. Requires a configured SSL listen port.
Compatibility: Use an unsecure channel with the application's subject and no check for inbound administrator authentication when using RMI to access a data source. This setting reflects the legacy implementation behavior for RMI access to a data source and is a potential security vulnerability as it provides a client uncontrolled access to a database.
The default value is Compatibility.
Type: string
Constraints: Restart Required, Has Default Value: Compatibility
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This interface provides access to the DataSourcePartition configuration attributes. The methods defined herein are applicable for DataSource configuration at the partition level.
The properties of the weblogic.management.configuration.DataSourcePartitionMBean entity are as follows:
The JNDI name of a system resource data source used to override the default datasource.
Type: string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
DatabaseLessLeasingBasisMBean defines attributes related to the functioning of singleton services and server migration without the use of a HA database.
The properties of the weblogic.management.configuration.DatabaseLessLeasingBasisMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Gets the MemberDiscoveryTimeout value. This value defines the amount of time a server waits during or after startup to discover members that belong to the same cluster. This information is used to join or form a new cluster.
Type: int
Constraints: Restart Required, Has Default Value: 30, Minimum Value: 10
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Dynamic Debug patches configuration.
The properties of the weblogic.management.configuration.DebugPatchesMBean entity are as follows:
Type: string
Constraints: Restart Required, Has Default Value: debug_patches
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This interface captures whether the enabled state of a debug scope. The name of a debug scope is the fully qualified scope name for example weblogic.security.SSL
The properties of the weblogic.management.configuration.DebugScopeMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Gets the enabled state of the debug scope mbean. By default a debug scope is disabled.
Type: boolean
Constraints: Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
It seems that the getter must be overriden because the setter is.
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean describes the configuration of the default file store. Each WebLogic Server instance has a default file store.
The properties of the weblogic.management.configuration.DefaultFileStoreMBean entity are as follows:
The smallest addressable block, in bytes, of a file. When a native wlfileio driver is available and the block size has not been configured by the user, the store selects the minimum OS specific value for unbuffered (direct) I/O, if it is within the range [512, 8192].
A file store's block size does not change once the file store creates its files. Changes to block size only take effect for new file stores or after the current files have been deleted. See "Tuning the Persistent Store" in Tuning Performance of Oracle WebLogic Server
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 8192
The location of the cache directory for Direct-Write-With-Cache, ignored for other policies.
When Direct-Write-With-Cache is specified as the SynchronousWritePolicy, cache files are created in addition to primary files (see Directory for the location of primary files). If a cache directory location is specified, the cache file path is CacheDirectory/WLStoreCache/StoreNameFileNum.DAT.cache. When specified, Oracle recommends using absolute paths, but if the directory location is a relative path, then CacheDirectory is created relative to the WebLogic Server instance's home directory. If "" or Null is specified, the Cache Directory is located in the current operating system temp directory as determined by the java.io.tmpdir Java System property (JDK's default: /tmp on UNIX, %TEMP% on Windows) and is TempDirectory/WLStoreCache/DomainNameunique-idStoreNameFileNum.DAT.cache. The value of java.io.tmpdir varies between operating systems and configurations, and can be overridden by passing -Djava.io.tmpdir=My_path on the JVM command line.
Considerations:
Security: Some users may want to set specific directory permissions to limit access to the cache directory, especially if there are custom configured user access limitations on the primary directory. For a complete guide to WebLogic security, see "Securing a Production Environment for Oracle WebLogic Server."
Additional Disk Space Usage: Cache files consume the same amount of disk space as the primary store files that they mirror. See Directory for the location of primary store files.
Performance: For the best performance, a cache directory should be located in local storage instead of NAS/SAN (remote) storage, preferably in the operating system's temp directory. Relative paths should be avoided, as relative paths are located based on the domain installation, which is typically on remote storage. It is safe to delete a cache directory while the store is not running, but this may slow down the next store boot.
Preventing Corruption and File Locking: Two same named stores must not be configured to share the same primary or cache directory. There are store file locking checks that are designed to detect such conflicts and prevent corruption by failing the store boot, but it is not recommended to depend on the file locking feature for correctness. See Enable File Locking
Boot Recovery: Cache files are reused to speed up the File Store boot and recovery process, but only if the store's host WebLogic Server instance has been shut down cleanly prior to the current boot. For example, cache files are not re-used and are instead fully recreated: after a kill -9, after an OS or JVM crash, or after an off-line change to the primary files, such as a store admin compaction. When cache files are recreated, a Warning log message 280102 is generated.
Fail-Over/Migration Recovery: A file store safely recovers its data without its cache directory. Therefore, a cache directory does not need to be copied or otherwise made accessible after a fail-over or migration, and similarly does not need to be placed in NAS/SAN storage. A Warning log message 280102, which is generated to indicate the need to recreate the cache on the new host system, can be ignored.
Cache File Cleanup: To prevent unused cache files from consuming disk space, test and developer environments should periodically delete cache files.
Type: string
Constraints: Has Default Value: null, Legal Null: true
The path name to the file system directory where the file store maintains its data files.
When targeting a file store to a migratable target, the store directory must be accessible from all candidate server members in the migratable target.
For highest availability, use either a SAN (Storage Area Network) or other reliable shared storage.
Use of NFS mounts is discouraged, but supported. Most NFS mounts are not transactionally safe by default, and, to ensure transactional correctness, need to be configured using your NFS vendor documentation in order to honor synchronous write requests.
For SynchronousWritePolicy of Direct-Write-With-Cache, see Cache Directory.
Additional O/S tuning may be required if the directory is hosted by Microsoft Windows, see Synchronous Write Policy for details.
Type: string
Constraints: Restart Required, Has Default Value: null, Legal Null: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Determines whether OS file locking is used.
When file locking protection is enabled, a store boot fails if another store instance already has opened the store files. Do not disable this setting unless you have procedures in place to prevent multiple store instances from opening the same file. File locking is not required but helps prevent corruption in the event that two same-named file store instances attempt to operate in the same directories. This setting applies to both primary and cache files.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The initial file size, in bytes.
Set InitialSize to pre-allocate file space during a file store boot. If InitialSize exceeds MaxFileSize, a store creates multiple files (number of files = InitialSizeMaxFileSize rounded up).
A file store automatically reuses the space from deleted records and automatically expands a file if there is not enough space for a new write request.
Use InitialSize to limit or prevent file expansions during runtime, as file expansion introduces temporary latencies that may be noticeable under rare circumstances.
Changes to initial size only take effect for new file stores, or after any current files have been deleted prior to restart.
See Maximum File Size
Type: long
Constraints: Has Default Value: 0, Minimum Value: 0
The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.
For the Direct-Write-With-Cache policy when a native wlfileio driver is available, IOBufferSize describes the maximum portion of a cache view that is passed to a system call. This portion does not consume off-heap (native) or Java heap memory.
For the Direct-Write and Cache-Flush policies, IOBufferSize is the size of a per store buffer which consumes off-heap (native) memory, where one buffer is allocated during run-time, but multiple buffers may be temporarily created during boot recovery.
When a native wlfileio driver is not available, the setting applies to off-heap (native) memory for all policies (including Disabled).
For the best runtime performance, Oracle recommends setting IOBufferSize so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).
For the best boot recovery time performance of large stores, Oracle recommends setting IOBufferSize to at least 2 megabytes.
See AllocatedIOBufferBytes to find out the actual allocated off-heap (native) memory amount. It is a multiple of IOBufferSize for the Direct-Write and Cache-Flush policies, or zero.
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 67108864
The maximum file size, in bytes.
The MaxFileSize value affects the number of files needed to accommodate a store of a particular size (number of files = store size/MaxFileSize rounded up).
A file store automatically reuses space freed by deleted records and automatically expands individual files up to MaxFileSize if there is not enough space for a new record. If there is no space left in exiting files for a new record, a store creates an additional file.
A small number of larger files is normally preferred over a large number of smaller files as each file allocates Window Buffer and file handles.
If MaxFileSize is larger than 2^24 * BlockSize, then MaxFileSize is ignored, and the value becomes 2^24 * BlockSize. The default BlockSize is 512, and 2^24 * 512 is 8 GB.
See Initial Size
Type: long
Constraints: Has Default Value: 1342177280, Minimum Value: 1048576, Maximum Value: 2139095040
The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per primary store file. Applies to synchronous write policies Direct-Write-With-Cache and Disabled but only when the native wlfileio library is loaded.
A window buffer does not consume Java heap memory, but does consume off-heap (native) memory. If the store is unable to allocate the requested buffer size, it allocates smaller and smaller buffers until it reaches MinWindowBufferSize, and then fails if cannot honor MinWindowBufferSize
Oracle recommends setting the max window buffer size to more than double the size of the largest write (multiple concurrently updated records may be combined into a single write), and greater than or equal to the file size, unless there are other constraints. 32-bit JVMs may impose a total limit of between 2 and 4GB for combined Java heap plus off-heap (native) memory usage.
See store attribute AllocatedWindowBufferBytes to find out the actual allocated Window Buffer Size.
See Maximum File Size and Minimum Window Buffer Size
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 1073741824
The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per primary store file. Applies to synchronous write policies Direct-Write-With-Cache and Disabled, but only when a native wlfileio library is loaded. See Maximum Window Buffer Size
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 1073741824
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The disk write policy that determines how the file store writes data to disk.
This policy also affects the JMS file store's performance, scalability, and reliability. Oracle recommends Direct-Write-With-Cache which tends to have the highest performance. The default value is Direct-Write. The valid policy options are:
Direct-Write Direct I/O is supported on all platforms. When available, file stores in direct I/O mode automatically load the native I/O wlfileio driver. This option tends to out-perform Cache-Flush and tend to be slower than Direct-Write-With-Cache. This mode does not require a native store wlfileio driver, but performs faster when they are available.
Direct-Write-With-Cache Store records are written synchronously to primary files in the directory specified by the Directory attribute and asynchronously to a corresponding cache file in the Cache Directory. The Cache Directory provides information about disk space, locking, security, and performance implications. This mode requires a native store wlfileiocode driver. If the native driver cannot be loaded, then the write mode automatically switches to Direct-Write. See Cache Directory
Cache-Flush Transactions cannot complete until all of their writes have been flushed down to disk. This policy is reliable and scales well as the number of simultaneous users increases.Transactionally safe but tends to be a lower performer than direct-write policies.
Disabled Transactions are complete as soon as their writes are cached in memory, instead of waiting for the writes to successfully reach the disk. This is the fastest policy because write requests do not block waiting to be synchronized to disk, but, unlike other policies, is not transactionally safe in the event of operating system or hardware failures. Such failures can lead to duplicate or lost data/messages. This option does not require native store wlfileio drivers, but may run faster when they are available. Some non-WebLogic JMS vendors default to a policy that is equivalent to Disabled
Notes:
When available, file stores load WebLogic wlfileio native drivers, which can improve performance. These drivers are included with Windows, Solaris, Linux, and AIX WebLogic installations.
Certain older versions of Microsoft Windows may incorrectly report storage device synchronous write completion if the Windows default Write Cache Enabled setting is used. This violates the transactional semantics of transactional products (not specific to Oracle), including file stores configured with a Direct-Write (default) or Direct-Write-With-Cache policy, as a system crash or power failure can lead to a loss or a duplication of records/messages. One of the visible symptoms is that this problem may manifest itself in high persistent message/transaction throughput exceeding the physical capabilities of your storage device. You can address the problem by applying a Microsoft supplied patch, disabling the Windows Write Cache Enabled setting, or by using a power-protected storage device. See http://support.microsoft.com/kb/281672 and http://support.microsoft.com/kb/332023.
NFS storage note: On some operating systems, native driver memory-mapping is incompatible with NFS when files are locked. Stores with synchronous write policies Direct-Write-With-Cache or Disabled, and WebLogic JMS paging stores enhance performance by using the native wlfileio driver to perform memory-map operating system calls. When a store detects an incompatibility between NFS, file locking, and memory mapping, it automatically downgrades to conventional read/write system calls instead of memory mapping. For best performance, Oracle recommends investigating alternative NFS client drivers, configuring a non-NFS storage location, or in controlled environments and at your own risk, disabling the file locks (See Enable File Locking). For more information, see "Tuning the WebLogic Persistent Store" in Tuning Performance of Oracle WebLogic Server
Type: string
Constraints: Has Default Value: Direct-Write, Legal Values: Disabled, Cache-Flush, Direct-Write, Direct-Write-With-Cache
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies the domain-level deployment configuration attributes.
The properties of the weblogic.management.configuration.DeploymentConfigurationMBean entity are as follows:
The maximum number of times the Deployment Service will retry sending a message if a connection exception occurs during the during a deployment or activate changes operation.
Type: int
Constraints: Has Default Value: 60, Minimum Value: 0
The number of milliseconds between retry attempts if a connection exception occurs during the during the deployment or activate changes operation.
Type: int
Constraints: Has Default Value: 5000, Minimum Value: 0
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The maximum number of times the thread dump generation will be retried on a long running Retire operation
Type: int
Constraints: Has Default Value: 3, Minimum Value: 0
The number of milliseconds between thread dump retry on a long running Retire operation.
Type: long
Constraints: Has Default Value: 60000, Minimum Value: 0
The number of milliseconds a thread dump generation will start for a long running Retire operation.
Type: long
Constraints: Has Default Value: 1200000, Minimum Value: 0
Gets the value of the maximum number of retired tasks to save information for.
Type: int
Constraints: Restart Required, Has Default Value: 20
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies whether the Remote Deployer EJB is automatically deployed in the current domain. The Remote Deployer EJB is only used by the weblogic.Deployer tool in the WLS 9.0 and 9.1 releases when the -remote option is specified.
If the Remote Deployer EJB is not deployed, you will not be able to use the -remote option in weblogic.Deployer running in a 9.0 or 9.1 installation. You can still use the -remote option from weblogic.Deployer in 9.2 or later releases.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Specifies whether applications with staging mode of STAGE are restaged only during redeploy operation. If set to true, then applications will never restage during server startup and will only be restaged on an explicit redeploy operation.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies the deployment validation plug-in configuration attributes. The plug-in factory must have a no-argument constructor and must implement this interface: weblogic.deployment.configuration.DeploymentValidationPluginFactory
The properties of the weblogic.management.configuration.DeploymentValidationPluginMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Gets the classname of the plug-in factory used for validation. This is a fully qualified name. The class must be in the Administration Server classpath.
Type: string
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A WebLogic Domain is a group of servers and/or clusters which are administered as a group.
The properties of the weblogic.management.configuration.DomainMBean entity are as follows:
Type: string
Constraints: Restart Required
The common secure administration port for this WebLogic Server domain. (Requires you to enable the administration port.)
Type: int
Constraints: Has Default Value: 9002, Minimum Value: 1, Maximum Value: 65535
Specifies whether the domain-wide administration port should be enabled for this WebLogic Server domain. Because the administration port uses SSL, enabling the administration port requires that SSL must be configured for all servers in the domain.
The domain-wide administration port enables you to start a WebLogic Server instance in STANDBY state. It also allows you to separate administration traffic from application traffic in your domain. Because all servers in the domain must enable or disable the administration port at once, you configure the default administration port settings at the domain level.
If you enable the administration port:
The administration port accepts only connections that specify administrator credentials.
Connections that specify administrator credentials can use only the administration port.
The command that starts managed servers must specify a secure protocol and the administration port: -Dweblogic.management.server=https://admin_server:administration_port
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: false
The default protocol for communicating through the administration port or administration channels. (Requires you to enable the administration port or to create an administration channel.)
If requests through the administration port or an administration channel do not specify a protocol, WebLogic Server uses the protocol specified here.
Valid admin protocols are:
t3s
https
iiops
Type: string
Constraints: Restart Required, Has Default Value: t3s
The number of archival versions of config.xml saved by the Administration Server each time the domain configuration is modified.
Type: int
Constraints: Restart Required, Has Default Value: 0
Returns the Batch DataSource jndi name. This jndi name will be used to lookup an instance of a DataSource that will be used to store the Batch jobs data.
Type: string
Returns the name of the application-scoped ManagedExecutorService. This ManagedExecutorService instance will be used to run batch jobs that are submitted from applications deployed to the domain. The ManagedExecutorServiceTemplate by the same name must exit when a batch job is submitted in the domain. If this returns null, then the batch runtime will look to use the default Java EE ManagedExecutorService that is bound to the JNDI name: java:comp/DefaultManagedExecutorService
Type: string
Specifies that deployments targeted to a cluster succeed only if all servers in the cluster are running.
By default, cluster constraints are disabled and deployment is attempted only on the servers that are reachable at the time of deployment from the Administration Server. Any servers that have been shut down or are temporarily partitioned from the Administration Server will retrieve the deployment during server startup or shortly after the network partition is resolved.
Type: boolean
Constraints: Restart Required, Has Default Value: false
If true, then backups of the configuration will be made during server boot.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Returns the criteria used for auditing configuration events (configuration changes and other operations):
CONFIG_CHANGE_NONE Configuration events will neither be written to the server log or directed to the Security Audit Framework.
CONFIG_CHANGE_LOG Configuration events will be written to the server log.
CONFIG_CHANGE_AUDITConfiguration events will be directed to the Security Audit Framework.
CONFIG_CHANGE_LOG_AND_AUDIT Configuration events will be written to the server log and directed to the Security Audit Framework.
Type: string
Constraints: Has Secure Value: audit, Has Default Value: none, Legal Values: none, log, audit, logaudit
The release identifier for the configuration. This identifier will be used to indicate the version of the configuration. All server generated configurations will be established with the release identifier of the running server. The form of the version is major.minor.servicepack.rollingpatch. Not all parts of the version are required. i.e. "7" is acceptable.
Type: string
Constraints: Has Default Value: null
The context path that you want to use in URLs that specify the Administration Console. (Requires you to enable the Administration Console for the current domain.)
To access the Administration Console, you use the following URL: http://listen-addesslisten-portcontext-path. For example, if you set the context path to myconsole, then you use the following URL to access the Administration Console: http://localhost:7001/myconsole
To specify the listen address and listen port that you use to access the Administration Console, configure the listen address and listen port of the Administration Server.
Type: string
Constraints: Restart Required, Has Default Value: console
Specifies whether the Administration Server automatically deploys the Administration Console in the current domain.
If the Administration Console is not deployed, you can still use the WebLogic Scripting Tool or the management APIs to configure and monitor the domain.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: true
Returns the directory path that console extensions are loaded from.
Type: string
Constraints: Restart Required, Has Default Value: console-ext
Returns the DeploymentsMBeans representing the deployments that have been deployed to be part of this domain.
Type: array of weblogic.management.configuration.DeploymentMBean references
Constraints: Read Only, Restart Required
Specifies whether WLDF sends a pre-12.2.1-style diagnostic context along with the current-style diagnostic context.
If outbound communication to pre-12.2.1 servers is possible, this setting should always be enabled to ensure that those servers receive a diagnostic context that they can process. Disabling this setting in those scenarios can result in correlation information being lost across tiers, and in information reported by WLDF and DMS to become of sync in some situations.
If there is no outbound communication to pre-12.2.1 servers possible, it is suggested to disable this mode as only the current-style diagnostic context is needed to be propagated outbound (propagating the old style will not cause a failure, but is unnecessary overhead in that situation).
This setting affects outbound only, inbound pre-12.2.1 style diagnostic contexts are always understood and handled.
Type: boolean
Constraints: Has Default Value: true
Defines the common version of all servers in a domain. In a domain containing servers that are not all at the same release version, this attribute is used to determine the feature level that servers will assume.
The value must be less than or equal to the version of any managed server in the domain.
If this value is not equal to the version of the release version of the admin server, then the admin server will not be allowed to make modifications to the configuration.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies the class loading behavior for embedded adapters. If you enable this option, embedded adapters deployed to all partitions in the domain will use Java EE compliant class loading. The embedded adapter's classes will be accessible from other modules in the same application.
Type: boolean
Specifies whether optimizations for Oracle Exalogic should be enabled. Optimizations include improved thread management and request processing, and reduced lock contention. This attribute should be enabled only when configuring a WebLogic domain for Oracle Exalogic.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies whether internal applications such as the console, uddi, wlstestclient, and uddiexplorer are deployed on demand (first access) instead of during server startup.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies whether the Administration Server automatically deploys the Java Service Administration Console in the current domain.
Type: boolean
Constraints: Restart Required
Specifies whether features to support the use of this WebLogic Server as a Java Service in a cloud environment should be enabled.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return the last time this domain was updated. This is guaranteed to be unique for a given transactional modification.
Type: long
Constraints: Read Only, Restart Required
Configures whether log messages will be logged in legacy format without supplemental attributes.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The maximum number of running long-running requests that can be submitted to all the Managed Executor Services or Managed Scheduled Executor Services in the global/domain partition on the current server.
Type: int
Constraints: Has Default Value: 50, Minimum Value: 0, Maximum Value: 65534
The maximum number of running threads that can be created by all the Managed Thread Factories in the global/domain partition on the current server.
Type: int
Constraints: Has Default Value: 50, Minimum Value: 0, Maximum Value: 65534
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Determines if the modules of applications will be deployed in parallel. This setting can be overridden at the per-partition or per-application levels. See AppDeploymentMBean#isParallelDeployModules()
Type: boolean
Constraints: Has Default Value: false
Determines if applications will be deployed in parallel. This setting can be overridden at the per-partition level. See PartitionMBean#isParallelDeployApplications()
Type: boolean
The URI prefix used for partition administrative virtual targets.
Type: string
Constraints: Restart Required, Has Default Value: /partitions
Specifies whether all servers in this domain run in production mode.
You can configure servers in your domain to start in one of two modes, development or production. You use development mode while you are developing your applications. Development mode uses a relaxed security configuration and enables you to auto-deploy applications. You use production mode when your application is running in its final form. A production domain uses full security and may use clusters or other advanced features.
The runtime mode is a domain-wide setting. As each Managed Server starts, it refers to the mode of the Administration Server to determine its runtime mode. If you configure the domain to run in production mode, the Administration Server saves this setting to the domain's configuration document.
Type: boolean
Constraints: Restart Required
Return the root directory for the domain. In other words for a server process [ServerMBean.getRootDirectory] or [ServerMBean.getDomainDirectory]
Type: string
Constraints: Read Only, Restart Required
Gets the history size of server migrations.
A value of -1 indicates that the history size is unlimited.
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 2147483647
Gets the history size of service migrations.
A value of -1 indicates that the history size is unlimited.
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 2147483647
The name of the site this domain is associated with.
Type: string
Return the SystemResourceMBeans in this Domain.
Type: array of weblogic.management.configuration.SystemResourceMBean references
Constraints: Read Only, Restart Required
Return all tags on this Configuration MBean
Type: array of string
Define targets for this Domain
Type: array of weblogic.management.configuration.TargetMBean references
Constraints: Read Only, Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Contains the properties used to control how dynamic servers are created. These properties allow you to control if listens ports are calculated, how servers are assigned to machines, and the number of dynamic servers to create.
The properties of the weblogic.management.configuration.DynamicServersMBean entity are as follows:
Specifies whether listen ports are calculated.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The CalculatedMachineNames attribute controls how server instances in a dynamic cluster are assigned to a machine. If the attribute is not set, then the dynamic servers will not be assigned to a machine. If the attribute is set, then the MachineNameMatchExpression attribute is used to select the set of machines to use for the dynamic servers.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Get the cool-off period (in seconds) used by the Elasticity Framework while performing scale up or scale down operations. If a scale up or scale down operation was performed, subsequent requests for scale up or down operations will be ignored by the Elasticity Framework during this period.
Type: int
Constraints: Has Default Value: 900, Minimum Value: 0
Get the timeout period (in seconds) used by the Elasticity Framework while gracefully shutting down a server. If the server does not shut down before the specified timeout period, the server will be forcibly shut down. With a negative time value, no timeout will be applied.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Get the current size of the dynamic cluster (the number of dynamic server instances allowed to be created). The specified number of server instances are dynamically added to the configuration at runtime and associated ServerLifeCycleRuntimeMBeans are created.
Type: int
Constraints: Minimum Value: 0, Maximum Value: 800
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Indicates if the Elasticity Framework should ignore inflight HTTP sessions while shutting down servers.
Type: boolean
Constraints: Has Default Value: false
Get the machine tag expression to use when selecting machine names. If the MachineMatchType is "name", each value will either match a machine name exactly or, if specified with a trailing '*' suffix, will match multiple machine names. If the MachineMatchType is "tag", the values will match all of the machines that have all of the tag values.
Type: string
Constraints: Restart Required
Get the machine tag expression to use when selecting machine names. If the MachineMatchType is "name", each value will either match a machine name exactly or, if specified with a trailing '*' suffix, will match multiple machine names. If the MachineMatchType is "tag", the values will match all of the machines that have all of the tag values.
Type: string
Constraints: Restart Required, Has Default Value: name, Legal Values: name, tag
The expression is used when determining machines to use for server assignments. If null, then all machines in the domain are used. If a expression is provided, then only the machines in the domain that match the expression will be used when assigning machine names to dynamic servers. The expression is a comma separated set of values that specify the machines to match. Each value will either match a machine name exactly or if specified with a trailing '*' suffix, the value will match multiple machine names.
Type: string
Constraints: Restart Required
Get the upper bound on the DynamicClusterSize that the Elasticity Framework is allowed to assign to DynamicClusterSize.
Type: int
Constraints: Has Default Value: 8, Minimum Value: 0, Maximum Value: 800
Get the minimum number of running server instances that the Elasticity Framework will attempt to keep in the dynamic cluster.
Type: int
Constraints: Has Default Value: 1, Minimum Value: 0, Maximum Value: 800
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The server name prefix is used to specify the naming convention when creating server names. When the server name prefix is defined, server names are calculated with the specified prefix followed by the index starting with 1.
Type: string
Constraints: Restart Required
The server template used to create dynamic servers.
Type: weblogic.management.configuration.ServerTemplateMBean reference
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Indicates if the Elasticity Framework should wait for all (persisted and non-persisted) HTTP sessions during inflight work handling while shutting down servers.
Type: boolean
Constraints: Has Default Value: false
The MBean that defines the configuration properties for the embedded LDAP server for the WebLogic domain.
The properties of the weblogic.management.configuration.EmbeddedLDAPMBean entity are as follows:
Specifies whether the embedded LDAP server should allow anonymous connections.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The maximum number of backup copies that should be made for the embedded LDAP server.
This value limits the number of zip files in the ldap/backup directory.
Type: int
Constraints: Restart Required, Has Default Value: 7, Minimum Value: 0, Maximum Value: 65534
The hour at which the embedded LDAP server should be backed up.
The Backup Hour value is used in conjunction with the Backup Minute value to determine the time at which the embedded LDAP server data files are backed up. At the specified time, WebLogic Server suspends writes to the embedded LDAP server, backs up the data files into a zip files in the ldap/backup directory, and then resumes writes.
Type: int
Constraints: Restart Required, Has Default Value: 23, Minimum Value: 0, Maximum Value: 23
The minute at which the embedded LDAP server should be backed up.
The Backup Minute value is used in conjunction with the Back Up Hour value to determine the time at which the embedded LDAP server data files are backed up
Type: int
Constraints: Restart Required, Has Default Value: 5, Minimum Value: 0, Maximum Value: 59
Specifies whether a cache is used with the embedded LDAP server.
This cache is used when a managed server is reading or writing to the master embedded LDAP server that is running on the Administration server.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The size of the cache (in kilobytes) that is used with the embedded LDAP server.
Type: int
Constraints: Restart Required, Has Default Value: 32, Minimum Value: 0
The time-to-live of the cache (in seconds) that is used with the embedded LDAP server.
Type: int
Constraints: Restart Required, Has Default Value: 60, Minimum Value: 0
The credential (usually a password) used to connect to the embedded LDAP server.
If this credential has not been set, WebLogic Server generates a password at startup, initializes the attribute, and saves the configuration to the config.xml file. If you want to connect to the embedded LDAP server using an external LDAP browser and the embedded LDAP administrator account (cn=Admin), change this attribute from the generated value.
As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the CredentialEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the CredentialEncrypted attribute to the encrypted value.
Using the Credential attribute is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use CredentialEncrypted()
Type: string
Constraints: Restart Required, Encrypted
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Whether keep alive is enabled in the socket connection
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether a Managed Server should always connect to the master LDAP server (contained in the Administration Server), instead of connecting to the local replicated LDAP server (contained in the Managed Server).
Type: boolean
Constraints: Restart Required, Has Default Value: false
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies whether a Managed Server should refresh all replicated data at boot time. (This is useful if you have made a large amount of changes when the Managed Server was not active, and you want to download the entire replica instead of having the Administration Server push each change to the Managed Server.)
Type: boolean
Constraints: Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
Specifies the maximum number of seconds to wait for results from the embedded LDAP server before timing out. If this option is set to 0, there is no maximum time limit.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean is used to configure an execute queue and its associated thread pool.
The properties of the weblogic.management.configuration.ExecuteQueueMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The maximum number of simultaneous requests that this server can hold in the queue.
Type: int
Constraints: Restart Required, Has Default Value: 65536, Minimum Value: 256, Maximum Value: 1073741824
The percentage of the Queue Length size that can be reached before this server indicates an overflow condition for the queue. If the overflow condition is reached and the current thread count has not reached the ThreadsMaximum value, then ThreadsIncrease number of threads are added.
Type: int
Constraints: Has Default Value: 90, Minimum Value: 1, Maximum Value: 99
Return all tags on this Configuration MBean
Type: array of string
The number of threads assigned to this queue.
Type: int
Constraints: Restart Required, Has Default Value: 15, Has Production Mode Default Value: 25, Minimum Value: 0, Maximum Value: 65536
Specifies the number of threads to increase the queue length when the queue length theshold is reached. This threshold is determined by the QueueLengthThresholdPercent value.
The following consideration applies to the dynamic nature of ThreadsMaximum and ThreadsIncrease attributes. If any of these attributes change during runtime, the changed value comes into effect when the next request is submitted to the execute queue and the scheduler decides to increase threads depending on the queue threshold conditions.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 65536
The maximum number of threads that this queue is allowed to have; this value prevents WebLogic Server from creating an overly high thread count in the queue in response to continual overflow conditions.
A note about dynamic nature of ThreadsMaximum and ThreadsIncrease attributes. If any of these attributes change during runtime, the changed value comes into effect when the next request is submitted to the execute queue and the scheduler decides to increase threads depending on the queue threshold conditions. Imagine a scenario where the queue capacity has already reached the max threshold and the current thread count is already equal to ThreadsMaximum value. If more work is coming into the queue and the administrator wishes to increase the ThreadsMaximum a little to add a few more threads, he/she can do so by changing these attributes dynamically. Please note that the changed value is evaluated when the next request is submitted.
Type: int
Constraints: Has Default Value: 400, Minimum Value: 1, Maximum Value: 65536
The minimum number of threads that WebLogic Server will maintain in the queue.
Type: int
Constraints: Restart Required, Has Default Value: 5, Minimum Value: 0, Maximum Value: 65536
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This mbean is used to configure a Fair Share based policy for a resource type.
The properties of the weblogic.management.configuration.FairShareConstraintMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Gets the fair-share value associated with this resource type.
Type: int
Constraints: Minimum Value: 1, Maximum Value: 1000
This mbean defines the fair share value to use for this request class. One of the components of work managers is a request class that indicates the proportional of the total server thread use time this request class gets. The default fair share value is 50.
Fair shares are reflected in scheduling logic such that as long as multiple fair shares compete, the average number of threads used by each is in proportion to their fair share. For example, consider we only have two fair shares, A and B, having a fair share of 80 and 20, respectively. During a period in which both fair shares are sufficiently requested, say, zero think time and more clients than threads, the probability that a thread will work on behalf of A or B will tend toward 80% or 20%, respectively. The scheduling logic ensures this even when A tends to use a thread for much longer than B.
Fair share values can range from 1 to 1000. The default fair share value is 50.
The properties of the weblogic.management.configuration.FairShareRequestClassMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Fair share value
Type: int
Constraints: Has Default Value: 50, Minimum Value: 1, Maximum Value: 1000
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean represents configuration for SAML 1.1-based Federation Services, including the intersite transfer service, assertion consumer service, and assertion retrieval service.
The properties of the weblogic.management.configuration.FederationServicesMBean entity are as follows:
Specifies whether the Assertion Consumer Service requires SSL.
Type: boolean
Constraints: Has Default Value: true
Specifies whether the Assertion Retrieval Service requires SSL.
Type: boolean
Constraints: Has Default Value: true
Specifies whether the Assertion Retrieval Service requires two-way SSL authentication.
Type: boolean
Constraints: Has Default Value: false
Specifies whether the Intersite Transfer Service requires SSL.
Type: boolean
Constraints: Has Default Value: true
Specifies whether the POST one-use check is enabled.
Type: boolean
Constraints: Has Default Value: true
Specifies whether the POST recipient check is enabled. When true, the recipient of the SAML Response must match the URL in the HTTP Request.
Type: boolean
Constraints: Has Default Value: true
The alias used to store and retrieve the Destination Site's SSL client identity in the keystore.
Type: string
Constraints: Has Default Value: null
The passphrase used to retrieve the Destination Site's SSL client identity from the keystore.
Type: string
Constraints: Restart Required, Encrypted
The Assertion Consumer URIs.
Type: array of string
Constraints: Restart Required, Has Default Value: [/samlacs/acs]
One or more URIs on which to listen for incoming assertion retrieval requests.
For artifact profile, the destination site receives a SAML artifact that represents a source site (why we need the source site ID values) and an assertion ID. The destination site sends a request containing the artifact to the source site's assertion retrieval URL, and the source site responds with the corresponding assertion. You may configure multiple URIs here, although typically one will be sufficient. The URI includes the application context, followed by the resource context. For example:
/my_application/saml/ars
which would be accessible from the outside as https://my.example.com/my_application/saml/ars
Type: array of string
Constraints: Restart Required, Has Default Value: [/samlars/ars]
The class that provides persistent storage for assertions, if you use an Assertion Store class other than the default class.
Type: string
Constraints: Restart Required, Has Default Value: null
Properties passed to Assertion Store class initStore() method.
This may be useful if you have implemented a custom Assertion Store class.
Type: java.util.Properties
Constraints: Restart Required, Has Default Value: null
Specifies whether the Destination Site is enabled.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The Intersite Transfer URIs.
Type: array of string
Constraints: Restart Required, Has Default Value: [/samlits_ba/its, /samlits_ba/its/post, /samlits_ba/its/artifact, /samlits_cc/its, /samlits_cc/its/post, /samlits_cc/its/artifact]
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The alias used to store and retrieve the Source Site's signing key in the keystore. This key is used to sign POST profile responses.
Type: string
Constraints: Has Default Value: null
The passphrase used to retrieve the Source Site's signing key from the keystore.
Type: string
Constraints: Restart Required, Encrypted
The Source Site ID base64-encoded.
This read-only value is a Base64 representation of a 20-byte binary value that is calculated from the SourceSiteURL. If you want to configure ARTIFACT profile with another site, you will need to give a SourceId value to the other site. This value is automatically updated when the SourceSiteURL changes.
Type: string
Constraints: Read Only
The Source Site ID in hexadecimal.
This read-only value is a hexadecimal representation of a 20-byte binary value that is calculated from the SourceSiteURL. If you want to configure ARTIFACT profile with another site, you will need to give a SourceId value to the other site. This value is automatically updated when the SourceSiteURL changes.
Type: string
Constraints: Read Only
Indicates whether the Source Site is enabled.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The URL for the Source Site.
Type: string
Constraints: Has Default Value: null
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The class used as the persistent store for the Used Assertion Cache. When no class is specified, the default Used Assertion Cache implementation is used.
Type: string
Constraints: Restart Required, Has Default Value: null
Properties to be passed to the Used Assertion Cache class.
Type: java.util.Properties
Constraints: Restart Required, Has Default Value: null
A {@code FileOpenMBean} represents a resource consumption management policy for the "File Open" resource type.
The "File open" resource type governs the number of open files. This includes files that have been opened through {@code java.io} ( {@code FileInputStream, FileOutputStream, RandomAccessFile} etc) and {@code java.nio} (NIO file channels) APIs.
Trigger (Usage limits) based policies can be defined for a "File Open" resource type through this MBean.
The valid set of recourse action types for the "File Open" resource type are:
notify
slow
shutdown
fail
The properties of the weblogic.management.configuration.FileOpenMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Defines an instance of the persistent store on the specified target that will keep its persistent objects in files on the filesystem. It may be used by JMS and by other subsystems.
The properties of the weblogic.management.configuration.FileStoreMBean entity are as follows:
Overrides the name of the XAResource that this store registers with JTA.
You should not normally set this attribute. Its purpose is to allow the name of the XAResource to be overridden when a store has been upgraded from an older release and the store contained prepared transactions. The generated name should be used in all other cases.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: null, Legal Null: true
The smallest addressable block, in bytes, of a file. When a native wlfileio driver is available and the block size has not been configured by the user, the store selects the minimum OS specific value for unbuffered (direct) I/O, if it is within the range [512, 8192].
A file store's block size does not change once the file store creates its files. Changes to block size only take effect for new file stores or after the current files have been deleted. See "Tuning the Persistent Store" in Tuning Performance of Oracle WebLogic Server
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 8192
The location of the cache directory for Direct-Write-With-Cache, ignored for other policies.
When Direct-Write-With-Cache is specified as the SynchronousWritePolicy, cache files are created in addition to primary files (see Directory for the location of primary files). If a cache directory location is specified, the cache file path is CacheDirectory/WLStoreCache/StoreNameFileNum.DAT.cache. When specified, Oracle recommends using absolute paths, but if the directory location is a relative path, then CacheDirectory is created relative to the WebLogic Server instance's home directory. If "" or Null is specified, the Cache Directory is located in the current operating system temp directory as determined by the java.io.tmpdir Java System property (JDK's default: /tmp on UNIX, %TEMP% on Windows) and is TempDirectory/WLStoreCache/DomainNameunique-idStoreNameFileNum.DAT.cache. The value of java.io.tmpdir varies between operating systems and configurations, and can be overridden by passing -Djava.io.tmpdir=My_path on the JVM command line.
Considerations:
Security: Some users may want to set specific directory permissions to limit access to the cache directory, especially if there are custom configured user access limitations on the primary directory. For a complete guide to WebLogic security, see "Securing a Production Environment for Oracle WebLogic Server."
Additional Disk Space Usage: Cache files consume the same amount of disk space as the primary store files that they mirror. See Directory for the location of primary store files.
Performance: For the best performance, a cache directory should be located in local storage instead of NAS/SAN (remote) storage, preferably in the operating system's temp directory. Relative paths should be avoided, as relative paths are located based on the domain installation, which is typically on remote storage. It is safe to delete a cache directory while the store is not running, but this may slow down the next store boot.
Preventing Corruption and File Locking: Two same named stores must not be configured to share the same primary or cache directory. There are store file locking checks that are designed to detect such conflicts and prevent corruption by failing the store boot, but it is not recommended to depend on the file locking feature for correctness. See Enable File Locking
Boot Recovery: Cache files are reused to speed up the File Store boot and recovery process, but only if the store's host WebLogic Server instance has been shut down cleanly prior to the current boot. For example, cache files are not re-used and are instead fully recreated: after a kill -9, after an OS or JVM crash, or after an off-line change to the primary files, such as a store admin compaction. When cache files are recreated, a Warning log message 280102 is generated.
Fail-Over/Migration Recovery: A file store safely recovers its data without its cache directory. Therefore, a cache directory does not need to be copied or otherwise made accessible after a fail-over or migration, and similarly does not need to be placed in NAS/SAN storage. A Warning log message 280102, which is generated to indicate the need to recreate the cache on the new host system, can be ignored.
Cache File Cleanup: To prevent unused cache files from consuming disk space, test and developer environments should periodically delete cache files.
Type: string
Constraints: Has Default Value: null, Legal Null: true
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
The path name to the file system directory where the file store maintains its data files.
When targeting a file store to a migratable target, the store directory must be accessible from all candidate server members in the migratable target.
For highest availability, use either a SAN (Storage Area Network) or other reliable shared storage.
Use of NFS mounts is discouraged, but supported. Most NFS mounts are not transactionally safe by default, and, to ensure transactional correctness, need to be configured using your NFS vendor documentation in order to honor synchronous write requests.
For SynchronousWritePolicy of Direct-Write-With-Cache, see Cache Directory.
Additional O/S tuning may be required if the directory is hosted by Microsoft Windows, see Synchronous Write Policy for details.
Type: string
Constraints: Restart Required, Has Default Value: null, Legal Null: true
Specifies how the instances of a configured JMS artifact are named and distributed when deployed to a cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Distributed creates an artifact instance on each cluster member in a cluster. Required for all SAF Agents and for cluster targeted or resource group scoped JMS Servers that host distributed destinations.
Singleton creates one artifact instance on a single cluster member of a cluster. Required for cluster targeted or resource group scoped JMS Servers that host standalone (non-distributed) destinations and for cluster targeted or resource group scoped Path Services. The Migration Policy must be On-Failure or Always when using this option with a JMS Server, On-Failure when using this option with a Messaging Bridge, and Always when using this option with a Path Service.
The DistributionPolicy determines the instance name suffix for cluster targeted JMS artifacts. The suffix for a cluster targeted Singleton is -01 and for a cluster targeted Distributed is @ClusterMemberName.
Type: string
Constraints: Restart Required, Has Default Value: Distributed, Legal Values: Distributed, Singleton
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies the amount of time, in seconds, to delay before failing a cluster targeted JMS artifact instance back to its preferred server after the preferred server failed and was restarted.
This delay allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > specifies the time, in seconds, to delay before failing a JMS artifact back to its user preferred server.
A value of indicates that the instance would never failback.
A value of -1 indicates that there is no delay and the instance would failback immediately.
Note: This setting only applies when the JMS artifact is cluster targeted and the Migration Policy is set to On-Failure or Always>
Type: long
Constraints: Restart Required, Has Default Value: -1
Determines whether OS file locking is used.
When file locking protection is enabled, a store boot fails if another store instance already has opened the store files. Do not disable this setting unless you have procedures in place to prevent multiple store instances from opening the same file. File locking is not required but helps prevent corruption in the event that two same-named file store instances attempt to operate in the same directories. This setting applies to both primary and cache files.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies the amount of time, in seconds, to delay before starting a cluster targeted JMS instance on a newly booted WebLogic server. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
This allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > is the time, in seconds, to delay before before loading resources after a failure and restart.
A value of specifies no delay.
Note: This setting only applies when the JMS artifact is cluster targeted and the Migration Policy is set to On-Failure or Always>
Type: long
Constraints: Restart Required, Has Default Value: 60
The initial file size, in bytes.
Set InitialSize to pre-allocate file space during a file store boot. If InitialSize exceeds MaxFileSize, a store creates multiple files (number of files = InitialSizeMaxFileSize rounded up).
A file store automatically reuses the space from deleted records and automatically expands a file if there is not enough space for a new write request.
Use InitialSize to limit or prevent file expansions during runtime, as file expansion introduces temporary latencies that may be noticeable under rare circumstances.
Changes to initial size only take effect for new file stores, or after any current files have been deleted prior to restart.
See Maximum File Size
Type: long
Constraints: Has Default Value: 0, Minimum Value: 0
The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.
For the Direct-Write-With-Cache policy when a native wlfileio driver is available, IOBufferSize describes the maximum portion of a cache view that is passed to a system call. This portion does not consume off-heap (native) or Java heap memory.
For the Direct-Write and Cache-Flush policies, IOBufferSize is the size of a per store buffer which consumes off-heap (native) memory, where one buffer is allocated during run-time, but multiple buffers may be temporarily created during boot recovery.
When a native wlfileio driver is not available, the setting applies to off-heap (native) memory for all policies (including Disabled).
For the best runtime performance, Oracle recommends setting IOBufferSize so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).
For the best boot recovery time performance of large stores, Oracle recommends setting IOBufferSize to at least 2 megabytes.
See AllocatedIOBufferBytes to find out the actual allocated off-heap (native) memory amount. It is a multiple of IOBufferSize for the Direct-Write and Cache-Flush policies, or zero.
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 67108864
The name used by subsystems to refer to different stores on different servers using the same name.
For example, an EJB that uses the timer service may refer to its store using the logical name, and this name may be valid on multiple servers in the same cluster, even if each server has a store with a different physical name.
Multiple stores in the same domain or the same cluster may share the same logical name. However, a given logical name may not be assigned to more than one store on the same server.
Type: string
Constraints: Has Default Value: null, Legal Null: true
The maximum file size, in bytes.
The MaxFileSize value affects the number of files needed to accommodate a store of a particular size (number of files = store size/MaxFileSize rounded up).
A file store automatically reuses space freed by deleted records and automatically expands individual files up to MaxFileSize if there is not enough space for a new record. If there is no space left in exiting files for a new record, a store creates an additional file.
A small number of larger files is normally preferred over a large number of smaller files as each file allocates Window Buffer and file handles.
If MaxFileSize is larger than 2^24 * BlockSize, then MaxFileSize is ignored, and the value becomes 2^24 * BlockSize. The default BlockSize is 512, and 2^24 * 512 is 8 GB.
See Initial Size
Type: long
Constraints: Has Default Value: 1342177280, Minimum Value: 1048576, Maximum Value: 2139095040
The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per primary store file. Applies to synchronous write policies Direct-Write-With-Cache and Disabled but only when the native wlfileio library is loaded.
A window buffer does not consume Java heap memory, but does consume off-heap (native) memory. If the store is unable to allocate the requested buffer size, it allocates smaller and smaller buffers until it reaches MinWindowBufferSize, and then fails if cannot honor MinWindowBufferSize
Oracle recommends setting the max window buffer size to more than double the size of the largest write (multiple concurrently updated records may be combined into a single write), and greater than or equal to the file size, unless there are other constraints. 32-bit JVMs may impose a total limit of between 2 and 4GB for combined Java heap plus off-heap (native) memory usage.
See store attribute AllocatedWindowBufferBytes to find out the actual allocated Window Buffer Size.
See Maximum File Size and Minimum Window Buffer Size
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 1073741824
Controls migration and restart behavior of cluster targeted JMS service artifact instances. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Off disables migration and restart support for cluster targeted JMS service objects, including the ability to restart a failed persistent store instance and its associated services. This policy can not be combined with the Singleton Migration Policy.
On-Failure enables automatic migration and restart of instances on the failure of a subsystem Service or WebLogic Server instance, including automatic fail-back and load balancing of instances.
Always provides the same behavior as On-Failure and automatically migrates instances even in the event of a graceful shutdown or a partial cluster start.
Note: Cluster leasing must be configured for On-Failure and Always
Type: string
Constraints: Restart Required, Has Default Value: Off, Legal Values: Off, On-Failure, Always
The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per primary store file. Applies to synchronous write policies Direct-Write-With-Cache and Disabled, but only when a native wlfileio library is loaded. See Maximum Window Buffer Size
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 1073741824
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies the number of restart attempts before migrating a failed JMS artifact instance to another server in the WebLogic cluster.
A value > specifies the number of restart attempts before migrating a failed service instance.
A value of specifies the same behavior as setting getRestartInPlace to false
A value of -1 specifies the service is never migrated. Instead, it continues to attempt to restart until it either starts or the server instance shuts down.
Type: int
Constraints: Restart Required, Has Default Value: 6
Specifies the amount of time, in seconds, to delay before a partially started cluster starts all cluster targeted JMS artifact instances that are configured with a Migration Policy of Always or On-Failure.
Before this timeout expires or all servers are running, a cluster starts a subset of such instances based on the total number of servers running and the configured cluster size. Once the timeout expires or all servers have started, the system considers the cluster stable and starts any remaining services.
This delay ensures that services are balanced across a cluster even if the servers are started sequentially. It is ignored once a cluster is fully started (stable) or when individual servers are started.
A value > specifies the time, in seconds, to delay before a partially started cluster starts dynamically configured services.
A value of specifies no delay.
Type: long
Constraints: Restart Required, Has Default Value: 240
Enables periodic automatic restart of failed cluster targeted JMS artifact instance(s) running on healthy WebLogic Server instances. Restart attempts occur before attempts to migrate an instance to a different server in the cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
Restarts occur when Restart In Place is set to true, the JMS artifact is cluster targeted, and the Migration Policy is set to On-Failure or Always>
This attribute is not used by WebLogic Messaging Bridges which automatically restart internal connections as needed.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies the amount of time, in seconds, to wait in between attempts to restart a failed service instance.
Type: int
Constraints: Restart Required, Has Default Value: 30
The disk write policy that determines how the file store writes data to disk.
This policy also affects the JMS file store's performance, scalability, and reliability. Oracle recommends Direct-Write-With-Cache which tends to have the highest performance. The default value is Direct-Write. The valid policy options are:
Direct-Write Direct I/O is supported on all platforms. When available, file stores in direct I/O mode automatically load the native I/O wlfileio driver. This option tends to out-perform Cache-Flush and tend to be slower than Direct-Write-With-Cache. This mode does not require a native store wlfileio driver, but performs faster when they are available.
Direct-Write-With-Cache Store records are written synchronously to primary files in the directory specified by the Directory attribute and asynchronously to a corresponding cache file in the Cache Directory. The Cache Directory provides information about disk space, locking, security, and performance implications. This mode requires a native store wlfileiocode driver. If the native driver cannot be loaded, then the write mode automatically switches to Direct-Write. See Cache Directory
Cache-Flush Transactions cannot complete until all of their writes have been flushed down to disk. This policy is reliable and scales well as the number of simultaneous users increases.Transactionally safe but tends to be a lower performer than direct-write policies.
Disabled Transactions are complete as soon as their writes are cached in memory, instead of waiting for the writes to successfully reach the disk. This is the fastest policy because write requests do not block waiting to be synchronized to disk, but, unlike other policies, is not transactionally safe in the event of operating system or hardware failures. Such failures can lead to duplicate or lost data/messages. This option does not require native store wlfileio drivers, but may run faster when they are available. Some non-WebLogic JMS vendors default to a policy that is equivalent to Disabled
Notes:
When available, file stores load WebLogic wlfileio native drivers, which can improve performance. These drivers are included with Windows, Solaris, Linux, and AIX WebLogic installations.
Certain older versions of Microsoft Windows may incorrectly report storage device synchronous write completion if the Windows default Write Cache Enabled setting is used. This violates the transactional semantics of transactional products (not specific to Oracle), including file stores configured with a Direct-Write (default) or Direct-Write-With-Cache policy, as a system crash or power failure can lead to a loss or a duplication of records/messages. One of the visible symptoms is that this problem may manifest itself in high persistent message/transaction throughput exceeding the physical capabilities of your storage device. You can address the problem by applying a Microsoft supplied patch, disabling the Windows Write Cache Enabled setting, or by using a power-protected storage device. See http://support.microsoft.com/kb/281672 and http://support.microsoft.com/kb/332023.
NFS storage note: On some operating systems, native driver memory-mapping is incompatible with NFS when files are locked. Stores with synchronous write policies Direct-Write-With-Cache or Disabled, and WebLogic JMS paging stores enhance performance by using the native wlfileio driver to perform memory-map operating system calls. When a store detects an incompatibility between NFS, file locking, and memory mapping, it automatically downgrades to conventional read/write system calls instead of memory mapping. For best performance, Oracle recommends investigating alternative NFS client drivers, configuring a non-NFS storage location, or in controlled environments and at your own risk, disabling the file locks (See Enable File Locking). For more information, see "Tuning the WebLogic Persistent Store" in Tuning Performance of Oracle WebLogic Server
Type: string
Constraints: Has Default Value: Direct-Write, Legal Values: Disabled, Cache-Flush, Direct-Write, Direct-Write-With-Cache
Return all tags on this Configuration MBean
Type: array of string
The server instances, clusters, or migratable targets defined in the current domain that are candidates for hosting a file store, JDBC store, or replicated store. If scoped to a Resource Group or Resource Group Template, the target is inherited from the Virtual Target.
When selecting a cluster, the store must be targeted to the same cluster as the JMS server. When selecting a migratable target, the store must be targeted it to the same migratable target as the migratable JMS server or SAF agent. As a best practice, a path service should use its own custom store and share the same target as the store.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
For each configuration entity that supports per-partition-override via a MBean, we have two MBeans, the original configure MBean and the corresponding override MBean, that eventually determine the effective settings of the configured resource. We mark an attribute of an override MBean "dynamic true" even though the original configure MBean masks it "dynamic false". This is to make sure that the overriding settings take effect on partition restart. Otherwise a server restart is required.
Defines partition-specific overrides for the most commonly overridden attributes in a ForeignConnectionFactory MBean. It overrides some of the settings in a same-named ForeignConnectionFactory MBean instance in the same multi-tenant scope to which this override MBean belongs.
The properties of the weblogic.management.configuration.ForeignConnectionFactoryOverrideMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The password used in conjunction with the user name specified in the Username parameter to access the remote connection factory.
Type: string
Constraints: Encrypted, Has Default Value: No-Override
The name of the remote object that will be looked up in the remote JNDI directory.
Type: string
Constraints: Has Default Value: No-Override
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The user name that is passed when opening a connection to the remote server (represented by this foreign connection factory).
Type: string
Constraints: Has Default Value: No-Override
For each configuration entity that supports per-partition-override via a MBean, we have two MBeans, the original configure MBean and the corresponding override MBean, that eventually determine the effective settings of the configured resource. We mark an attribute of an override MBean "dynamic true" even though the original configure MBean masks it "dynamic false". This is to make sure that the overriding settings take effect on partition restart. Otherwise a server restart is required.
Defines partition-specific overrides for the most commonly overridden attributes in a ForeignDestination MBean. It overrides some of the settings in a same-named ForeignDestination MBean instance in the same multi-tenant scope to which this override MBean belongs.
The properties of the weblogic.management.configuration.ForeignDestinationOverrideMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The name of the remote object that will be looked up in the remote JNDI directory.
Type: string
Constraints: Has Default Value: No-Override
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class represents a JNDI link that is outside the WebLogic server.
The properties of the weblogic.management.configuration.ForeignJNDILinkMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The local JNDI name.
Type: string
Constraints: Legal Null: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The foreign JNDI name.
Type: string
Constraints: Legal Null: true
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Defines partition-specific overrides for the most commonly overridden attributes in a ForeignJNDILink MBean. It overrides some of the settings in a same-named ForeignJNDILink MBean instance in the same multi-tenant scope to which this override MBean belongs.
The properties of the weblogic.management.configuration.ForeignJNDILinkOverrideMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The local JNDI name.
Type: string
Constraints: Legal Null: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The foreign JNDI name.
Type: string
Constraints: Legal Null: true
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class represents a JNDI provider that is outside the WebLogic server.
The properties of the weblogic.management.configuration.ForeignJNDIProviderMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The initial context factory to use to connect. This class name depends on the JNDI provider and the vendor you are using. The value corresponds to the standard JNDI property, java.naming.factory.initial
Type: string
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The remote server's user password.
Type: string
Constraints: Encrypted
Any additional properties that must be set for the JNDI provider. These properties will be passed directly to the constructor for the JNDI provider's InitialContext class.
Note: This value must be filled in using a name=value<return>name=value format.
Type: java.util.Properties
The foreign JNDI provider URL. This value corresponds to the standard JNDI property, java.naming.provider.url
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The remote server's user name.
Type: string
Defines partition-specific overrides for the most commonly overridden attributes in a ForeignJNDIProvider MBean. It overrides some of the settings in a same-named ForeignJNDIProvider MBean instance in the same multi-tenant scope to which this override MBean belongs.
The properties of the weblogic.management.configuration.ForeignJNDIProviderOverrideMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The initial context factory to use to connect. This class name depends on the JNDI provider and the vendor you are using. The value corresponds to the standard JNDI property, java.naming.factory.initial
Type: string
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The remote server's user password.
Type: string
Constraints: Encrypted
Any additional properties that must be set for the JNDI provider. These properties will be passed directly to the constructor for the JNDI provider's InitialContext class.
Note: This value must be filled in using a name=value<return>name=value format.
Type: java.util.Properties
The foreign JNDI provider URL. This value corresponds to the standard JNDI property, java.naming.provider.url
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The remote server's user name.
Type: string
For each configuration entity that supports per-partition-override via a MBean, we have two MBeans, the original configure MBean and the corresponding override MBean, that eventually determine the effective settings of the configured resource. We mark an attribute of an override MBean "dynamic true" even though the original configure MBean masks it "dynamic false". This is to make sure that the overriding settings take effect on partition restart. Otherwise a server restart is required.
Defines partition-specific overrides for the most commonly overridden attributes in a ForeignServer MBean. It overrides some of the settings in a same-named ForeignServer MBean instance in the same multi-tenant scope to which this override MBean belongs.
The properties of the weblogic.management.configuration.ForeignServerOverrideMBean entity are as follows:
Any credentials that must be set for the JNDI provider. These credentials will be part of the properties passed directly to the constructor for the JNDI provider's InitialContext class.
Some foreign providers require other properties to be set while obtaining an initial naming context. These properties can be set with a property bean.
Type: string
Constraints: Encrypted, Has Default Value: No-Override
The URL that WebLogic Server will use to contact the JNDI provider. The syntax of this URL depends on which JNDI provider is being used. For WebLogic JMS, leave this field blank if you are referencing WebLogic JMS objects within the same cluster.
This value corresponds to the standard JNDI property, java.naming.provider.url
Note: If this value is not specified, look-ups will be performed on the JNDI server within the WebLogic Server instance where this connection factory is deployed.
Type: string
Constraints: Has Default Value: No-Override, Legal Null: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The name of the class that must be instantiated to access the JNDI provider. This class name depends on the JNDI provider and the vendor that are being used.
This value corresponds to the standard JNDI property, java.naming.factory.initial
Note: This value defaults to weblogic.jndi.WLInitialContextFactory, which is the correct value for WebLogic Server.
Type: string
Constraints: Has Default Value: No-Override
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean is used to specify domain-wide default values for GZIP compression support. In general, these properties can be overridden for a specific Web application (in the weblogic.xml file).
The properties of the weblogic.management.configuration.GzipCompressionMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Returns the type of content to be included in compression.
Type: array of string
Constraints: Has Default Value: [text/html, text/xml, text/plain]
This global property determines whether or not the container should provide GZIP compression.
Type: boolean
Constraints: Has Default Value: false
Returns the minimum content length to trigger GZIP compression. This allows you to bypass small-sized resources where compression does not yield a great return and uses unnecessary CPU.
Type: long
Constraints: Has Default Value: 2048
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A {@code HeapRetainedMBean} represents a resource consumption management policy for the "Heap Retained" resource type.
The "Heap Retained" resource type tracks the amount of Heap memory retained (in use) by the Partition.
Triggers (Usage limits) and Fair share policies can be defined for a "Heap Retained" resource type through this MBena.
The valid set of recourse action types for the "Heap Retained" resource type are:
notify
slow
shutdown
The properties of the weblogic.management.configuration.HeapRetainedMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configuration for IIOP properties.
The properties of the weblogic.management.configuration.IIOPMBean entity are as follows:
The standard character code set that this server will publish as its native code set. (Older ORBs may have trouble interoperating with anything other than the default.)
Type: string
Constraints: Restart Required, Has Default Value: US-ASCII, Legal Values: US-ASCII, UTF-8, ISO-8859-1
The default GIOP (General Inter-ORB Protocol) version that this server will negotiate for incoming connections. (You may have to modify the default to work with other vendor's ORBs.)
This attribute is useful for client orbs with broken GIOP 1.2 implementations.
Type: int
Constraints: Restart Required, Has Default Value: 2, Minimum Value: 0, Maximum Value: 2
The wide character code set that this server will publish as its native code set. (Older ORBs may have trouble interoperating with anything other than the default.)
Type: string
Constraints: Restart Required, Has Default Value: UCS-2, Legal Values: UCS-2, UTF-16, UTF-8, UTF-16BE, UTF-16LE
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Enable getior servlet used to publish COS Naming Service IORs
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specify the value System Security. The following variables are affected. clientCertAuthentication, clientAuthentication, identityAssertion confidentiality, integrity. The value set in this MBean would only be picked up if the value set in RTD.xml is "config".
Type: string
Constraints: Restart Required, Has Default Value: supported, Legal Values: none, supported, required
Return all tags on this Configuration MBean
Type: array of string
The transaction mechanism used by IIOP invocations. The default is the Object Transaction Service (OTS) required by J2EE 1.3.
Type: string
Constraints: Restart Required, Has Default Value: OTS, Legal Values: OTS, JTA, OTSv11, none
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specify whether to use full Repository ID lists when sending value type information for custom-marshaled types. Full Repository ID lists allow C++ ORBS to truncate values to base types. For RMI-IIOP and Java ORBs doing this merely increases transmission overhead. JDK ORBs are known to have problems with these so setting this will prevent JDK ORB access from working.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specity whether to use java serialization for marshalling objects. Setting this property improves performance when marshalling objects with very large object graphs.
Type: boolean
Constraints: Has Default Value: false
Specify whether to advertise RMI objects and EJBs as supporting RMI-IIOP serial format version 2 for custom marshaled objects.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specify whether to advertise RMI objects and EJBs as supporting stateful CSIv2. Stateful CSIv2 is more efficient than stateless, requiring only a single authentication step for each remote principal. Stateless CSIv2 requires per-request authentication. Stateful CSIv2 is not required by J2EE 1.3 and so some ORBs do not support it. Stateful CSIv2 is enabled by default. This property can be changed at the object-level by changing the object's <stateful-authentication> runtime descriptor property.
Type: boolean
Constraints: Has Default Value: true
The properties of the weblogic.management.configuration.InterceptorMBean entity are as follows:
The set of interceptor names this interceptor depends on. The specified interceptors will appear before this interceptor in the invocation chain.
Type: array of string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The name of the operation / method that needs to intercepted by this interceptor's method. If the return value is null or "*" then all operations are intercepted by this interceptor.
Type: array of string
The key associated with the intercepted target. This is the value that would have been specified in the @InterceptedTargetKey annotation. If this is null then this Interceptor is ignored.
Type: string
The HK2 name of the interceptor class.
Type: string
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The priority of this intercepted method in the interceptor chain. An interceptor with a higher priority will be executed earlier than an interceptor with a lower priority.
Note: 1073741823 is actually Integer.MAX_VALUE / 2 as defined in InterceptorPriorities.
Type: int
Constraints: Has Default Value: 1073741823
A set of <name, value> pairs that needs to be passed to the interceptor.
Type: java.util.Properties
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The properties of the weblogic.management.configuration.InterceptorsMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Returns true if white listing feature is enabled. When white listing is enabled, only those Interceptors returned by getInterceptors() are enabled. If white listing is disabled, then the values returned by getInterceptor() overrides the values specified through annotations. For example the rank specified by an InterceptorMethodMBean overrides the rank specified using the
Type: boolean
Provides configuration for JASPIC (JSR-196) Auth Config Providers on the domain.
The properties of the weblogic.management.configuration.JASPICMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Returns true if JASPIC is enabled, false otherwise.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Defines an instance of the persistent store that stores its persistent records in a JDBC-accessible database. It may be used by JMS and by other subsystems.
The properties of the weblogic.management.configuration.JDBCStoreMBean entity are as follows:
Overrides the name of the XAResource that this store registers with JTA.
You should not normally set this attribute. Its purpose is to allow the name of the XAResource to be overridden when a store has been upgraded from an older release and the store contained prepared transactions. The generated name should be used in all other cases.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: null, Legal Null: true
Advanced use only: gets the connection caching policy for the JDBC store.
The return values will be one of:
JMSConstants.JDBCSTORE_CONNECTION_CACHING_POLICY_DEFAULT ("DEFAULT")
JMSConstants.JDBCSTORE_CONNECTION_CACHING_POLICY_MINIMAL ("MINIMAL")
JMSConstants.JDBCSTORE_CONNECTION_CACHING_POLICY_NONE ("NONE")
IMPORTANT: See the below for additional usage information, particularly regarding NONE
DEFAULT
The default mode of operation for the JDBC store. The JDBC store will open two connections to the database and it will keep these connections open for the life of the store. In addition, if the worker count for the store is two or more, then it will open one connection for each of the workers and those connections will also stay open for the life of the JDBC store. If the worker count is 3 then the JDBC store will use 5 database connections. If the worker count is the default of 1 then the JDBC store will use just 2 connections.The DEFAULT setting is the recommended setting to be used when the database backing the JDBC store is not constrained with respect to the number of open connections.
MINIMAL
The JDBC store will open one connection to the database and it will keep that connection open for the life of the store. In addition, if the worker count for the store is two or more, then it will open one connection for each of the workers and those connections will also stay open for the life of the JDBC store. If the worker count is 3 then the JDBC store will use 4 database connections. If the worker count is the default of 1 then the JDBC store will use just 1 connection. The MINIMAL setting may result in a slight reduction of through-put for low concurrency messaging scenarios in comparison to DEFAULT.
NONE
The NONE connection caching policy is for 'advanced usage only'. The JDBC store will open one connection to the database on an as-needed basis to perform I/O and it will release that connection when the operation is complete. The NONE value is not compatible with a configured worker count of 2 or more and will result in a configuration validation exception. The NONE setting may result in a slight reduction of through-put for low concurrency messaging scenarios in comparison to DEFAULT or MINIMAL.
NOTE: It is strongly recommended that a JDBC store be configured with a dedicated data source when the store is configured with the NONE connection caching policy. A store that shares a data source with other non-store components or applications runs the risk of failing due to dead-locks. Please note that a JDBC store will require more than one connection when first started. As such, a data source should be configured to grow and shrink so that the JDBC store can initialize.
Type: string
Constraints: Restart Required, Has Default Value: DEFAULT, Legal Values: DEFAULT, MINIMAL, NONE
Specifies the DDL (Data Definition Language) file to use for creating the JDBC store's backing table.
This field is ignored when the JDBC store's backing table, WLStore, already exists.
If a DDL file is not specified and the JDBC store detects that a backing table doesn't already exist, the JDBC store automatically creates the table by executing a preconfigured DDL file that is specific to the database vendor. These preconfigured files are located in the weblogic\store\io\jdbc\ddl directory of the MIDDLEWARE_HOME\modules\com.bea.core.store.jdbc_x.x.x.x.jar file.
If a DDL file is specified and the JDBC store detects that a backing table doesn't already exist, then the JDBC store searches for the DDL file in the file path first, and then if the file is not found, it searches for it in the CLASSPATH. Once found, the SQL within the DDL file is executed to create the JDBC store's database table. If the DDL file is not found and the backing table doesn't already exist, the JDBC store will fail to boot.
Type: string
Constraints: Restart Required, Has Default Value: null
The JDBC data source used by this JDBC store to access its backing table.
The specified data source must use a non-XA JDBC driver since connection pools for XA JDBC drivers are not supported.
Type: weblogic.management.configuration.JDBCSystemResourceMBean reference
Constraints: Restart Required
The maximum number of table rows that are deleted per database call.
When possible, a JDBC store uses JDBC 3.0 batching to batch concurrent client requests.
Both the maximum batch size for concurrent inserts and for concurrent writes are configurable.
To disable JDBC 3.0 batching, set the maximum batch size to 1.
The maximum batch size has no effect on the maximum number of concurrent client requests.
Type: int
Constraints: Restart Required, Has Default Value: 20, Minimum Value: 1, Maximum Value: 100
The maximum number of table rows that are deleted per database call.
Applies only when a JDBC store does not use JDBC 3.0 batching to batch concurrent client requests.
The maximum deletes per statement has no effect on the maximum number of concurrent client requests.
For some databases, the JDBC store may choose a lower value than the one configured.
Type: int
Constraints: Restart Required, Has Default Value: 20, Minimum Value: 1, Maximum Value: 100
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Specifies how the instances of a configured JMS artifact are named and distributed when deployed to a cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Distributed creates an artifact instance on each cluster member in a cluster. Required for all SAF Agents and for cluster targeted or resource group scoped JMS Servers that host distributed destinations.
Singleton creates one artifact instance on a single cluster member of a cluster. Required for cluster targeted or resource group scoped JMS Servers that host standalone (non-distributed) destinations and for cluster targeted or resource group scoped Path Services. The Migration Policy must be On-Failure or Always when using this option with a JMS Server, On-Failure when using this option with a Messaging Bridge, and Always when using this option with a Path Service.
The DistributionPolicy determines the instance name suffix for cluster targeted JMS artifacts. The suffix for a cluster targeted Singleton is -01 and for a cluster targeted Distributed is @ClusterMemberName.
Type: string
Constraints: Restart Required, Has Default Value: Distributed, Legal Values: Distributed, Singleton
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies the amount of time, in seconds, to delay before failing a cluster targeted JMS artifact instance back to its preferred server after the preferred server failed and was restarted.
This delay allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > specifies the time, in seconds, to delay before failing a JMS artifact back to its user preferred server.
A value of indicates that the instance would never failback.
A value of -1 indicates that there is no delay and the instance would failback immediately.
Note: This setting only applies when the JMS artifact is cluster targeted and the Migration Policy is set to On-Failure or Always>
Type: long
Constraints: Restart Required, Has Default Value: -1
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies the amount of time, in seconds, to delay before starting a cluster targeted JMS instance on a newly booted WebLogic server. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
This allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > is the time, in seconds, to delay before before loading resources after a failure and restart.
A value of specifies no delay.
Note: This setting only applies when the JMS artifact is cluster targeted and the Migration Policy is set to On-Failure or Always>
Type: long
Constraints: Restart Required, Has Default Value: 60
The maximum number of table rows that are inserted per database call.
When possible, a JDBC store uses JDBC 3.0 batching to batch concurrent client requests.
Both the maximum batch size for concurrent inserts and for concurrent writes are configurable.
To disable JDBC 3.0 batching, set the maximum batch size to 1.
The maximum batch size has no effect on the maximum number of concurrent client requests.
Type: int
Constraints: Restart Required, Has Default Value: 20, Minimum Value: 1, Maximum Value: 100
The name used by subsystems to refer to different stores on different servers using the same name.
For example, an EJB that uses the timer service may refer to its store using the logical name, and this name may be valid on multiple servers in the same cluster, even if each server has a store with a different physical name.
Multiple stores in the same domain or the same cluster may share the same logical name. However, a given logical name may not be assigned to more than one store on the same server.
Type: string
Constraints: Has Default Value: null, Legal Null: true
Controls migration and restart behavior of cluster targeted JMS service artifact instances. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Off disables migration and restart support for cluster targeted JMS service objects, including the ability to restart a failed persistent store instance and its associated services. This policy can not be combined with the Singleton Migration Policy.
On-Failure enables automatic migration and restart of instances on the failure of a subsystem Service or WebLogic Server instance, including automatic fail-back and load balancing of instances.
Always provides the same behavior as On-Failure and automatically migrates instances even in the event of a graceful shutdown or a partial cluster start.
Note: Cluster leasing must be configured for On-Failure and Always
Type: string
Constraints: Restart Required, Has Default Value: Off, Legal Values: Off, On-Failure, Always
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies the number of restart attempts before migrating a failed JMS artifact instance to another server in the WebLogic cluster.
A value > specifies the number of restart attempts before migrating a failed service instance.
A value of specifies the same behavior as setting getRestartInPlace to false
A value of -1 specifies the service is never migrated. Instead, it continues to attempt to restart until it either starts or the server instance shuts down.
Type: int
Constraints: Restart Required, Has Default Value: 6
Enables committing a batch of INSERT or DELETE operations with the last operation of the transaction instead of issuing a separate commit call to database server which saves a server round trip. This feature benefits applications that have many transactions of a small number of operations or small messages. This feature should be used only when configuring a JDBC store in Oracle Exalogic environments.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies the amount of time, in seconds, to delay before a partially started cluster starts all cluster targeted JMS artifact instances that are configured with a Migration Policy of Always or On-Failure.
Before this timeout expires or all servers are running, a cluster starts a subset of such instances based on the total number of servers running and the configured cluster size. Once the timeout expires or all servers have started, the system considers the cluster stable and starts any remaining services.
This delay ensures that services are balanced across a cluster even if the servers are started sequentially. It is ignored once a cluster is fully started (stable) or when individual servers are started.
A value > specifies the time, in seconds, to delay before a partially started cluster starts dynamically configured services.
A value of specifies no delay.
Type: long
Constraints: Restart Required, Has Default Value: 240
The prefix for the JDBC store's database table (WLStore), in the following format: [[[catalog.]schema.]prefix]
Each period symbol in the [[catalog.]schema.]prefix format is significant, where schema generally corresponds to username in many databases. When no prefix is specified, the JDBC store table name is simply WLStore and the database implicitly determines the schema according to the JDBC connection's user. As a best practice, you should always configure a prefix for the JDBC WLStore table name.
For specific guidelines about using JDBC store prefixes, refer to the "Using the WebLogic Store" section of Designing and Configuring WebLogic Server Environments"
Type: string
Constraints: Restart Required, Has Default Value: null
The length of time in milliseconds between reconnection attempts during the reconnection retry period.
The reconnection interval applies to JDBC connections regardless of the database that is used for the JDBC store.
The default value is 200 milliseconds
Type: int
Constraints: Restart Required, Has Default Value: 200, Minimum Value: 100, Maximum Value: 10000
Returns the length of time in milliseconds during which the persistent store will attempt to re-establish a connection to the database. Successive reconnection attempts will be attempted after a fixed delay that is specified by the reconnection retry interval.
The reconnection period applies to JDBC connections regardless of the database that is used for the JDBC store.
The default value is 1000
Type: int
Constraints: Restart Required, Has Default Value: 1000, Minimum Value: 200, Maximum Value: 300000
Enables periodic automatic restart of failed cluster targeted JMS artifact instance(s) running on healthy WebLogic Server instances. Restart attempts occur before attempts to migrate an instance to a different server in the cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
Restarts occur when Restart In Place is set to true, the JMS artifact is cluster targeted, and the Migration Policy is set to On-Failure or Always>
This attribute is not used by WebLogic Messaging Bridges which automatically restart internal connections as needed.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies the amount of time, in seconds, to wait in between attempts to restart a failed service instance.
Type: int
Constraints: Restart Required, Has Default Value: 30
Return all tags on this Configuration MBean
Type: array of string
The server instances, clusters, or migratable targets defined in the current domain that are candidates for hosting a file store, JDBC store, or replicated store. If scoped to a Resource Group or Resource Group Template, the target is inherited from the Virtual Target.
When selecting a cluster, the store must be targeted to the same cluster as the JMS server. When selecting a migratable target, the store must be targeted it to the same migratable target as the migratable JMS server or SAF agent. As a best practice, a path service should use its own custom store and share the same target as the store.
Type: array of weblogic.management.configuration.TargetMBean references
Specifies the threshold, in bytes, when the JDBC store uses 3 steps (insert, select, populate) instead of 1 step (insert) to populate an Oracle Blob data type.
Applies only to Oracle databases where a Blob data type is used instead of the default Long Raw data type for record data.
The default value is 200000.
Type: int
Constraints: Restart Required, Has Default Value: 200000, Minimum Value: 4000, Maximum Value: 2147483647
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The number of JDBC store worker threads to process the workerload.
A value of 1 indicates a single thread is used (the default).
A value greater than 1 indicates that multiple threads are used.
For Oracle databases, Oracle recommends users rebuild the primary key index into a reverse index for the JDBC Store table when the worker count is greater than 1.
For non-Oracle databases, refer to the database provider's documentation for help with indexing.
Type: int
Constraints: Restart Required, Has Default Value: 1, Minimum Value: 1, Maximum Value: 1000
Specifies the batch size when the Worker Count attribute is configured to a value greater than 1.
Used to configure the workload the JDBC store incrementally puts on each worker thread. The workload consists of IO requests which are grouped and pushed to each JDBC worker thread for processing. If the IO request is very large (for example 1M), then tune this attribute to a smaller value.
Type: int
Constraints: Restart Required, Has Default Value: 10, Minimum Value: 1, Maximum Value: 2147483647
This bean defines a system-level JDBC resource. It links a separate descriptor that specifies the definition.
The properties of the weblogic.management.configuration.JDBCSystemResourceMBean entity are as follows:
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.
Type: string
Constraints: Restart Required
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.
Type: int
Constraints: Restart Required, Has Default Value: 100
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.
Type: string
Constraints: Restart Required
The name of the file containing this configuration. This is a relative name rooted at DOMAIN_DIR/config. By default the file resides in the jdbc subdirectory and derives its name from the bean name using the following pattern:
<beanName>.xml
Note that this is a read-only property that can only be set when the bean is created.
Type: string
Constraints: Read Only, Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The values match those defined by jsr88. This attribute may move to another MBean.
Type: string
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return the Descriptor for the system resource. This should be overridden by the derived system resources.
Type: weblogic.descriptor.DescriptorBean reference
Constraints: Read Only, Restart Required
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Defines a partition-specific JDBC data source attribute override of a data source descriptor referenced by a partition resource group definition.
The properties of the weblogic.management.configuration.JDBCSystemResourceOverrideMBean entity are as follows:
The connection URL for the data source.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Returns the initial pool capacity for the partition datasource. The value -1 indicates that the attribute is not set.
Type: int
Constraints: Has Default Value: -1
Returns the max pool capacity for the partition datasource. The value -1 indicates that the attribute is not set.
Type: int
Constraints: Has Default Value: -1
Returns the min pool capacity for the partition datasource. The value -1 indicates that the attribute is not set.
Type: int
Constraints: Has Default Value: -1
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The password in clear text.
Type: string
Constraints: Encrypted
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The name of the user for the data source.
Type: string
This MBean represents a messaging bridge destination for a JMS messaging product. Each messaging bridge consists of two destinations that are being bridged:
Source: The message producing destination. A bridge instance consumes messages from the source destination.
Target: The destination where a bridge instance forwards messages produced by the source destination.
The properties of the weblogic.management.configuration.JMSBridgeDestinationMBean entity are as follows:
The JNDI name of the adapter used to communicate with the specified destination.
This name is specified in the adapter's deployment descriptor file and is used by the WebLogic Server Connector container to bind the adapter in WebLogic Server JNDI.
Type: string
Constraints: Restart Required, Has Default Value: eis.jms.WLSConnectionFactoryJNDIXA, Legal Null: true
The connection factory's JNDI name for this JMS bridge destination.
Type: string
Constraints: Restart Required
The connection URL for this JMS bridge destination.
Type: string
Constraints: Restart Required
The destination JNDI name for this JMS bridge destination.
Type: string
Constraints: Restart Required
The destination type (queue or topic) for this JMS bridge destination.
Type: string
Constraints: Restart Required, Has Default Value: Queue, Legal Values: Queue, Topic
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The initial context factory name for this JMS bridge destination.
Type: string
Constraints: Restart Required, Has Default Value: weblogic.jndi.WLInitialContextFactory
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The optional user name the adapter uses to access the bridge destination.
All operations on the specified destination are done using this user name and the corresponding password. Therefore, the User Name/Password for the source and target destinations must have permission to the access the underlying destinations in order for the messaging bridge to work.
Type: string
Constraints: Restart Required
The user password that the adapter uses to access the bridge destination.
As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the UserPasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the UserPasswordEncrypted attribute to the encrypted value.
Using this attribute (UserPassword) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use UserPasswordEncrypted
Type: string
Constraints: Restart Required, Encrypted
This bean defines a system-level JMS resource. It links a separate descriptor that specifies the definition.
The properties of the weblogic.management.configuration.JMSInteropModuleMBean entity are as follows:
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.
Type: string
Constraints: Restart Required
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.
Type: int
Constraints: Restart Required, Has Default Value: 100
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.
Type: string
Constraints: Restart Required
The name of the file that contains the module configuration. By default the file resides in the DOMAIN_DIR/config/jms directory.
The module file derives its name from the bean name using the following pattern:
<beanName>.xml
Note that this is a read-only property that can only be set when the bean is created.
Type: string
Constraints: Read Only, Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The values match those defined by jsr88. This attribute may move to another MBean.
Type: string
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return the Descriptor for the system resource. This should be overridden by the derived system resources.
Type: weblogic.descriptor.DescriptorBean reference
Constraints: Read Only, Restart Required
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Constraints: Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This defines the configuration aspects of the logs for a jms server.
The properties of the weblogic.management.configuration.JMSMessageLogFileMBean entity are as follows:
Gets the underlying log buffer size in kilobytes
Type: int
Constraints: Has Default Value: 8
The date format pattern used for rendering dates in the log. The DateFormatPattern string conforms to the specification of the java.text.SimpleDateFormat class.
Type: string
Constraints: Legal Null: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)
Type: int
Constraints: Has Default Value: 7, Has Production Mode Default Value: 100, Minimum Value: 1, Maximum Value: 99999
The size (1 - 2097150 kilobytes) that triggers the server to move log messages to a separate file. The default is 500 kilobytes. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as SERVER_NAME.lognnnnn and create a new one to store subsequent messages. (Requires that you specify a file rotation type of Size.)
Type: int
Constraints: Has Default Value: 500, Has Production Mode Default Value: 5000, Minimum Value: 1, Maximum Value: 2097150
The name of the file that stores current JMS server log messages. Usually it is a computed value based on the name of the parent of this MBean. For example, for a JMS server log, it is jmsserverName.log
However, if the name of the parent cannot be obtained, the file name is weblogic.log. If you specify a relative pathname, it is interpreted as relative to the server's root directory.
To include a time and date stamp in the file name when the log file is rotated, add java.text.SimpleDateFormat variables to the file name. Surround each variable with percentage () characters.
For example, if the file name is defined to be myjmsserver_%yyyy%_%MM%_%dd%_%hh%_%mm%.log, the log file will be named myserver_yyyy_mm_dd_hh_mm.log
When the log file is rotated, the rotated file name contains the date stamp. For example, if the log file is rotated on 2 April, 2005 at 10:05 AM, the log file that contains the old messages will be named myserver_2005_04_02_10_05.log
If you do not include a time and date stamp, the rotated log files are numbered in order of creation. For example, myjmsserver.log00007
Type: string
Constraints: Restart Required
The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of TIME.)
Type: int
Constraints: Has Default Value: 24, Minimum Value: 1
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.
Type: string
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of SIZE or TIME.)
After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.
If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.
Type: boolean
Constraints: Has Default Value: true, Has Production Mode Default Value: true
Specifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.
Type: boolean
Constraints: Has Default Value: true, Has Production Mode Default Value: false
Determines the start time (hour and minute) for a time-based rotation sequence.
At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.
Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.
Use the following format: H:mm, where
is Hour in day (0-23)
mm is the minute in hour
Type: string
Constraints: Has Default Value: 00:00
Criteria for moving old log messages to a separate file.
NONE Messages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.
SIZE When the log file reaches the size that you specify in FileMinSize, the server renames the file as SERVER_NAME.lognnnnn
TIME At each time interval that you specify in TimeSpan, the server renames the file as SERVER_NAME.lognnnnn
After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.
Type: string
Constraints: Has Default Value: bySize, Legal Values: bySize, byTime, none
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This defines the configuration aspects of the logs for a jms server.
The properties of the weblogic.management.configuration.JMSSAFMessageLogFileMBean entity are as follows:
Gets the underlying log buffer size in kilobytes
Type: int
Constraints: Has Default Value: 8
The date format pattern used for rendering dates in the log. The DateFormatPattern string conforms to the specification of the java.text.SimpleDateFormat class.
Type: string
Constraints: Legal Null: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)
Type: int
Constraints: Has Default Value: 7, Has Production Mode Default Value: 100, Minimum Value: 1, Maximum Value: 99999
The size (1 - 2097150 kilobytes) that triggers the server to move log messages to a separate file. The default is 500 kilobytes. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as SERVER_NAME.lognnnnn and create a new one to store subsequent messages. (Requires that you specify a file rotation type of Size.)
Type: int
Constraints: Has Default Value: 500, Has Production Mode Default Value: 5000, Minimum Value: 1, Maximum Value: 2097150
Type: string
Constraints: Restart Required
The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of TIME.)
Type: int
Constraints: Has Default Value: 24, Minimum Value: 1
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.
Type: string
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of SIZE or TIME.)
After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.
If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.
Type: boolean
Constraints: Has Default Value: true, Has Production Mode Default Value: true
Specifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.
Type: boolean
Constraints: Has Default Value: true, Has Production Mode Default Value: false
Determines the start time (hour and minute) for a time-based rotation sequence.
At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.
Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.
Use the following format: H:mm, where
is Hour in day (0-23)
mm is the minute in hour
Type: string
Constraints: Has Default Value: 00:00
Criteria for moving old log messages to a separate file.
NONE Messages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.
SIZE When the log file reaches the size that you specify in FileMinSize, the server renames the file as SERVER_NAME.lognnnnn
TIME At each time interval that you specify in TimeSpan, the server renames the file as SERVER_NAME.lognnnnn
After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.
Type: string
Constraints: Has Default Value: bySize, Legal Values: bySize, byTime, none
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class represents a JMS server. A JMS server manages connections and message requests on behalf of clients.
The properties of the weblogic.management.configuration.JMSServerMBean entity are as follows:
Specifies whether JMS clients will get an exception when sending persistent messages to a destination targeted to a JMS server that does not have a persistent store configured. This parameter only has effect when the Store Enabled parameter is disabled (false).
When set to false, the default, clients will get an exception when sending persistent messages to a JMS server with no store configured. When set to true, then persistent messages are downgraded to non-persistent; however, the send operations are allowed to continue.
Type: boolean
Constraints: Has Default Value: false
Determines whether the JMS server delivers smaller messages before larger ones when a destination has exceeded its maximum number of messages. FIFO prevents the JMS server from delivering smaller messages when larger ones are already waiting for space. Preemptive allows smaller send requests to preempt previous larger ones when there is sufficient space for smaller messages on the destination.
This policy is defined only for the JMS server; it cannot be set on individual destinations.
Additional information on the FIFO and Preemptive policies is provided below.
FIFO (first in, first out) indicates that all send requests for the same destination are queued up one behind the other until space is available. No send request is permitted to successfully complete if there is another send request waiting for space before it. When space is limited, the FIFO policy prevents the starvation of larger requests because smaller requests cannot continuously use the remaining available space. Smaller requests are delayed, though not starved, until the larger request can be completed. When space does become available, requests are considered in the order in which they were made. If there is sufficient space for a given request, then that request is completed and the next request is considered. If there is insufficient space for a given request, then no further requests are considered until sufficient space becomes available for the current request to complete.
Preemptive indicates that a send operation can preempt other blocking send operations if space is available. That is, if there is sufficient space for the current request, then that space is used even if there are other requests waiting for space. When space is limited, the Preemptive policy can result in the starvation of larger requests. For example, if there is insufficient available space for a large request, then it is queued up behind other existing requests. When space does become available, all requests are considered in the order in which they were originally made. If there is sufficient space for a given request, then that request is allowed to continue and the next request is considered. If there is insufficient space for a given request, then that request is skipped and the next request is considered.
Type: string
Constraints: Has Default Value: FIFO, Legal Values: FIFO, Preemptive
The maximum number of bytes that can be stored in this JMS server. A value of -1 removes any WebLogic Server limits.
Because excessive bytes volume can cause memory saturation, Oracle recommends that this maximum corresponds to the total amount of system memory available after accounting for the rest of your application load.
Range of Values: >= BytesThresholdHigh
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9223372036854775807
The upper threshold (number of bytes stored in this JMS server) that triggers flow control and logging events. A value of -1 disables the events for this JMS server.
The triggered events are:
Log Messages - A message is logged on the server indicating a high threshold condition.
Flow Control - If flow control is enabled, the JMS server becomes armed and instructs producers to begin decreasing their message flow.
Range of Values: <= BytesMaximum; >= BytesThresholdLow
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9223372036854775807
The lower threshold (number of bytes stored in this JMS server) that triggers flow control and logging events. A value of -1 disables the events for this JMS server.
If the number of bytes falls below this threshold, the triggered events are:
Log Messages - A message is logged on the server indicating that the threshold condition has cleared.
Flow Control - If flow control is enabled, the JMS server becomes disarmed and instructs producers to begin increasing their message flow.
Range of Values: <= BytesThresholdHigh
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9223372036854775807
Indicates whether consumption is paused at startup on destinations targeted to this JMS server at startup. A destination cannot receive any new messages while it is paused.
When the value is set to true, then immediately after the host server instance is booted, then this JMS server and its targeted destinations are modified such that they are in a "consumption paused" state, which prevents any message consuming activity on those destinations.
To allow normal message consumption on the destinations, later you will have to change the state of this JMS server to a "consumption enabled" state by setting this value to false, and then either redeploy the JMS server or reboot the hosting server instance.
When the value is set to default, then the Consumption Paused At Startup is determined based on the corresponding setting on the individual destination.
Type: string
Constraints: Restart Required, Has Default Value: default
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The number of seconds between this JMS server's cycles of scanning local destinations for expired messages. A value of disables active scanning. A very large scan interval effectively disables active scanning.
With scanning disabled, users still do not receive expired messages and any expired messages that are discovered by other system activities are removed. However, expired messages sitting in idle destinations (such as an inactive queue or disconnected durable subscriber) are not removed and continue to consume system resources.
The scanning cycle for expired messages occurs as follows:
After the specified waiting period, the JMS server devotes a separate thread to scan all of its local destinations for expired messages.
After the scanning is completed, all located expired messages are processed according to the specified Expiration Policy on the destination (Discard, Log, or Redirect).
The entire process repeats after another specified waiting period.
Note: Because a new scan does not start until the current one is finished and until the specified waiting period ends, an expired message could still remain in the system for the maximum scan waiting period plus the amount of time it takes to perform the scan.
Type: int
Constraints: Has Default Value: 30, Minimum Value: 0, Maximum Value: 2147483647
Specifies whether this JMS server can be used to host temporary destinations.
If this field is enabled and no Temporary Template Name is defined, then the temporary destinations created on this JMS server will use all default destination values. If this field is enabled, then the JMS template to be used for creating temporary destinations is specified by the Temporary Template Name field. If this field is disabled, then this JMS server will not host temporary destinations.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Indicates whether insertion is paused at startup on destinations targeted to this JMS server. A destination cannot receive any new messages while it is paused.
When the value is set to true, then immediately after the host server instance is booted, then this JMS server and its targeted destinations are modified such that they are in a "insertion paused" state, which results preventing messages that are result of the "in-flight" work completion to arrive on those destinations.
Note: For a detailed definition of "in-flight" work/messages, see weblogic.management.runtime.JMSServerRuntimeMBean#resumeInsertion and weblogic.management.runtime.JMSDestinationRuntime#resumeInsertion
To allow in-flight work messages to appear on the destinations, later you will have to change the state of this JMS server to an "insertion enabled" state by setting this value to false, and then either redeploy the JMS server or reboot the hosting server instance.
When the value is set to default, then the Insertion Paused At Startup is determined based on the corresponding setting on the individual destination.
Type: string
Constraints: Restart Required, Has Default Value: default
The maximum number of bytes allowed in individual messages on this JMS server. The size of a message includes the message body, any user-defined properties, and the user-defined JMS header fields JMSCorrelationID and JMSType
The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
Note: Any change to this maximum affects only incoming messages; stored messages are not affected.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
The amount of memory (in bytes) that this JMS server can use to store message bodies before it writes them to disk. When the JMS server writes the message bodies to disk, it clears them from memory.
A value of -1 (the default) specifies that the server will automatically determine a size based on the maximum heap size of the JVM. This default will be set to either one-third the maximum heap size, or 512 megabytes, whichever is smaller.
The larger the buffer, the more memory JMS will consume when many messages are waiting on queues or topics. Once the buffer is surpassed, JMS may write message bodies to the directory specified by PagingDirectory in an effort to reduce memory usage below this buffer.
Surpassing the buffer size does not stop the JMS server from accepting new messages. It is still possible to run out of memory if messages are arriving faster than they can be written to disk. Users with high messaging loads who wish to support the highest possible availability should consider setting a quota or setting a threshold and enabling flow control.
Paging is always supported.
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9223372036854775807
Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores.
Use GZIP_DEFAULT_COMPRESSION to enable message compression using the JDK GZIP API with DEFAULT_COMPRESSION level.
Use GZIP_BEST_COMPRESSION to enable message compression using the JDK GZIP API with BEST_COMPRESSION level.
Use GZIP_BEST_SPEED to enable message compression using the JDK GZIP API with BEST_SPEED level.
Use LZF to enable message compression using Open Source LZF.
This attribute should be used only when configuring a WebLogic domain in an Oracle Exalogic environment.
Type: string
Constraints: Has Default Value: GZIP_DEFAULT_COMPRESSION, Legal Values: GZIP_DEFAULT_COMPRESSION, GZIP_BEST_COMPRESSION, GZIP_BEST_SPEED, LZF
The maximum number of messages that can be stored in this JMS server. A value of -1 removes any WebLogic Server limits.
Because excessive message volume can cause memory saturation, Oracle recommends that this value corresponds to the total amount of system memory available after accounting for the rest of your application load.
Range of Values: >= MessagesThresholdHigh.
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9223372036854775807
The upper threshold (number of messages stored in this JMS server) that triggers flow control and logging events. A value of -1 disables the events for this JMS server.
If the number of messages exceeds this threshold, the triggered events are:
Log Messages - A message is logged on the server indicating a high threshold condition.
Flow Control - If flow control is enabled, the JMS server becomes armed and instructs producers to begin decreasing their message flow.
Range of Values: <= MessagesMaximum; >= MessagesThresholdLow.
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9223372036854775807
The lower threshold (number of messages stored in this JMS server) that triggers flow control and logging events. A value of -1 disables the events for this JMS server.
If the number of messages falls below this threshold, the triggered events are:
Log Messages - A message is logged on the server indicating that the threshold condition has cleared.
Flow Control - If flow control is enabled, the JMS server becomes disarmed and instructs producers to begin increasing their message flow.
Note: This attribute is dynamically configurable.
Range of Values: <= MessagesThresholdHigh
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9223372036854775807
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The smallest addressable block, in bytes, of a file. When a native wlfileio driver is available and the paging block size has not been configured by the user, the store selects the minimum OS specific value for unbuffered (direct) I/O, if it is within the range [512, 8192].
A paging store's block size does not change once the paging store creates its files. Changes to block size only take effect for new paging stores or after the current files have been deleted. See "Tuning the Persistent Store" in Performance and Tuning for Oracle WebLogic Server
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 8192
Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size.
If unspecified, messages are written to the default tmp directory inside the server-name subdirectory of a domain's root directory. For example, domain-name/servers/server-name/tmp, where domain-name is the root directory of your domain.
For best performance, this directory should not be the same as the directory used by the JMS server's persistent store.
Type: string
Constraints: Restart Required, Has Default Value: null, Legal Null: true
Determines whether OS file locking is used.
When file locking protection is enabled, a store boot fails if another store instance already has opened the store files. Do not disable this setting unless you have procedures in place to prevent multiple store instances from opening the same file. File locking is not required but helps prevent corruption in the event that two same-named file store instances attempt to operate in the same directories. This setting applies to both primary and cache files.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.
When a native wlfileio driver is available, the setting applies to off-heap (native) memory.
When a native wlfileio driver is not available, the setting applies to JAVA heap memory.
For the best runtime performance, Oracle recommends setting PagingIOBufferSize so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).
See the JMS server runtime MBean attribute PagingAllocatedIOBufferBytes to find out the actual allocated off-heap (native) memory amount.
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 67108864
The paging maximum file size, in bytes.
The PagingMaxFileSize value affects the number of files needed to accommodate a paging store of a particular size (number of files = paging store size/MaxFileSize rounded up).
A paging store automatically reuses space freed by deleted records and automatically expands individual files up to PagingMaxFileSize if there is not enough space for a new record. If there is no space left in exiting files for a new record, a paging store creates an additional file.
A small number of larger files is normally preferred over a large number of smaller files as each file allocates Window Buffer and file handles.
If PagingMaxFileSize is larger than 2^24 * PagingBlockSize, then MaxFileSize is ignored, and the value becomes 2^24 * PagingBlockSize. The default PagingBlockSize is 512, and 2^24 * 512 is 8 GB.
Oracle recommends not setting the Paging Max File Size above the default value of 1,342,177,280.
Type: long
Constraints: Restart Required, Has Default Value: 1342177280, Minimum Value: 10485760
The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per paging store file. Applies only when a native wlfileio library is loaded.
A window buffer does not consume Java heap memory, but does consume off-heap (native) memory. If the paging store is unable to allocate the requested buffer size, it allocates smaller and smaller buffers until it reaches PagingMinWindowBufferSize, and then fails if it cannot honor PagingMinWindowBufferSize
Oracle recommends setting the max window buffer size to more than double the size of the largest write (multiple concurrently updated records may be combined into a single write), and greater than or equal to the file size, unless there are other constraints. 32-bit JVMs may impose a total limit of between 2 and 4GB for combined Java heap plus off-heap (native) memory usage.
See the JMS server runtime MBean attribute PagingAllocatedWindowBufferBytes to find out the actual allocated Window Buffer Size.
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 1073741824
Enables the JMS paging store to perform message body compression on persistent and non-persistent messages. When false, the default value, no compression is performed.
This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.
Type: boolean
Constraints: Has Default Value: false
The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per paging store file. Applies only when a native wlfileio library is loaded. See Paging Maximum Window Buffer Size
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 1073741824
The file or database in which this JMS server stores persistent messages. If unspecified, the JMS server uses the default persistent store that is configured on each targeted WebLogic Server instance. If the JMS server has a store configured, then the configured store is used to store persistent messages.
The disk-based file store or JDBC-accessible database store that you specify must be targeted to the same server, cluster, or migratable target instance as this JMS server. Multiple services on the same WebLogic Server instance, including multiple JMS servers, may share the same persistent store. Each service's persistent data will be kept apart.
If you specify a PersistentStore, the deprecated Store field must not be set. If neither the PersistentStore field nor the Store field are set, the JMS server supports persistent messaging using the default persistent store for the targeted WebLogic Server instance.
Type: weblogic.management.configuration.PersistentStoreMBean reference
Constraints: Restart Required
Specifies whether production is paused at server startup on destinations targeted to this JMS server. A destination cannot receive any new messages while it is paused.
When the value is set to true, then immediately after the host server instance is rebooted, then this JMS server and its targeted destinations are modified such that they are in a "production paused" state, which results in preventing new message production activities on those destinations.
To resume normal new message production activity, later you will have to change the state of this JMS server to a "production enabled" state by setting this value to false, and then either redeploy the JMS server or reboot the hosting server instance.
When the value is set to default, then the Production Paused At Startup is determined based on the corresponding setting on the individual destination.
Type: string
Constraints: Restart Required, Has Default Value: default
Specifies whether message persistence is supported for this JMS server.
When set to true: If the JMS server has no store configured, the targeted WebLogic Server instance's default store is used to store persistent messages. If the JMS server has a store configured, then the configured store is used to store persistent messages.
When set to false, then this JMS server does not support persistent messages, and instead downgrades them to non-persistent.
The default value is true
Oracle recommends not setting this parameter to false. It is available to provide compatibility with older releases.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Enables the JMS store to perform message body compression. When set to false, the default value, no compression is performed.
This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.
Type: boolean
Constraints: Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
The server instances, clusters, or a migratable targets defined in the current domain that are candidates for hosting the JMSSerer.
In a clustered environment, a recommended best practice is to use a cluster as a target or target a JMSServer to the same migratable target as the Persistent Store that it uses, so that a member server will not be a single point of failure. A JMSServer can also be configured to automatically migrate from an unhealthy server instance to a healthy server instance with the help of the automatic service migration feature.
Type: array of weblogic.management.configuration.TargetMBean references
The name of a configured JMS template that this JMS server uses to create temporary destinations.
Entering a template name, requires you to specify the JMS module that contains this template. However, a template name cannot be specified if the Hosting Temporary Destinations field is disabled.
Note: If the specified JMS template provides persistent store values, they are ignored because temporary destinations do not support persistent messaging.
Type: string
The name of a JMS module that contains a template that this JMS server can use to create temporary destinations.
Entering a JMS module name requires you to specify a temporary template name. However, a module name cannot be specified if the Hosting Temporary Destinations field is disabled.
Type: string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean defines a system-level JMS resource. It links a separate descriptor that specifies the definition.
The properties of the weblogic.management.configuration.JMSSystemResourceMBean entity are as follows:
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.
Type: string
Constraints: Restart Required
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.
Type: int
Constraints: Restart Required, Has Default Value: 100
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.
Type: string
Constraints: Restart Required
The name of the file that contains the module configuration. By default the file resides in the DOMAIN_DIR/config/jms directory.
The module file derives its name from the bean name using the following pattern:
<beanName>.xml
Note that this is a read-only property that can only be set when the bean is created.
Type: string
Constraints: Read Only, Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The values match those defined by jsr88. This attribute may move to another MBean.
Type: string
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return the Descriptor for the system resource. This should be overridden by the derived system resources.
Type: weblogic.descriptor.DescriptorBean reference
Constraints: Read Only, Restart Required
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
For each configuration entity that supports per-partition-override via a MBean, we have two MBeans, the original configure MBean and the corresponding override MBean, that eventually determine the effective settings of the configured resource. We mark an attribute of an override MBean "dynamic true" even though the original configure MBean masks it "dynamic false". This is to make sure that the overriding settings take effect on partition restart. Otherwise a server restart is required.
Defines partition-specific overrides for the most commonly overridden attributes in a JMS system resource descriptor file. It overrides some of the settings in a same-named JMSSystemResource MBean instance in the same multi-tenant scope to which this override MBean belongs.
The properties of the weblogic.management.configuration.JMSSystemResourceOverrideMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Controls which JMX agents are initialized in the current WebLogic Server domain. Each JMX agent supports specific functions such as monitoring run-time statistics or modifying the domain's configuration.
The properties of the weblogic.management.configuration.JMXMBean entity are as follows:
Enables JMX clients to use the deprecated MBeanHome interface.
Prior to 9.0, WebLogic Server supported a typed API layer over its JMX layer. Your JMX application classes could import type-safe interfaces for WebLogic Server MBeans, retrieve a reference to the MBeans through the weblogic.management.MBeanHome interface, and invoke the MBean methods directly.
Type: boolean
Constraints: Has Default Value: true
Specifies whether the Administration Server initializes the Domain MBean Server, which provides federated access to all run-time MBeans and read-only configuration MBeans in the domain. Through it, JMX clients can access all MBeans in a domain through a single connection.
The Administration Console and the WebLogic Scripting Tool use this MBean server for many (but not all) of their read operations.
This MBean server exists only on the Administration Server. The Administration Server initializes it the first time a JMX client requests a connection to it. If you set this attribute to false, the Administration Server will not start this MBean server and JMX clients cannot connect to it.
While this MBean server is instantiated lazily (only when requested), once it is instantiated it does use some memory and network traffic. Disabling this MBean server can conserve a minimal amount of resources, but the trade off is that JMX clients must maintain separate connections for each WebLogic Server's Runtime MBean Server.
Type: boolean
Constraints: Has Default Value: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies whether the Administration Server initializes the Edit MBean Server, which contains the hierarchy of MBeans used to make modifications to the domain's configuration. All JMX clients, including utilities such as the Administration Console and the WebLogic Scripting Tool, use the Edit MBean Server to modify a domain's configuration.
This MBean server exists only on the Administration Server. By default, when the Administration Server starts, it starts the Edit MBean Server. If you set the EditMBeanServerEnabled attribute to false, the Administration Server will not start this MBean server. If you disable this MBean server, JMX clients cannot modify the domain's configuration. You can, however, modify the domain configuration through the offline editing feature of WebLogic Scripting Tool.
Disabling the Edit MBean Server is not sufficient to prevent changes to a domain configuration. Because the WebLogic Server deployment service does not use JMX, the Administration Console and WLST can deploy or undeploy applications even if you have disabled the Edit MBean Server.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The number of seconds that internal WebLogic Server processes wait to connect to an MBean server, invoke an MBean server method, and return the results of the invocation. If the MBean server method does not complete (return) within the timeout period, WebLogic Server abandons its invocation attempt.
Some internal management processes within WebLogic Server require a server instance to connect to MBean servers in other WebLogic Server instances and invoke an MBean server method. The timeout period prevents the internal process from locking up if an MBean server cannot successfully return a method invocation.
A value of (zero) prevents the method invocation from timing out. With such a value, the internal process will wait indefinitely until the MBean server's method returns.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
Specifies whether the WebLogic Server Domain Runtime MBean Server will support notifications from the federated Runtime MBean Servers on the managed and administration servers.
Supporting notifications requires a significant amount of memory resources. A list of ObjectNames is maintained for each MBean from the Runtime MBean Servers. If notifications are not required for this domain, then disabling them will save on CPU and memory resources. This is particularly critical if there are large numbers of runtime MBeans and/or large numbers of servers.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Enables access to the Management EJB (MEJB), which is part of the Java EE Management APIs (JSR-77).
The Management API specification provides a standardized management data model for common resources on Java EE Web application servers.
The MEJB provides access to Java EE Managed Objects (JMOs), which describe the common Java EE resources. If you set this attribute to false, WebLogic Server does not register the MEJB in the JNDI tree, and effectively disables the Java EE Management APIs for the domain.
Type: boolean
Constraints: Has Default Value: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies whether each server instance initializes the JDK's platform MBean server. Enabling it, along with isPlatformMBeanServerUsed, causes WebLogic Server to use the platform MBean server as its Runtime MBean Server.
As of JDK 1.5, JVMs provide a platform MBean server that local processes can instantiate. There can be only one instance of the platform MBean server for each JVM. When a process instantiates this MBean server, the JVM creates several platform MXBeans that provide monitoring data for the JVM itself.
If you set this attribute to true, each WebLogic Server instance invokes the method java.lang.management.ManagementFactory.getPlatformMBeanServer() and thus causes the initialization of the JVM's MXBeans.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether WebLogic Server will use the platform MBean server for its Runtime MBean Server. Previously, WebLogic Server used the platform MBean server by default if it was enabled. This attribute provides a separation between enabling the platform MBean server and using it for WebLogic Server MBeans.
The default value for this attribute is based on the DomainVersion attribute of the DomainMBean. If the domain version is prior to 10.3.3.0, then the default value of this attribute is false and the platform MBean server is not used. If the domain version is 10.3.3.0 or higher, then the default value of this attribute is true and the platform MBean server is used.
In this case, the server's Runtime MBean Server uses the MBeanServer returned by java.lang.management.ManagementFactory.getPlatformMBeanServer() method as its MBean Server. This makes it possible to access the WebLogic Server MBeans and the JVM platform MXBeans from a single MBean server. In addition, if you enable the Runtime MBean Server to be the Platform MBean Server, local processes in the JVM can directly access this MBean server through the MBeanServer interface that java.lang.management.ManagementFactory.getPlatformMBeanServer() returns.
Type: boolean
Constraints: Restart Required
Specifies whether each server instance in the domain initializes its Runtime MBean Server, which provides access to a server's run-time MBeans and read-only configuration MBeans.
The Administration Console and the WebLogic Scripting Tool use this MBean server for some (but not all) of their read operations.
If RuntimeMBeanServerEnabled is true, each server starts its Runtime MBean Server during the server's startup cycle. If this attribute is false, no server instance in the domain will start its Runtime MBean Server.
Type: boolean
Constraints: Has Default Value: true
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This interface provides access to the JPA configuration attributes. The methods defined herein are applicable for JPA configuration at the domain level.
The properties of the weblogic.management.configuration.JPAMBean entity are as follows:
The configured default JPA provider for the domain.
Type: string
Constraints: Has Default Value: org.eclipse.persistence.jpa.PersistenceProvider
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This interface provides access to the JTA configuration attributes. The methods defined herein are applicable for JTA configuration at the clluster level.
The properties of the weblogic.management.configuration.JTAClusterMBean entity are as follows:
Indicates two-phase transaction recovery logs are written even if one or more determiners are configured.
Type: boolean
Constraints: Has Default Value: false
Specifies whether to use issuedtoken to enable authentication between the WS-AT coordinator and participant.
Type: boolean
Constraints: Has Default Value: false
Specifies transport security mode required by WebService Transaction endpoints.
Transport Security options:
SSLNotRequired All WebService Transaction protocol messages are exchanged over the HTTP channel.
SSLRequired All WebService Transaction protocol messages are and can only be exchanged over the HTTPS.
ClientCertRequired All WebService Transaction protocol messages are and can only be exchanged over the HTTPS, and WLS enforces the presence of client certificate
Type: string
Constraints: Has Default Value: SSLNotRequired, Legal Values: SSLNotRequired, SSLRequired, ClientCertRequired
Specifies the maximum amount of time, in seconds, a transaction manager persists in attempting to complete the second phase of a two-phase commit transaction.
During the second phase of a two-phase commit transaction, the transaction manager continues to try to complete the transaction until all resource managers indicate that the transaction is completed. After the abandon transaction timer expires, no further attempt is made to resolve the transaction. If the transaction is in a prepared state before being abandoned, the transaction manager rolls back the transaction to release any locks held on behalf of the abandoned transaction.
Type: int
Constraints: Minimum Value: 1, Maximum Value: 2147483647
The maximum number of cycles that the transaction manager performs the beforeCompletion synchronization callback for this cluster.
Nothing prevents a Synchronization object from registering another during beforeCompletion, even those whose beforeCompletions have already been called. For example, an EJB can call another in its ejbStore() method. To accommodate this, the transaction manager calls all Synchronization objects, then repeats the cycle if new ones have been registered. This count sets a limit to the number of cycles that synchronization occurs.
Type: int
Constraints: Minimum Value: 1, Maximum Value: 2147483647
The interval at which the transaction manager creates a new transaction log file and checks all old transaction log files to see if they are ready to be deleted.
Type: int
Constraints: Minimum Value: 10, Maximum Value: 1800
Indicates that cluster-wide recovery is used for distributed transactions.
When enabled, recovery operations for a distributed transaction are applied to all the servers of the cluster hosting a InterposedTransactionManager rather than just the server hosting the InterposedTransactionManager.
Type: boolean
Constraints: Has Default Value: false
Specifies the maximum amount of time, in seconds, a transaction manager waits for all resource managers to respond and indicate if the transaction can be committed or rolled back.
The default value is 0, which sets the value to approximately twice the default transaction-timeout value with a maximum value of 120 seconds. This value provides backward compatibility for prior releases without this setting.
If the specified value is -1, the maximum value supported by this attribute is used.
If the specified value exceeds the value set for abandon-timeout-seconds, the value of abandon-timeout-seconds is used.
Type: int
Constraints: Minimum Value: -1, Maximum Value: 2147483647
The interval at which a store lock for a given server in a recovery domain will be checked for takeover eligibility.
Type: int
Constraints: Has Default Value: 60, Minimum Value: 1, Maximum Value: 2147483647
The time after which a lease expires making it eligible for recovery by another site.
Type: int
Constraints: Has Default Value: 30, Minimum Value: 1, Maximum Value: 2147483647
The time in seconds in which to update at lease timestamp.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 1, Maximum Value: 2147483647
The interval at which a lease for a given server in a recovery domain will be checked for takeover eligibility.
Type: int
Constraints: Has Default Value: 60, Minimum Value: 1, Maximum Value: 2147483647
Returns a list of one or more transaction resources (determiners). A determiner's in-doubt transaction records are used during transaction recovery when a TLog is not present.
Type: array of weblogic.management.configuration.DeterminerCandidateResourceInfoVBean
Constraints: Read Only, Restart Required
Specifies a list of one or more transaction resources (determiners) separated by line breaks. A determiner's in-doubt transaction records are used during transaction recovery when a TLog is not present.
Type: array of string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies whether the transaction manager automatically performs an XA Resource forget operation for heuristic transaction completions.
When enabled, the transaction manager automatically performs an XA Resource forget() operation for all resources as soon as the transaction learns of a heuristic outcome. Disable this feature only if you know what to do with the resource when it reports a heuristic decision.
Type: boolean
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Maximum number of concurrent requests to resources allowed for each server.
Type: int
Constraints: Minimum Value: 10, Maximum Value: 2147483647
Maximum duration time, in milliseconds, that a resource is declared dead. After the duration, the resource is declared available again, even if the resource provider does not explicitly re-register the resource.
Type: long
Constraints: Minimum Value: 0, Maximum Value: 9223372036854775807
The maximum amount of time, in seconds, WebLogic Server waits for the determiner to recover from a failure. If the determiner does not recover after this period, WebLogic Server sets the TLog health state to HEALTH_FAILED.
Type: int
Constraints: Has Default Value: 300, Minimum Value: 0, Maximum Value: 2147483647
The maximum number of simultaneous in-progress transactions allowed on a server in this cluster.
Type: int
Constraints: Minimum Value: 1, Maximum Value: 2147483647
The interval for which the transaction map must be full for the JTA subsystem to declare its health as CRITICAL.
Type: long
Constraints: Minimum Value: 1000, Maximum Value: 9223372036854775807
The maximum number of unique transaction names for which statistics are maintained.
The first 1001 unique transaction names are maintained as their own transaction name and stored in each statistic. After the 1001st transaction name is reached, the transaction name is stored as weblogic.transaction.statistics.namedOverflow, and the transaction statistic is also merged and maintained in weblogic.transaction.statistics.namedOverflow
A transaction name typically represents a category of business transactions, such as "funds-transfer."
Type: int
Constraints: Minimum Value: 0, Maximum Value: 2147483647
Maximum allowed time duration, in milliseconds, for XA calls to resources. If a particular XA call to a resource exceeds the limit, the resource is declared unavailable.
Type: long
Constraints: Minimum Value: 0, Maximum Value: 9223372036854775807
The time interval, in seconds, that the checkpoint is done for the migrated transaction logs (TLOGs).
Type: int
Constraints: Minimum Value: 1, Maximum Value: 2147483647
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The dispatch policy to use when performing XA operations in parallel.
Type: string
Indicates that XA calls are executed in parallel if there are available threads.
Type: boolean
The interval that a particular resource must be accessed within for it to be included in the checkpoint record.
Type: int
Constraints: Minimum Value: 0, Maximum Value: 2147483647
The name of the site whose transactions this site/domain will recover in the event that intra-cluster transaction service migration is not successful or efficient.
Type: string
The interval that recovery is attempted until the resource becomes available.
Type: long
Constraints: Minimum Value: 60000, Maximum Value: 9223372036854775807
Specifies the security mode of the communication channel used for XA calls between servers that participate in a global transaction. All server instances in a domain must have the same security mode setting.
Security Interoperability Mode options:
default The transaction coordinator makes calls using the kernel identity over an admin channel if it is enabled, and anonymous otherwise. Man-in-the-middle attacks are possible if the admin channel is not enabled.
performance The transaction coordinator makes calls using anonymous at all times. This implies a security risk since a malicious third party could then try to affect the outcome of transactions using a man-in-the-middle attack.
compatibility The transaction coordinator makes calls as the kernel identity over an insecure channel. This is a high security risk because a successful man-in-the-middle attack would allow the attacker to gain administrative control over both domains. This setting should only be used when strong network security is in place.
Type: string
Constraints: Restart Required
The time interval, in milliseconds, at which internal objects used to serialize resource enlistment are cleaned up.
Type: long
Constraints: Minimum Value: 0
Indicates how long the server should wait for active transactions to complete before allowing shutdown.
Type: int
Constraints: Has Default Value: 180
Return all tags on this Configuration MBean
Type: array of string
Indicates tight coupling of transaction branches that span different transaction manager systems.
When enabled, WebLogic uses the transaction identifier of a transaction imported by the InterposedTransactionManager for XA calls rather than an internally mapped Xid. This applies to inter-domain WebLogic transactions and transactions imported from Tuxedo. This allows for tight coupling of transaction branches for transactions that span across different transaction manager systems.
If a transaction between WebLogic and Tuxedo resources uses a GridLink Data Source with GridLink Affinity enabled, the XA Affinity context is automatically used for the transaction.
Type: boolean
Constraints: Has Default Value: false
Specifies the maximum amount of time, in seconds, an active transaction is allowed to be in the first phase of a two-phase commit transaction. If the specified amount of time expires, the transaction is automatically rolled back.
Type: int
Constraints: Minimum Value: 1, Maximum Value: 2147483647
Indicates that the two-phase commit protocol is used to coordinate transactions across two or more resource managers.
If not selected:
Two-phase commit is disabled and any attempt to use two-phase commit results in a RollbackException being thrown.
All transaction logging is disabled, including checkpoint records.
Type: boolean
Constraints: Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The amount of time, in seconds, a transaction manager waits for transactions involving the resource to complete before unregistering a resource. This grace period helps minimize the risk of abandoned transactions because of an unregistered resource, such as a JDBC data source module packaged with an application.
During the specified grace period, the unregisterResource call blocks until the call returns and no new transactions are started for the associated resource. If the number of outstanding transactions for the resource goes to , the unregisterResource call returns immediately.
At the end of the grace period, if outstanding transactions are associated with the resource, the unregisterResource call returns and a log message is written to the server on which the resource was previously registered.
Type: int
Constraints: Minimum Value: 0, Maximum Value: 2147483647
This interface provides access to the JTA configuration attributes. The methods defined herein are applicable for JTA configuration at the domain level.
The properties of the weblogic.management.configuration.JTAMBean entity are as follows:
Indicates two-phase transaction recovery logs are written even if one or more determiners are configured.
Type: boolean
Constraints: Has Default Value: false
Specifies whether to use issuedtoken to enable authentication between the WS-AT coordinator and participant.
Type: boolean
Constraints: Has Default Value: false
Specifies transport security mode required by WebService Transaction endpoints.
Transport Security options:
SSLNotRequired All WebService Transaction protocol messages are exchanged over the HTTP channel.
SSLRequired All WebService Transaction protocol messages are and can only be exchanged over the HTTPS.
ClientCertRequired All WebService Transaction protocol messages are and can only be exchanged over the HTTPS, and WLS enforces the presence of client certificate
Type: string
Constraints: Has Default Value: SSLNotRequired, Legal Values: SSLNotRequired, SSLRequired, ClientCertRequired
Specifies the maximum amount of time, in seconds, a transaction manager persists in attempting to complete the second phase of a two-phase commit transaction.
During the second phase of a two-phase commit transaction, the transaction manager continues to try to complete the transaction until all resource managers indicate that the transaction is completed. After the abandon transaction timer expires, no further attempt is made to resolve the transaction. If the transaction is in a prepared state before being abandoned, the transaction manager rolls back the transaction to release any locks held on behalf of the abandoned transaction.
Type: int
Constraints: Has Default Value: 86400, Minimum Value: 1, Maximum Value: 2147483647
The maximum number of cycles that the transaction manager performs the beforeCompletion synchronization callback for this WebLogic Server domain.
Nothing prevents a Synchronization object from registering another during beforeCompletion, even those whose beforeCompletions have already been called. For example, an EJB can call another in its ejbStore() method. To accommodate this, the transaction manager calls all Synchronization objects, then repeats the cycle if new ones have been registered. This count sets a limit to the number of cycles that synchronization occurs.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 1, Maximum Value: 2147483647
The interval at which the transaction manager creates a new transaction log file and checks all old transaction log files to see if they are ready to be deleted.
Type: int
Constraints: Has Default Value: 300, Minimum Value: 10, Maximum Value: 1800
Indicates that cluster-wide recovery is used for distributed transactions.
When enabled, recovery operations for a distributed transaction are applied to all the servers of the cluster hosting a InterposedTransactionManager rather than just the server hosting the InterposedTransactionManager.
Type: boolean
Constraints: Has Default Value: false
Specifies the maximum amount of time, in seconds, a transaction manager waits for all resource managers to respond and indicate if the transaction can be committed or rolled back.
The default value is 0, which sets the value to approximately twice the default transaction-timeout value with a maximum value of 120 seconds. This value provides backward compatibility for prior releases without this setting.
If the specified value is -1, the maximum value supported by this attribute is used.
If the specified value exceeds the value set for abandon-timeout-seconds, the value of abandon-timeout-seconds is used.
Type: int
Constraints: Has Default Value: 0, Minimum Value: -1, Maximum Value: 2147483647
The time in seconds after which a lease expires making it eligible for recovery by another site.
Type: int
Constraints: Has Default Value: 30, Minimum Value: 1, Maximum Value: 2147483647
The time in seconds in which to update a lease timestamp.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 1, Maximum Value: 2147483647
The interval at which a lease for a given server in a recovery domain will be checked for takeover eligibility.
Type: int
Constraints: Has Default Value: 60, Minimum Value: 1, Maximum Value: 2147483647
Returns a list of one or more transaction resources (determiners). A determiner's in-doubt transaction records are used during transaction recovery when a TLog is not present.
Type: array of weblogic.management.configuration.DeterminerCandidateResourceInfoVBean
Constraints: Read Only, Restart Required
Select a transaction resource (determiner) from the list of resources. For JMS, select WebLogic JMS as the determiner. When a determiner is configured, the determiner's in-doubt transaction records are used during transaction recovery.
Type: array of string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies whether the transaction manager automatically performs an XA Resource forget operation for heuristic transaction completions.
When enabled, the transaction manager automatically performs an XA Resource forget() operation for all resources as soon as the transaction learns of a heuristic outcome. Disable this feature only if you know what to do with the resource when it reports a heuristic decision.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Maximum number of concurrent requests to resources allowed for each server.
Type: int
Constraints: Has Default Value: 50, Minimum Value: 10, Maximum Value: 2147483647
Maximum duration time, in milliseconds, that a resource is declared dead. After the duration, the resource is declared available again, even if the resource provider does not explicitly re-register the resource.
Type: long
Constraints: Has Default Value: 1800000, Minimum Value: 0, Maximum Value: 9223372036854775807
The maximum amount of time, in seconds, WebLogic Server waits for the determiner to recover from a failure. If the determiner does not recover after this period, WebLogic Server sets the TLog health state to HEALTH_FAILED.
Type: int
Constraints: Has Default Value: 300, Minimum Value: 0, Maximum Value: 2147483647
The maximum number of simultaneous in-progress transactions allowed on a server in this WebLogic Server domain.
Type: int
Constraints: Has Default Value: 10000, Minimum Value: 1, Maximum Value: 2147483647
The maximum number of unique transaction names for which statistics are maintained.
The first 1001 unique transaction names are maintained as their own transaction name and stored in each statistic. After the 1001st transaction name is reached, the transaction name is stored as weblogic.transaction.statistics.namedOverflow, and the transaction statistic is also merged and maintained in weblogic.transaction.statistics.namedOverflow
A transaction name typically represents a category of business transactions, such as "funds-transfer."
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Maximum allowed time duration, in milliseconds, for XA calls to resources. If a particular XA call to a resource exceeds the limit, the resource is declared unavailable.
Type: long
Constraints: Has Default Value: 120000, Minimum Value: 0, Maximum Value: 9223372036854775807
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Indicates that XA calls are executed in parallel if there are available threads.
Type: boolean
Constraints: Has Default Value: true
The name of the site whose transactions this site/domain will recover in the event that intra-cluster transaction service migration is not successful or efficient.
Type: string
Specifies the security mode of the communication channel used for XA calls between servers that participate in a global transaction. All server instances in a domain must have the same security mode setting.
Security Interoperability Mode options:
default The transaction coordinator makes calls using the kernel identity over an admin channel if it is enabled, and anonymous otherwise. Man-in-the-middle attacks are possible if the admin channel is not enabled.
performance The transaction coordinator makes calls using anonymous at all times. This implies a security risk since a malicious third party could then try to affect the outcome of transactions using a man-in-the-middle attack.
compatibility The transaction coordinator makes calls as the kernel identity over an insecure channel. This is a high security risk because a successful man-in-the-middle attack would allow the attacker to gain administrative control over both domains. This setting should only be used when strong network security is in place.
Type: string
Constraints: Restart Required, Has Default Value: default, Legal Values: default, performance, compatibility
The time interval, in milliseconds, at which internal objects used to serialize resource enlistment are cleaned up.
Type: long
Constraints: Has Default Value: 30000, Minimum Value: 0
Indicates how long the server should wait for active transactions to complete before allowing shutdown.
Type: int
Constraints: Has Default Value: 180
Return all tags on this Configuration MBean
Type: array of string
Indicates tight coupling of transaction branches that span different transaction manager systems.
When enabled, WebLogic uses the transaction identifier of a transaction imported by the InterposedTransactionManager for XA calls rather than an internally mapped Xid. This applies to inter-domain WebLogic transactions and transactions imported from Tuxedo. This allows for tight coupling of transaction branches for transactions that span across different transaction manager systems.
If a transaction between WebLogic and Tuxedo resources uses a GridLink Data Source with GridLink Affinity enabled, the XA Affinity context is automatically used for the transaction.
Type: boolean
Constraints: Has Default Value: false
Specifies the maximum amount of time, in seconds, an active transaction is allowed to be in the first phase of a two-phase commit transaction. If the specified amount of time expires, the transaction is automatically rolled back.
Type: int
Constraints: Has Default Value: 30, Minimum Value: 1, Maximum Value: 2147483647
Indicates that the two-phase commit protocol is used to coordinate transactions across two or more resource managers.
If not selected:
Two-phase commit is disabled and any attempt to use two-phase commit results in a RollbackException being thrown.
All transaction logging is disabled, including checkpoint records.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The amount of time, in seconds, a transaction manager waits for transactions involving the resource to complete before unregistering a resource. This grace period helps minimize the risk of abandoned transactions because of an unregistered resource, such as a JDBC data source module packaged with an application.
During the specified grace period, the unregisterResource call blocks until the call returns and no new transactions are started for the associated resource. If the number of outstanding transactions for the resource goes to , the unregisterResource call returns immediately.
At the end of the grace period, if outstanding transactions are associated with the resource, the unregisterResource call returns and a log message is written to the server on which the resource was previously registered.
Type: int
Constraints: Has Default Value: 30, Minimum Value: 0, Maximum Value: 2147483647
The target that is used internally to register the JTA recovery manager to the Migration Manager.
The properties of the weblogic.management.configuration.JTAMigratableTargetMBean entity are as follows:
A migratable service could fail to come up on every possible configured server. This attribute controls how many further attempts, after the service has failed on every server at least once, should be tried. Note that each attempt specified here indicates another full circuit of migrations amongst all the configured servers. So for a 3-server cluster, and a value of 2, a total of 4 additional migrations will be attempted. (the original server is never a valid destination)
Type: int
Constraints: Restart Required, Has Default Value: 2
The list of servers that are candidates to host the migratable services deployed to this migratable target. If the constrainedCandidateServers list is empty, all servers in the cluster are returned. If the constrainedCandidateServers list is not empty, only those servers will be returned. The user-preferred server will be the first element in the list.
Type: array of weblogic.management.configuration.ServerMBean references
Returns the cluster this singleton service is associated with.
Type: weblogic.management.configuration.ClusterMBean reference
Constraints: Restart Required
The (user-restricted) list of servers that can host the migratable services deployed to this migratable target. The migratable service will not be allowed to migrate to a server that is not in the returned list of servers.
For example, this feature may be used to configure two servers that have access to a dual-ported ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.
Type: array of weblogic.management.configuration.ServerMBean references
Constraints: Restart Required
Returns true if the MigratableTarget is critical to the overall health of the WLS Server
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Returns the name of the server that currently hosts the singleton service.
Type: weblogic.management.configuration.ServerMBean reference
Constraints: Read Only
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Type: string
Constraints: Restart Required, Has Default Value: manual, Legal Values: manual, failure-recovery, shutdown-recovery
Controls how long of a pause there should be between the migration attempts described in getAdditionalMigrationAttempts(). Note that this delay only happens when the service has failed to come up on every server. It does not cause any sort of delay between attempts to migrate otherwise.
Type: int
Constraints: Restart Required, Has Default Value: 300000
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Specifies whether or not the post-deactivation script is allowed to run on a different machine.
Normally, when auto migration occurs, the post-deactivation script will be run on the service's current location, and the pre-activation script on the service's new location. If the current location is unreachable for some reason, this value will be checked to see if it is safe to run it on the service's new machine.
This is useful if the post-deactivation script controls access to a networked resource and does not need any data from the current machine.
Type: boolean
Constraints: Restart Required, Has Default Value: false
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.
Type: string
Specifies how many restart attempts to make before migrating the failed service.
Note that these are consecutive attempts. If the value is set to 6, and the service restart fails 5 times before succeeding, but then fails again later, it will not instantly migrate. Each failure gets its own count of restart attempts.
A value of 0 is identical to setting getRestartOnFailure to false. A value of -1 indicates the service should never be migrated; instead, it will be restarted until it either works or the server shuts down.
Type: int
Constraints: Restart Required, Has Default Value: 6
Specifies the path to the post-migration script to run after a migratable target is fully deactivated. The script must be in the MIDDLEWARE_HOME/user_projects/domains/mydomain/bin/service_migration directory.
After the migratable target is deactivated, if there is a script specified, and Node Manager is available, then the script will run. Specifying a script without an available Node Manager will result in an error upon migration.
Type: string
Constraints: Restart Required
Specifies whether or not a failure during execution of the post-deactivation script is fatal to the migration.
If it is fatal, the migratable target will not be automatically migrated until an administrator manually migrates it to a server, thus reactivating it.
Note: Enabling this value will result in weakening the exactly-once guarantee. It is provided to prevent more dangerous data corruption if the post-deactivation script fails. Also if this value is enabled, then the script may be called more than once by the migration framework after the Migratable Target is deactivated or the server or machine hosting the Migratable Target crashed or is network partitioned. The script is expected not to return different exit values when invoked multiple times in such scenarios.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies the path to the pre-migration script to run before a migratable target is actually activated. The script must be in the MIDDLEWARE_HOME/user_projects/domains/mydomain/bin/service_migration directory.
Before the migratable target is activated, if there is a script specified, and Node Manager is available, then the script will run. Specifying a script without an available Node Manager will result in an error upon migration.
If the script fails or cannot be found, migration will not proceed on the current server, and will be tried on the next suitable server. This could be the next server in the candidate server list, or in the cluster, if there is no candidate server list.
Type: string
Constraints: Restart Required
Specifies whether or not a failed service will first be deactivated and reactivated in place, instead of being migrated.
The number of restart attempts is controlled by getNumberOfRestartAttempts. Once these restart attempts are exhausted, the service will migrate. A restarting migratable target will deactivate all services on it in order, then reactivate them all.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies how many seconds to wait in between attempts to restart the failed service.
Type: int
Constraints: Restart Required, Has Default Value: 30
Whether continue to boot if cannot find the current owner of TRS to do failback. This attribute is only meaningful for servers in cluster.
If true: server will fail to boot under this situation.
If false: server will continue to boot without trying to do failback.
Type: boolean
Constraints: Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Returns the server that the user prefers the singleton service to be active on.
Type: weblogic.management.configuration.ServerMBean reference
This interface provides access to the JTAPartition configuration attributes. The methods defined herein are applicable for JTA configuration at the partition level.
The properties of the weblogic.management.configuration.JTAPartitionMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Specifies the maximum amount of time, in seconds, an active transaction is allowed to be in the first phase of a two-phase commit transaction. If the specified amount of time expires, the transaction is automatically rolled back.
Type: int
Constraints: Minimum Value: 1, Maximum Value: 2147483647
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean defines a Jolt connection pool.
The properties of the weblogic.management.configuration.JoltConnectionPoolMBean entity are as follows:
The application password for this Jolt connection pool. (This is required only when the security level in the Tuxedo domain is USER_AUTH, ACL or MANDATORY_ACL).
As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the ApplicationPasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the ApplicationPasswordEncrypted attribute to the encrypted value.
Using this attribute (ApplicationPassword) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use ApplicationPasswordEncrypted
Type: string
Constraints: Restart Required, Encrypted, Has Secure Value: null
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The list of Jolt Server Listeners (JSLs) addresses that is used if the connection pool cannot estabilish connections to the Primary Addresses, or if the primary connections fail.
The format of each address is: //hostname:port. Multiple addresses should be separated by commas.
These JSLs need not reside on the same host as the primary JSLs.
Type: array of string
Constraints: Restart Required
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The encrypted identity passphrase.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the KeyPassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the KeyPassPhraseEncrypted attribute to the encrypted value.
Using this attribute (KeyPassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use KeyPassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
The path and file name of the keystore containing the private key used in SSL mutual authentication.
Type: string
Constraints: Restart Required
The encrypted identity keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the KeyStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the KeyStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (KeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use KeyStorePassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
The maximum number of connections that can be made from this Jolt connection pool.
Type: int
Constraints: Restart Required, Has Default Value: 1, Minimum Value: 1, Maximum Value: 2147483647
The minimum number of connections to be added to this Jolt connection pool when WebLogic Server starts.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The list of addresses for the primary Jolt Server Listeners (JSLs) on the Tuxedo system.
The format of each address is: //hostname:port. Multiple addresses should be separated by commas.
Type: array of string
Constraints: Restart Required
The number of seconds the client waits to receive a response before timing out.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
Indicates whether this Jolt connection pool passes the connection pool's security context (user name, password and other information) from the WebLogic Server user to the Tuxedo domain.
If you enable the connection pool to pass the security context, you must start the Jolt Service Handler (JSH) with the -a option. When the JSH gets a message with the caller's identity, it calls impersonate_user() to get the appkey for the user. JSH caches the appkey, so the next time the caller makes a request, the appkey is retrieved from the cache and the request is forwarded to the service. A cache is maintained by each JSH, which means that there will be a cache maintained for all the session pools connected to the same JSH.
You must enable Security Context if Tuxedo requires secured connections.
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
The path and file name of the keystore containing the trust certificates.
Type: string
Constraints: Restart Required
The encrypted trust keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the TrustStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the TrustStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (TrustStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use TrustStorePassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A user name that applications specify to connect to this Jolt connection pool. If Security Context is enabled, this name must be the name of an authorized Tuxedo user. (Specifying a Tuxedo user name is required if the Tuxedo authentication level is USER_AUTH.)
Type: string
Constraints: Restart Required
The user password for this Jolt connection pool.
As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the UserPasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the UserPasswordEncrypted attribute to the encrypted value.
Using this attribute (UserPassword) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use UserPasswordEncrypted
Type: string
Constraints: Restart Required, Encrypted
The Tuxedo user role for this Jolt connection pool. (This is required only when the security level in the Tuxedo domain is USER_AUTH, ACL, or MANDATORY_ACL).
Type: string
Constraints: Restart Required
Configuration bean for Libraries.
The properties of the weblogic.management.configuration.LibraryMBean entity are as follows:
The fully resolved location of this application's alternate descriptor directory on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
The fully resolved location of this application's alternate descriptor on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
The fully resolved location of this application's installation root directory on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
The fully resolved location of this application's deployment plan directory on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
The fully resolved location of this application's deployment plan on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
The fully resolved location of this application's source files on the Administration Server.
Type: string
Constraints: Read Only, Restart Required
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.
Type: string
Constraints: Read Only
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.
Type: string
Constraints: Read Only, Restart Required
The name of the application.
Note that the name of the current MBean is not the name of the application.
Type: string
Constraints: Read Only, Restart Required
Type: boolean
Constraints: Restart Required
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.
Type: string
Constraints: Restart Required
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.
Type: int
Constraints: Restart Required, Has Default Value: 100
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.
Type: string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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.
Type: string
Constraints: Read Only, Restart Required
The values match those defined by jsr88. This attribute may move to another MBean.
Type: string
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Determines if the modules of applications will be deployed in parallel.
Type: boolean
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.
Type: string
Constraints: Read Only
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.
Type: string
Constraints: Read Only
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.
Type: string
Constraints: Read Only, Has Default Value: null, Legal Values: nostage, stage, external_stage
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 weblogic.management.security.RealmMBean#getSecurityDDModel 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:
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.xml and restarting the server, the order of precedence is:
The value that you specify for the module in config.xml
The default value of this AppDeploymentMBean SecurityDDModel attribute.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: DDOnly, Legal Values: DDOnly, CustomRoles, CustomRolesAndPolicies, Advanced
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.
Type: string
Constraints: Read Only, Restart Required
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.
Type: string
Constraints: Read Only, Has Default Value: null, Legal Values: nostage, stage, external_stage
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
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.
Type: boolean
Constraints: Restart Required, Has Default Value: false
This attribute is not used in the current release.
Type: boolean
Constraints: Has Default Value: false
Uniquely identifies the application version across all versions of the same application.
If the application is not versioned, this returns null.
Type: string
Constraints: Read Only, Restart Required
LifecycleManagerConfigMBean maintains the information necessary to enable and configure a LifecycleManager instance associated with this domain. LifecycleManager instances may either be local or remote to this domain. User credentials may be configured to support authentication, especially important when interaction with a remote domain.
The properties of the weblogic.management.configuration.LifecycleManagerConfigMBean entity are as follows:
Returns setting for connect timeout for LCM initiated REST requests which may have been triggered by OOB, sync, patching. 0 return implies that the option is disabled (i.e., timeout of infinity).
Type: int
Constraints: Has Default Value: 0
Returns setting for connect timeout for LCM initiated REST requests triggered by Elasticity 0 return implies that the option is disabled (i.e., timeout of infinity).
Type: int
Constraints: Has Default Value: 0
Type: int
Constraints: Has Default Value: 0
Type: int
Constraints: Has Default Value: 0
Returns the Lifecycle configuration lock timeout. This is used when the persistence type is LifecycleManagerConfigMBean.PERSISTENCE_TYPE_XML, while attempting to lock the configuration file to persist configuration changes.
Type: long
Constraints: Has Default Value: 120000
Returns the name of the DataSource that should be used when LifecycleManager is configured to maintain its configuration in a database.
Type: string
The deployment model for LifecycleManager services in this domain.
Type: string
Constraints: Restart Required, Has Default Value: none, Legal Values: none, admin, cluster
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Determine if LifeycleManager features are available, either locally on this admin server or remotely via a configured endpoint.
Type: boolean
Constraints: Read Only
Returns the REST endpoints for each LifecycleManager that is participating in the management of this domain.
Type: array of weblogic.management.configuration.LifecycleManagerEndPointMBean references
Constraints: Read Only
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Determine if LifecycleManager should listen for configuration changes on this server.
Type: boolean
Constraints: Has Default Value: false
Get periodic interval for lifecycle configuration synchronization in hours. When synchronizing configuration, Lifecycle contacts the different runtimes that are registered with it, gets the list of partitions from those runtimes, and ensure that its configuration is synchronized with those runtimes.
Type: int
Constraints: Restart Required, Has Default Value: 2
The persistence model that is used by this LifecycleManager service. Either database or a local XML file may be used for an admin server deployment, but a database configuration model is required for a cluster deployment.
Type: string
Constraints: Restart Required, Has Default Value: XML, Legal Values: XML, database
Returns the activation timeout in milliseconds for Lifecycle configuration propagation to managed server.
Type: long
Constraints: Has Default Value: 180000
Return all tags on this Configuration MBean
Type: array of string
The cluster target defined in the current domain that should host the LifecycleManager service when running deployed in Cluster mode.
Type: weblogic.management.configuration.TargetMBean reference
Constraints: Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
LifecycleManagerEndPointMBean maintains the information necessary to locate and interact with an MT LifecycleManager instance associated with this domain. This information is used by WebLogic Server components to share configuration and runtime changes in a broader context. LifecycleManager instances may either be local or remote to this domain. User credentials may be configured to support authentication, especially important when interaction with a remote domain.
The properties of the weblogic.management.configuration.LifecycleManagerEndPointMBean entity are as follows:
Returns the URL for the root REST resource for the LifecycleManager instance. For example, http://localhost:7001/lifecycle/12.2.1.0/
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Returns true if this LifecycleManager endpoint configuration is active and should be used when a WebLogic Server component needs to share a configuration change.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Get the password in clear text. (disallowed by default - use getPasswordEncrypted)
Type: string
Constraints: Restart Required, Encrypted
Returns the runtime name for this WebLogic Server domain. This name can be used to override the domain name of the local domain from the perspective of LifecycleManager.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The user name that will be passed when opening a connection to a LifecycleManager instance (specified by the URL value for this endpoint). If not set, then no user name will be specified when establishing an connection.
Type: string
This MBean represents a filter to qualify log messages which are selected by the specified filter expression criteria. A message must meet all the specified criteria to qualify the filter. Multiple instances of this MBean can be defined, if needed. If there are multiple instances, a message must qualify at least one filter to qualify for the log file.
The properties of the weblogic.management.configuration.LogFilterMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The filter expression to be evaluated for qualifying log messages.
The filter expression is specified as a string in the query language. The query language supports Boolean operators: AND, OR, and NOT, and relational operators. You can use the following column names (message attributes) in a query to filter data going to a log destination: RECORDID, DATE, SEVERITY, SUBSYSTEM, MACHINE, SERVER, THREAD, USERID, TXID, CONTEXTID, TIMESTAMP, MSGID, and MESSAGE.
Type: string
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configures the threshold severity level and filter settings for logging output.
Specifies whether the server logging is based on a Log4j implementation or the default Java Logging APIs.
Redirects the JVM stdout and stderr output to the registered log destinations.
The properties of the weblogic.management.configuration.LogMBean entity are as follows:
Gets the underlying log buffer size in kilobytes
Type: int
Constraints: Has Default Value: 8
The date format pattern used for rendering dates in the log. The DateFormatPattern string conforms to the specification of the java.text.SimpleDateFormat class.
Type: string
Constraints: Legal Null: true
The filter configuration for log events being sent to the domain log.
Type: weblogic.management.configuration.LogFilterMBean reference
The minimum severity of log messages going to the domain log from this server's log broadcaster. Messages with a lower severity than the specified value will not be published to the domain log.
Type: string
Constraints: Has Default Value: Notice, Legal Values: Debug, Info, Warning, Error, Notice, Critical, Alert, Emergency, Off
Broadcasts log messages to the domain log in batch mode.
The size of the buffer for log messages that are sent to the domain log. The buffer is maintained on the Managed Server and is broadcasted to the domain log when it is full.
If you notice performance issues due to a high rate of log messages being generated, set this value higher. This will cause the buffer to be broadcasted less frequently from the Managed Server to the domain log. In production environments, it is not recommended to set the buffer size lower than the production default of 10.
Type: int
Constraints: Has Default Value: 1, Has Production Mode Default Value: 10, Minimum Value: 1, Maximum Value: 100
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)
Type: int
Constraints: Has Default Value: 7, Has Production Mode Default Value: 100, Minimum Value: 1, Maximum Value: 99999
The size (1 - 2097150 kilobytes) that triggers the server to move log messages to a separate file. The default is 500 kilobytes. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as SERVER_NAME.lognnnnn and create a new one to store subsequent messages. (Requires that you specify a file rotation type of Size.)
Type: int
Constraints: Has Default Value: 500, Has Production Mode Default Value: 5000, Minimum Value: 1, Maximum Value: 2097150
The name of the file that stores current log messages. Usually it is a computed value based on the name of the parent of this MBean. For example, for a server log, it is SERVER_NAME.log
However, if the name of the parent cannot be obtained, the file name is weblogic.log. If you specify a relative pathname, it is interpreted as relative to the server's root directory.
To include a time and date stamp in the file name when the log file is rotated, add java.text.SimpleDateFormat variables to the file name. Surround each variable with percentage () characters.
For example, if the file name is defined to be myserver_%yyyy%_%MM%_%dd%_%hh%_%mm%.log, the log file will be named myserver_yyyy_mm_dd_hh_mm.log
When the log file is rotated, the rotated file name contains the date stamp. For example, if the log file is rotated for the first time on 2 April, 2003 at 10:05 AM, the log file that contains the old messages will be named myserver_2003_04_02_10_05.log00001
If you do not include a time and date stamp, the rotated log files are numbered in order of creation. For example, myserver.log00007
Type: string
The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of TIME.)
Type: int
Constraints: Has Default Value: 24, Minimum Value: 1
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The filter configuration for the server log file.
A filter configuration defines simple filtering rules to limit the volume of log messages written to the log file.
Type: weblogic.management.configuration.LogFilterMBean reference
The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.
Type: string
The minimum severity of log messages going to the server log file. By default all messages go to the log file.
Type: string
Constraints: Has Default Value: Trace, Legal Values: Trace, Debug, Info, Notice, Warning
Enable or disable log monitoring.
Type: boolean
Constraints: Has Default Value: true
Timer interval in seconds to check the counts of messages logged during the interval.
Type: int
Constraints: Has Default Value: 30, Minimum Value: 5
Maximum number of unique message signatures that will be monitored during the throttle interval.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 100, Maximum Value: 5000
Cut-off length of the log message for evaluation during throttle period. The log message length is truncated to this length for evaluation of repeated logging events.
Type: int
Constraints: Has Default Value: 50, Minimum Value: 10, Maximum Value: 500
The threshold number of messages logged during the evaluation period which enables or disables the throttling.
Once throttling is enabled messages with the same repeating message signatures are throttled. Every nth repeated message specified by this attribute is logged in a monitoring cycle.
Type: int
Constraints: Has Default Value: 1500, Minimum Value: 5
The minimum severity of log messages going to all log destinations.
Type: string
Constraints: Has Default Value: Info, Legal Values: Trace, Debug, Info, Notice, Warning
The configuration of the different logger severities keyed by name. The values are one of the predefined Severity strings namely Emergency, Alert, Critical, Error, Warning, Notice, Info, Debug, Trace.
Type: java.util.Properties
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of SIZE or TIME.)
After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.
If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.
Type: boolean
Constraints: Has Default Value: true, Has Production Mode Default Value: true
Specifies the platform logger and the associated level names set through the WebLogic Server configuration.
Note the following behavior:
The configuration is applicable for java.util.logging.Logger instances in the JDK's default global LogManager.
WebLogic Server loggers are configured in terms of weblogic.logging.Severities through the LoggerSeverities attribute. These loggers are not available in the JDK's default global LogManager.
Type: java.util.Properties
Specifies whether the stderr of the JVM in which a WebLogic Server instance runs is redirected to the WebLogic Logging system. When this attribute is enabled, the stderr content is published to all the registered log destinations, such as the server terminal console and log file.
Note that JVM messages are redirected asynchronously. In the event of an overload situation, these messages may be dropped. As a best practice, Oracle recommends using one of the supported logging APIs instead.
Type: boolean
Constraints: Restart Required
Specifies whether the stdout of the JVM in which a WebLogic Server instance runs is redirected to the WebLogic logging system. When this attribute is enabled, the stdout content is published to all the registered log destinations, such as the server terminal console and log file.
Note that JVM messages are redirected asynchronously. In the event of an overload situation, these messages may be dropped. As a best practice, Oracle recommends using one of the supported logging APIs instead.
Type: boolean
Constraints: Restart Required
Specifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.
Type: boolean
Constraints: Has Default Value: true, Has Production Mode Default Value: false
Determines the start time (hour and minute) for a time-based rotation sequence.
At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.
Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.
Use the following format: H:mm, where
is Hour in day (0-23)
mm is the minute in hour
Type: string
Constraints: Has Default Value: 00:00
Criteria for moving old log messages to a separate file.
NONE Messages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.
SIZE When the log file reaches the size that you specify in FileMinSize, the server renames the file as SERVER_NAME.lognnnnn
TIME At each time interval that you specify in TimeSpan, the server renames the file as SERVER_NAME.lognnnnn
After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.
Type: string
Constraints: Has Default Value: bySize, Legal Values: bySize, byTime, none
The filter configuration for log events being sent to the standard out.
Type: weblogic.management.configuration.LogFilterMBean reference
The output format to use when logging to the console.
Type: string
Constraints: Restart Required, Has Default Value: standard, Legal Values: standard, noid
Specifies whether to dump stack traces to the console when included in logged message.
Type: boolean
Constraints: Has Default Value: true
The minimum severity of log messages going to the standard out. Messages with a lower severity than the specified value will not be published to standard out.
Type: string
Constraints: Has Default Value: Notice, Legal Values: Trace, Debug, Info, Warning, Error, Notice, Critical, Alert, Emergency, Off
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean represents a machine on which servers may be booted. A server is bound to a machine by calling to ServerMBean.setMachine(). Although it is typical that one MachineMBean refers to one physical machine and vice versa, it is possible to have a multihomed machine represented by multiple MachineMBeans. The only restriction is that each MachineMBean be configured with non-overlapping addresses. A configuration may contain one or more of MachineMBeans which may be looked up by their logical names.
The properties of the weblogic.management.configuration.MachineMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Facilitates using the JavaMail APIs, which provide applications and other Java EE modules with access to Internet Message Access Protocol (IMAP)- and Simple Mail Transfer Protocol (SMTP)-capable mail servers on your network or the Internet.
In the reference implementation of JavaMail, applications must instantiate javax.mail.Session objects, which designate mail hosts, transport and store protocols, and a default mail user for connecting to a mail server. In WebLogic Server, you create a mail session, which configures a javax.mail.Session object and registers it in the WebLogic Server JNDI tree. Applications access the mail session through JNDI instead of instantiating their own javax.mail.Session object.
The properties of the weblogic.management.configuration.MailSessionMBean entity are as follows:
The JNDI Name associated with this resource.
Type: string
Constraints: Restart Required, Legal Null: true
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
jmsserverjmshat on
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The configuration options and user authentication data that this mail session uses to interact with a mail server. Each property that you specify overrides the default property value as defined by the JavaMail API Design Specification.
Include only the properties defined by the JavaMail API Design Specification.
If you do not specify any properties, this mail session will use the JavaMail default property values.
Express each property as a namevalue pair. Separate multiple properties with a semicolon ().
Type: java.util.Properties
Constraints: Restart Required
The decrypted JavaMail Session password attribute, for use only temporarily in-memory; the value returned by this attribute should not be held in memory long term.
The value is stored in an encrypted form in the descriptor file and when displayed in an administration console.
Type: string
Constraints: Restart Required, Encrypted
Returns the username to be used to create an authenticated JavaMail Session, using a JavaMail Authenticator instance; if this is not set, it will be assumed that the Session is not to be authenticated.
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Defines partition-specific mail session attribute overrides of a mail session referenced by a partition resource group definition.
The properties of the weblogic.management.configuration.MailSessionOverrideMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The configuration options and user authentication data that this mail session uses to interact with a mail server.
Type: java.util.Properties
The decrypted JavaMail Session password attribute, for use only temporarily in-memory; the value returned by this attribute should not be held in memory long term.
Type: string
Constraints: Encrypted
The username to be used to create an authenticated JavaMail Session, using a JavaMail Authenticator instance.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configuration MBean representing parameters of partition level ManagedExecutorService.
The properties of the weblogic.management.configuration.ManagedExecutorServiceMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
The name of the Work Manager to use for this Concurrent Managed Ojbect (CMO). If a Work Manager is not specified, the default one is used.
Type: string
Constraints: Has Default Value:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
An integer that specifies the long-running daemon thread's priority. If a value is specified, all long-running threads are affected.
Type: int
Constraints: Has Default Value: 5, Minimum Value: 1, Maximum Value: 10
The maximum number of running long-running tasks submitted to this CMO.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 65534
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configuration MBean representing parameters of ManagedExecutorService template.
The properties of the weblogic.management.configuration.ManagedExecutorServiceTemplateMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
The name of the Work Manager to use for this Concurrent Managed Ojbect (CMO). If a Work Manager is not specified, the default one is used.
Type: string
Constraints: Has Default Value:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
An integer that specifies the long-running daemon thread's priority. If a value is specified, all long-running threads are affected.
Type: int
Constraints: Has Default Value: 5, Minimum Value: 1, Maximum Value: 10
The maximum number of running long-running tasks submitted to this CMO.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 65534
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configuration MBean representing parameters of partition level ManagedScheduledExecutorService.
The properties of the weblogic.management.configuration.ManagedScheduledExecutorServiceMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
The name of the Work Manager to use for this Concurrent Managed Ojbect (CMO). If a Work Manager is not specified, the default one is used.
Type: string
Constraints: Has Default Value:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
An integer that specifies the long-running daemon thread's priority. If a value is specified, all long-running threads are affected.
Type: int
Constraints: Has Default Value: 5, Minimum Value: 1, Maximum Value: 10
The maximum number of running long-running tasks submitted to this CMO.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 65534
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configuration MBean representing parameters of ManagedScheduledExecutorService template.
The properties of the weblogic.management.configuration.ManagedScheduledExecutorServiceTemplateMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
The name of the Work Manager to use for this Concurrent Managed Ojbect (CMO). If a Work Manager is not specified, the default one is used.
Type: string
Constraints: Has Default Value:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
An integer that specifies the long-running daemon thread's priority. If a value is specified, all long-running threads are affected.
Type: int
Constraints: Has Default Value: 5, Minimum Value: 1, Maximum Value: 10
The maximum number of running long-running tasks submitted to this CMO.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 65534
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configuration MBean representing parameters of partition level ManagedThreadFactory.
The properties of the weblogic.management.configuration.ManagedThreadFactoryMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The maximum number of concurrent new threads that can be created by this Managed Thread Factory (MTF).
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 65534
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
An integer that specifies the daemon thread's priority. If a value is specified, all concurrent new threads created by this MTF are affected.
Type: int
Constraints: Has Default Value: 5, Minimum Value: 1, Maximum Value: 10
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configuration MBean representing common parameters of ManagedThreadFactory template.
The properties of the weblogic.management.configuration.ManagedThreadFactoryTemplateMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The maximum number of concurrent new threads that can be created by this Managed Thread Factory (MTF).
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 65534
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
An integer that specifies the daemon thread's priority. If a value is specified, all concurrent new threads created by this MTF are affected.
Type: int
Constraints: Has Default Value: 5, Minimum Value: 1, Maximum Value: 10
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean defines the max number of concurrent threads that can execute requests sharing this max constraint.
MaxThreadsConstraint can be used to tell the server that the requests are constrained by an external resource like a database and allocating more threads that the external resource limit is not going to help since the extra threads are just going to wait.
The properties of the weblogic.management.configuration.MaxThreadsConstraintMBean entity are as follows:
Name of the connection pool whose size is taken as the max constraint.
This can be the name of a JDBC data source. The max capacity of the data source is used as the constraint.
Type: string
Constraints: Restart Required
Maximum number of concurrent threads that can execute requests sharing this constraint.
A count of 0 or -1 is treated as if the constraint is not present. This means that no constraint is enforced for these two values. A count > 0 can be dynamically changed to 0 to indicate that constraint enforcement is no longer needed.
Type: int
Constraints: Has Default Value: -1
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Desired size of the MaxThreadsConstraint queue for requests pending execution.
Type: int
Constraints: Restart Required, Has Default Value: 8192, Minimum Value: 256, Maximum Value: 1073741824
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean represents a WebLogic messaging bridge. A messaging bridge instance interoperates between separate implementations of WebLogic JMS or between WebLogic JMS and another messaging product.
For WebLogic JMS and third-party JMS products, a messaging bridge communicates with a configured source and target destinations using the resource adapters provided with WebLogic Server.
The properties of the weblogic.management.configuration.MessagingBridgeMBean entity are as follows:
Specifies if this messaging bridge instance allows the degradation of its QOS (quality of service) when the configured QOS is not available.
When enabled, the messaging bridge instance degrades the QOS when the configured QOS is not available. If the QOS is degraded, a log message is delivered to the WebLogic startup window or log file.
When not enabled, if messaging bridge instance cannot satisfy the quality of service requested, an error results and the messaging bridge instance does not start.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies if a messaging bridge instance forwards in asynchronous messaging mode.
AsyncEnabled only applies to messaging bridge instances whose source destination supports asynchronous receiving. Messaging bridges instances that forward in asynchronous mode are driven by the source destination. A messaging bridge instance listens for messages and forwards them as they arrive. When AsyncEnabled is not selected, a bridge instance is forced to work in synchronous mode, even if the source supports asynchronous receiving.
Note: For a messaging bridge instance with a QOS of Exactly-once to work in asynchronous mode, the source destination has to support the MDBTransaction interface. Otherwise, the bridge automatically switches to synchronous mode if it detects that MDBTransaction is not supported by the source destination.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The maximum amount of time, in milliseconds, that a messaging bridge instance waits before sending a batch of messages in one transaction, regardless of whether the Batch Size has been reached or not.
Only applies to a messaging bridge instance forwarding messages in synchronous mode and has a QOS (quality of service) that requires two-phase transactions.
The default value of -1 indicates that the bridge instance waits until the number of messages reaches the Batch Size before it completes a transaction.
Type: long
Constraints: Has Default Value: -1
The number of messages that are processed within one transaction.
Batch Size only applies to a messaging bridge instance forwarding messages in synchronous mode and has a QOS (quality of service) that requires two-phase transactions.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Specifies how the instances of a configured JMS artifact are named and distributed when deployed to a cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Distributed creates an artifact instance on each cluster member in a cluster. Required for all SAF Agents and for cluster targeted or resource group scoped JMS Servers that host distributed destinations.
Singleton creates one artifact instance on a single cluster member of a cluster. Required for cluster targeted or resource group scoped JMS Servers that host standalone (non-distributed) destinations and for cluster targeted or resource group scoped Path Services. The Migration Policy must be On-Failure or Always when using this option with a JMS Server, On-Failure when using this option with a Messaging Bridge, and Always when using this option with a Path Service.
The DistributionPolicy determines the instance name suffix for cluster targeted JMS artifacts. The suffix for a cluster targeted Singleton is -01 and for a cluster targeted Distributed is @ClusterMemberName.
Type: string
Constraints: Restart Required, Has Default Value: Distributed, Legal Values: Distributed, Singleton
Specifies whether or not the messaging bridge allows durable messages.
When enabled and the source destination is a JMS topic, a messaging bridge instance uses a durable subscription to ensure that no messages are lost in the event of a failure. DurabilityEnabled ignored if the source destination is a JMS queue.
When enabled and the source destination uses durable subscriptions, the source JMS implementation saves messages that are sent when a messaging bridge instance is not running. When the bridge instance is restarted, these messages are forwarded to the target destination. The administrator can choose not to be durable.
When not enabled, messages that are sent to the source JMS implementation while the bridge instance is down cannot be forwarded to the target destination.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies the amount of time, in seconds, to delay before failing a cluster targeted JMS artifact instance back to its preferred server after the preferred server failed and was restarted.
This delay allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > specifies the time, in seconds, to delay before failing a JMS artifact back to its user preferred server.
A value of indicates that the instance would never failback.
A value of -1 indicates that there is no delay and the instance would failback immediately.
Note: This setting only applies when the JMS artifact is cluster targeted and the Migration Policy is set to On-Failure or Always>
Type: long
Constraints: Restart Required, Has Default Value: -1
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The maximum amount of time, in seconds, that a messaging bridge instance remains idle.
In asynchronous mode, this is the longest amount of time a messaging bridge instance stays idle before it checks the sanity of its connection to the source.
In synchronous mode, this is the amount of time the messaging bridge can block on a receive call if no transaction is involved.
Type: int
Constraints: Has Default Value: 60, Minimum Value: 0, Maximum Value: 2147483647
Specifies the amount of time, in seconds, to delay before starting a cluster targeted JMS instance on a newly booted WebLogic server. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
This allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > is the time, in seconds, to delay before before loading resources after a failure and restart.
A value of specifies no delay.
Note: This setting only applies when the JMS artifact is cluster targeted and the Migration Policy is set to On-Failure or Always>
Type: long
Constraints: Restart Required, Has Default Value: 60
Controls migration and restart behavior of cluster targeted JMS service artifact instances. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Off disables migration and restart support for cluster targeted JMS service objects, including the ability to restart a failed persistent store instance and its associated services. This policy can not be combined with the Singleton Migration Policy.
On-Failure enables automatic migration and restart of instances on the failure of a subsystem Service or WebLogic Server instance, including automatic fail-back and load balancing of instances.
Always provides the same behavior as On-Failure and automatically migrates instances even in the event of a graceful shutdown or a partial cluster start.
Note: Cluster leasing must be configured for On-Failure and Always
Type: string
Constraints: Restart Required, Has Default Value: Off, Legal Values: Off, On-Failure, Always
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies the number of restart attempts before migrating a failed JMS artifact instance to another server in the WebLogic cluster.
A value > specifies the number of restart attempts before migrating a failed service instance.
A value of specifies the same behavior as setting getRestartInPlace to false
A value of -1 specifies the service is never migrated. Instead, it continues to attempt to restart until it either starts or the server instance shuts down.
Type: int
Constraints: Restart Required, Has Default Value: 6
Specifies the amount of time, in seconds, to delay before a partially started cluster starts all cluster targeted JMS artifact instances that are configured with a Migration Policy of Always or On-Failure.
Before this timeout expires or all servers are running, a cluster starts a subset of such instances based on the total number of servers running and the configured cluster size. Once the timeout expires or all servers have started, the system considers the cluster stable and starts any remaining services.
This delay ensures that services are balanced across a cluster even if the servers are started sequentially. It is ignored once a cluster is fully started (stable) or when individual servers are started.
A value > specifies the time, in seconds, to delay before a partially started cluster starts dynamically configured services.
A value of specifies no delay.
Type: long
Constraints: Restart Required, Has Default Value: 240
Specifies if message properties are preserved when messages are forwarded by a bridge instance.
The following message properties are preserved:
message ID
message timestamp
user ID
delivery mode
priority
expiration time
redelivery limit
unit of order name
If the target bridge destination is on a foreign JMS server, the following message properties are preserved:
delivery mode
priority
expiration time
Type: boolean
Constraints: Has Default Value: false
The QOS (quality of service) for this messaging bridge instance.
Exactly-once: Each message in the source destination is transferred to the target exactly once. This is the highest QOS a messaging bridge instance can offer.
Atmost-once: Each message in the source is transferred to the target only once with the possibility of being lost during the forwarding.
Duplicate-okay: Messages in the source destination are transferred to the target (none are lost) but some may appear in the target more than once.
Type: string
Constraints: Restart Required, Has Secure Value: Exactly-once, Has Default Value: Exactly-once, Legal Values: Exactly-once, Atmost-once, Duplicate-okay
The incremental delay time, in seconds, that a messaging bridge instance increases its waiting time between one failed reconnection attempt and the next retry.
Use with ReconnectDelayMinimum and ReconnectDelayMaximum. After the first failure to connect to a destination, the bridge instance waits for the number of seconds defined by ReconnectDelayMinimum. Each time a reconnect attempt fails, the bridge instance increases its waiting time by the number of seconds defined by ReconnectDelayIncrease. The maximum delay time is defined by ReconnectDelayMaximum. Once the waiting time is increased to the maximum value, the bridge instance stops increase its waiting time. Once the bridge instance successfully connects to the destination, the bridge instance resets its waiting time to the initial value defined by ReconnectDelayMinimum
Type: int
Constraints: Has Default Value: 5, Minimum Value: 0, Maximum Value: 2147483647
The longest amount of time, in seconds, that a messaging bridge instance waits between one failed attempt to connect to the source or target, and the next retry.
Use with ReconnectDelayMinimum and ReconnectDelayIncrease. After the first failure to connect to a destination, a bridge instance waits for the number of seconds defined by ReconnectDelayMinimum. Each time a reconnect attempt fails, the bridge instance increases its waiting time by the number of seconds defined by ReconnectDelayIncrease. The maximum delay time is defined by ReconnectDelayMaximum. Once the waiting time is increased to the maximum value, the bridge instance stops increase its waiting time. Once the bridge instance successfully connects to the destination, the bridge instance resets its waiting time to the initial value defined by ReconnectDelayMinimum
Type: int
Constraints: Has Default Value: 60, Minimum Value: 0, Maximum Value: 2147483647
The minimum amount of time, in seconds, that a messaging bridge instance waits before it tries to reconnect to the source or target destination after a failure.
Use with ReconnectDelayMaximum and ReconnectDelayIncrease. After the first failure to connect to a destination, the bridge instance waits for the number of seconds defined by ReconnectDelayMinimum. Each time a reconnect attempt fails, the bridge instance increases its waiting time by the number of seconds defined by ReconnectDelayIncrease. The maximum delay time is defined by ReconnectDelayMaximum. Once the waiting time is increased to the maximum value, the bridge instance stops increase its waiting time. Once the bridge instance successfully connects to the destination, the bridge instance resets its waiting time to the initial value defined by ReconnectDelayMinimum
>
Type: int
Constraints: Has Default Value: 15, Minimum Value: 0, Maximum Value: 2147483647
Enables periodic automatic restart of failed cluster targeted JMS artifact instance(s) running on healthy WebLogic Server instances. Restart attempts occur before attempts to migrate an instance to a different server in the cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
Restarts occur when Restart In Place is set to true, the JMS artifact is cluster targeted, and the Migration Policy is set to On-Failure or Always>
This attribute is not used by WebLogic Messaging Bridges which automatically restart internal connections as needed.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies the amount of time, in seconds, to wait in between attempts to restart a failed service instance.
Type: int
Constraints: Restart Required, Has Default Value: 30
The filter for messages that are sent across the messaging bridge instance.
Only messages that match the selection criteria are sent across the messaging bridge:
For queues, messages that do not match the selection criteria are left behind and accumulate in the queue.
For topics, messages that do not match the connection criteria are dropped.
Type: string
Constraints: Restart Required
The source destination from which this messaging bridge instance reads messages.
Type: weblogic.management.configuration.BridgeDestinationCommonMBean reference
Constraints: Restart Required
Specifies the initial operating state of a targeted messaging bridge instance.
If enabled, the messaging bridge instance forwards messages (running).
If not enabled, the messaging bridge instance does not forward messages (temporarily stopped).
After a messaging bridge has started forwarding messages (running), use Started to temporarily suspend an active messaging bridge instance or restart an stopped messaging bridge instance.
Select the Started checkbox to start a messaging bridge instance that has been temporarily stopped.
Clear the Started checkbox to temporarily stop a messaging bridge instance that was running.
This value does not indicate the run-time state of a messaging bridge instance.
Type: boolean
Constraints: Has Default Value: true
Return all tags on this Configuration MBean
Type: array of string
The target destination where a messaging bridge instance sends the messages it receives from the source destination.
Type: weblogic.management.configuration.BridgeDestinationCommonMBean reference
Constraints: Restart Required
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.
Type: array of weblogic.management.configuration.TargetMBean references
The amount of time, in seconds, that the transaction manager waits for each transaction before timing it out.
Transaction timeouts are used when the QOS (quality of service) for a messaging bridge instance requires transactions.
If a bridge is configured with Exactly-once QOS, the receiving and sending is completed in one transaction.
Type: int
Constraints: Has Default Value: 30, Minimum Value: 0, Maximum Value: 2147483647
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A target that is suitable for services that shall be active on at most one server of a cluster at a time.
The properties of the weblogic.management.configuration.MigratableTargetMBean entity are as follows:
A migratable service could fail to come up on every possible configured server. This attribute controls how many further attempts, after the service has failed on every server at least once, should be tried. Note that each attempt specified here indicates another full circuit of migrations amongst all the configured servers. So for a 3-server cluster, and a value of 2, a total of 4 additional migrations will be attempted. (the original server is never a valid destination)
Type: int
Constraints: Restart Required, Has Default Value: 2
The list of servers that are candidates to host the migratable services deployed to this migratable target. If the constrainedCandidateServers list is empty, all servers in the cluster are returned. If the constrainedCandidateServers list is not empty, only those servers will be returned. The user-preferred server will be the first element in the list.
Type: array of weblogic.management.configuration.ServerMBean references
Returns the cluster this singleton service is associated with.
Type: weblogic.management.configuration.ClusterMBean reference
Constraints: Restart Required
The (user-restricted) list of servers that can host the migratable services deployed to this migratable target. The migratable service will not be allowed to migrate to a server that is not in the returned list of servers.
For example, this feature may be used to configure two servers that have access to a dual-ported ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.
Type: array of weblogic.management.configuration.ServerMBean references
Constraints: Restart Required
Returns true if the MigratableTarget is critical to the overall health of the WLS Server
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Returns the name of the server that currently hosts the singleton service.
Type: weblogic.management.configuration.ServerMBean reference
Constraints: Read Only
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Defines the type of migration policy to use for the services hosted by this migratable target. Valid options are:
Manual Service Migration Only Indicates that no automatic migration of services hosted by this migratable target will occur.
Auto-Migrate Exactly-Once Services Indicates that if at least one Managed Server in the candidate server list is running, the services hosted by this migratable target will be active somewhere in the cluster if servers should fail or are administratively shut down (either gracefully or forcibly). For example, it is a recommended best practice to use this policy when a migratable target hosts a path service, so if its preferred server fails or is shut down, the path service will automatically migrate to another candidate server, and so will always be active in the cluster.
Notes
This value can lead to target grouping on a server member. For example, if you have five exactly-once migratable targets and only one Managed Server is started in the cluster, then all five targets will be activated on that server.
This policy does not apply for JTA service migration.
Auto-Migrate Failure-Recovery Services Indicates that the services hosted by this migratable target will only start if the migratable target's User Preferred Server (UPS) is started. If an administrator manually shuts down the UPS, either gracefully or forcibly, then a failure-recovery service will not migrate. However, if the UPS fails due to an internal error, then the service will be migrated to another candidate server. If such a candidate server is unavailable (due to either a manual shutdown or an internal failure), then the migration framework will first attempt to reactivate the service on its UPS server. If the UPS server is not available at that time, then the service will be migrated to another candidate server.
Auto-Migrate Shutdown-Recovery Services Indicates that the services hosted by this migratable target will migrate to one of the candidate servers, if server is administratively shut down (either gracefully or forcibly). Once recovery is done, service is migrated back to failed server.
Type: string
Constraints: Restart Required, Has Default Value: manual, Legal Values: manual, exactly-once, failure-recovery, shutdown-recovery
Controls how long of a pause there should be between the migration attempts described in getAdditionalMigrationAttempts(). Note that this delay only happens when the service has failed to come up on every server. It does not cause any sort of delay between attempts to migrate otherwise.
Type: int
Constraints: Restart Required, Has Default Value: 300000
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Specifies whether or not the post-deactivation script is allowed to run on a different machine.
Normally, when auto migration occurs, the post-deactivation script will be run on the service's current location, and the pre-activation script on the service's new location. If the current location is unreachable for some reason, this value will be checked to see if it is safe to run it on the service's new machine.
This is useful if the post-deactivation script controls access to a networked resource and does not need any data from the current machine.
Type: boolean
Constraints: Restart Required, Has Default Value: false
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.
Type: string
Specifies how many restart attempts to make before migrating the failed service.
Note that these are consecutive attempts. If the value is set to 6, and the service restart fails 5 times before succeeding, but then fails again later, it will not instantly migrate. Each failure gets its own count of restart attempts.
A value of 0 is identical to setting getRestartOnFailure to false. A value of -1 indicates the service should never be migrated; instead, it will be restarted until it either works or the server shuts down.
Type: int
Constraints: Restart Required, Has Default Value: 6
Specifies the path to the post-migration script to run after a migratable target is fully deactivated. The script must be in the MIDDLEWARE_HOME/user_projects/domains/mydomain/bin/service_migration directory.
After the migratable target is deactivated, if there is a script specified, and Node Manager is available, then the script will run. Specifying a script without an available Node Manager will result in an error upon migration.
Type: string
Constraints: Restart Required
Specifies whether or not a failure during execution of the post-deactivation script is fatal to the migration.
If it is fatal, the migratable target will not be automatically migrated until an administrator manually migrates it to a server, thus reactivating it.
Note: Enabling this value will result in weakening the exactly-once guarantee. It is provided to prevent more dangerous data corruption if the post-deactivation script fails. Also if this value is enabled, then the script may be called more than once by the migration framework after the Migratable Target is deactivated or the server or machine hosting the Migratable Target crashed or is network partitioned. The script is expected not to return different exit values when invoked multiple times in such scenarios.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies the path to the pre-migration script to run before a migratable target is actually activated. The script must be in the MIDDLEWARE_HOME/user_projects/domains/mydomain/bin/service_migration directory.
Before the migratable target is activated, if there is a script specified, and Node Manager is available, then the script will run. Specifying a script without an available Node Manager will result in an error upon migration.
If the script fails or cannot be found, migration will not proceed on the current server, and will be tried on the next suitable server. This could be the next server in the candidate server list, or in the cluster, if there is no candidate server list.
Type: string
Constraints: Restart Required
Specifies whether or not a failed service will first be deactivated and reactivated in place, instead of being migrated.
The number of restart attempts is controlled by getNumberOfRestartAttempts. Once these restart attempts are exhausted, the service will migrate. A restarting migratable target will deactivate all services on it in order, then reactivate them all.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies how many seconds to wait in between attempts to restart the failed service.
Type: int
Constraints: Restart Required, Has Default Value: 30
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Returns the server that the user prefers the singleton service to be active on.
Type: weblogic.management.configuration.ServerMBean reference
This MBean defines the minimum number of concurrent threads that should allocated to this constraint provided there are enough pending requests.
Multiple WorkManagers can share a common MinThreadsConstraint. MinThreadsConstraint perform their own bookkeeping and demand a thread when the constraint is not met and there are enough requests.
MinThreadsConstraint should be used to tell the WebLogic Server that a certain number of minimum threads are necessary to prevent server to server deadlocks. Although the server is self-tuning, specifying MinThreadsConstraint ensures that the server guarantees minimum threads to avoid the distributed deadlocks.
The properties of the weblogic.management.configuration.MinThreadsConstraintMBean entity are as follows:
Minimum number of concurrent threads executing requests that share this constraint.
A count of 0 or -1 is treated as if the constraint is not present. This means that the constraint is ignored for these two values. A count > 0 can be dynamically changed to 0 to indicate that constraint enforcement is no longer needed.
Type: int
Constraints: Has Default Value: -1
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A server can specify additional network connections by using a NetworkAccessPointMBean. The NetworkAccessPointMBean is also used to set the listen address and external DNS name that a server uses for a particular channel.
The properties of the weblogic.management.configuration.NetworkAccessPointMBean entity are as follows:
Enables Socket Direct Protocol (SDP) on this channel. Enable this attribute when configuring session replication enhancements for Managed Servers in a WebLogic cluster for Oracle Exalogic.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Indicate whether SSLv2Hello is enabled in a network channel.
Type: boolean
The number of backlogged, new TCP connection requests that this network channel allows. A value of -1 indicates that the network channel obtains its backlog configuration from the server's configuration.
Type: int
Constraints: Minimum Value: 0
Test if the AllowUnEncryptedNullCipher is enabled
see setAllowUnencryptedNullCipher(boolean enable) for the NullCipher feature.
Type: boolean
Whether or not the channel's custom identity should be used. This setting only has an effect if the server is using a customized keystore. By default the channel's identity is inherited from the server's identity.
Type: boolean
Constraints: Has Default Value: false
A weight to give this channel when creating server-to-server connections.
Type: int
Constraints: Has Default Value: 50, Minimum Value: 1, Maximum Value: 100
Indicates the cipher suites being used on a particular WebLogic Server channel.
The strongest negotiated cipher suite is chosen during the SSL handshake. The set of cipher suites used by default by JSEE depends on the specific JDK version with which WebLogic Server is configured.
For a list of possible values, see Cipher Suites
Type: array of string
Specifies whether clients must present digital certificates from a trusted certificate authority to WebLogic Server on this channel.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: false
The address this network channel uses to generate EJB handles and failover addresses for use in a cluster. This value is determined according to the following order of precedence:
If the cluster address is specified via the NAPMBean, then that value is used
If this value is not specified, the value of PublicAddress is used.
If PublicAddress is not set, this value is derive from the ClusterAddress attribute of the ClusterMbean.
If ClusterMbean.clusterAddress is not set, this value is derive from the listen address of the NAPMbean.
Type: string
The maximum amount of time this network channel waits for a complete message to be received. A value of disables network channel complete message timeout. A value of -1 indicates that the network channel obtains this timeout value from the ServerTemplateMBean.
This timeout helps guard against denial of service attacks in which a caller indicates that they will be sending a message of a certain size which they never finish sending.
Type: int
Constraints: Minimum Value: 0, Maximum Value: 480
The amount of time that this network channel should wait to establish an outbound socket connection before timing out. A value of disables network channel connect timeout.
Type: int
Constraints: Minimum Value: 0, Maximum Value: 240
The source of the identity keystore. For a JKS keystore, the source is the path and file name. For an Oracle Key Store Service (KSS) keystore, the source is the KSS URI.
If using a JKS keystore, the keystore path name must either be absolute or relative to where the server was booted.
If using a KSS keystore, the keystore URI must be of the form:
kss://system/keystorename
where keystorename is the name of the keystore registered in KSS.
The value in this attribute is only used if ServerMBean.KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
Type: string
The encrypted custom identity keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if ServerMBean.KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the CustomIdentityKeyStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the CustomIdentityKeyStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (CustomIdentityKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use CustomIdentityKeyStorePassPhraseEncrypted
Type: string
Constraints: Encrypted
The type of the keystore. Generally, this is JKS. If using the Oracle Key Store Service, this would be KSS
If empty or null, then the JDK's default keystore type (specified in java.security) is used. The custom identity key store type is only used if ServerMBean.KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
Type: string
The string alias used to store and retrieve the channel's private key in the keystore. This private key is associated with the server's digital certificate. A value of null indicates that the network channel uses the alias specified in the server's SSL configuration.
Type: string
The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated. A value of null indicates that the network channel uses the pass phrase specified in the server's SSL configuration.
Type: string
Constraints: Encrypted, Has Default Value: null
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies whether this channel should be started.
Type: boolean
Constraints: Has Default Value: true
Specifies whether to ignore the installed implementation of the weblogic.security.SSL.HostnameVerifier interface (when this server is acting as a client to another application server).
Type: boolean
The name of the class that implements the weblogic.security.SSL.HostnameVerifier interface.
This class verifies whether the connection to the host with the hostname from URL should be allowed. The class is used to prevent man-in-the-middle attacks. The weblogic.security.SSL.HostnameVerifier has a verify() method that WebLogic Server calls on the client during the SSL handshake.
Type: string
Specifies whether HTTP traffic should be allowed over this network channel.
HTTP is generally required by binary protocols for downloading stubs and other resources.
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The maximum amount of time (in seconds) that a connection is allowed to be idle before it is closed by this network channel. A value of -1 indicates that the network channel obtains this timeout value from the ServerTemplateMBean.
This timeout helps guard against server deadlock through too many open connections.
Type: int
Constraints: Minimum Value: 0
Indicates the client certificate validation rules for inbound SSL.
This attribute only applies to ports and network channels using 2-way SSL.
Type: string
Constraints: Legal Values: BuiltinSSLValidationOnly, BuiltinSSLValidationAndCertPathValidators
The IP address or DNS name this network channel uses to listen for incoming connections. A value of null indicates that the network channel should obtain this value from the server's configuration.
Type: string
Constraints: Restart Required
The default TCP port this network channel uses to listen for regular (non-SSL) incoming connections. A value of -1 indicates that the network channel should obtain this value from the server's configuration.
Type: int
Constraints: Restart Required
The amount of time that this network channel should wait for a connection before timing out. A value of disables network channel login timeout. A value of -1 indicates that the network channel obtains this timeout value from the server's configuration.
Type: int
Constraints: Minimum Value: 0, Maximum Value: 100000
The maximum back off time between failures while accepting client connections. -1 implies that this value is inherited from the server.
Type: int
Constraints: Minimum Value: 0
The maximum number of clients that can be connected on this network channel.
Type: int
Constraints: Has Default Value: 2147483647
The maximum message size allowable in a message header.
This maximum attempts to prevent a denial of service attack whereby a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests.
A client can set this value using the -Dweblogic.MaxMessageSize property.
Type: int
Constraints: Minimum Value: 4096, Maximum Value: 100000000
Get the minimum SSL/TLS protocol version to be used in a network channel.
Type: string
The name of this network channel.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: <unknown>
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.
Type: string
Indicates the server certificate validation rules for outbound SSL.
This attribute always applies to outbound SSL that is part of WebLogic Server (that is, an Administration Server talking to the Node Manager). It does not apply to application code in the server that is using outbound SSL unless the application code uses a weblogic.security.SSL.ServerTrustManager that is configured to use outbound SSL validation.
Type: string
Constraints: Legal Values: BuiltinSSLValidationOnly, BuiltinSSLValidationAndCertPathValidators
Specifies whether new server-to-server connections may consider this network channel when initiating a connection. This is only relevant if the connection needs to be bound to the network channel's listen address. This will only work for binary protocols that support both outbound and inbound traffic.
When this feature is not enabled, connections are initiated using a local address selected by the underlying hardware.
The default is false.
Outbound channels are selected at runtime either by virtue of the fact of being the only outbound-enabled channel for the required protocol, or by name in weblogic.jndi.Environment#setProviderChannel
The HTTP protocol is implicitly enabled for all the outbound channels, but you need to use the WLS client library (HTTP client) and set the channel on the connection.
Type: boolean
The string alias used to store and retrieve the outbound private key in the keystore. This private key is associated with either a server or a client digital certificate. This attribute value is derived from other settings and cannot be physically set.
The returned value is determined as follows:
If isOutboundPrivateKeyEnabled and isChannelIdentityCustomized return true, the value from getCustomPrivateKeyAlias is returned.
Otherwise, the value from SSLMBean#getOutboundPrivateKeyAlias is returned from the ServerMBean for the channel.
Type: string
Constraints: Read Only, Has Default Value: null
Specifies whether the identity specified by getCustomPrivateKeyAlias should be used for outbound SSL connections on this channel. In normal circumstances the outbound identity is determined by the caller's environment.
Type: boolean
Constraints: Has Secure Value: false
The passphrase used to retrieve the outbound private key from the keystore. This passphrase is assigned to the private key when it is generated. This attribute value is derived from other settings and cannot be physically set.
The returned value is determined as follows:
If isOutboundPrivateKeyEnabled and isChannelIdentityCustomized return true, the value from getCustomPrivateKeyPassPhrase is returned.
Otherwise, the value from SSLMBean#getOutboundPrivateKeyPassPhrase is returned from the ServerMBean for the channel.
Type: string
Constraints: Read Only, Has Default Value: null
The string alias used to store and retrieve the channel's private key in the keystore. This private key is associated with the server's digital certificate. This value is derived from other settings on the channel and cannot be physically set.
Type: string
Constraints: Read Only
The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated. This value is derived from other settings on the channel and cannot be physically set.
Type: string
Constraints: Read Only
The protocol this network channel should use for connections.
Type: string
Constraints: Restart Required, Has Secure Value: t3s, Has Default Value: t3
The IP address or DNS name of the HTTP proxy to use for outbound connections on this channel. The HTTP proxy must support the CONNECT tunneling command.
This option is only effective when OutboundEnabled is set on the channel.
Type: string
Constraints: Has Default Value: null
The port of the HTTP proxy to use for outbound connections on this channel. The HTTP proxy must support the CONNECT tunneling command.
This option is only effective when OutboundEnabled and ProxyHost are set on the channel.
Type: int
Constraints: Has Default Value: 80
The IP address or DNS name representing the external identity of this network channel. A value of null indicates that the network channel's Listen Address is also its external address. If the Listen Address is null,the network channel obtains its external identity from the server's configuration.
This is required for the configurations which need to cross a firewall doing Network Address Translation.
Type: string
The externally published listen port for this network channel. A value of -1 indicates that the network channel's Listen Port is also its public listen port. If the Listen Port is -1,the network channel obtains its public listen port from the server's configuration.
Type: int
Resolve the listen address to use for all T3 communication
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
Determines if connections with pending responses are allowed to timeout. It defaults to false. If set to true, the connection will be timed out for this channel if it exceeds the idleConnectionTimeout value.
Note: This setting only applies to IIOP connections.
Type: boolean
Constraints: Has Default Value: false
The interval (in seconds) at which this network channel should ping an HTTP-tunneled client to see if its still alive. A value of -1 indicates that the network channel obtains this interval from the ServerTemplateMBean. (Requires you to enable tunneling for the network channel.)
Type: int
Constraints: Minimum Value: 1
The amount of time (in seconds) after which this network channel considers a missing HTTP-tunneled client to be dead. A value of -1 indicates that the network channel obtains this timeout value from the ServerTemplateMBean. (Requires you to enable tunneling for the network channel.)
Type: int
Constraints: Minimum Value: 1
Specifies whether tunneling via HTTP should be enabled for this network channel. This value is not inherited from the server's configuration.
Type: boolean
Constraints: Has Default Value: false
Specifies whether this network channel uses two way SSL.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: false
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies whether to use non-standard object serialization for performance. This option works in different ways for different protocols. In particular under IIOP this option uses Java serialization rather than RMI-IIOP serialization. In general using non-standard serialization is not suitable for interop scenarios and may imply some feature loss.
Type: boolean
This bean is represents a Node Manager that is associated with a machine.
The properties of the weblogic.management.configuration.NodeManagerMBean entity are as follows:
Returns the node manager type for the server or clients on the server to use when connecting to the NodeManager instance.
Type: string
Constraints: Restart Required, Has Default Value: SSL, Legal Values: SSH, RSH, Plain, SSL, ssh, rsh, ssl, plain
Gets the node manager client adapter name_version when using a VMM adapter to connect to OVM or other VMM adapter providers
Type: string
Constraints: Restart Required
Gets the node manager client adapter name when using a VMM adapter to connect to OVM or other VMM adapters providers
Type: string
Constraints: Restart Required
Gets the node manager client adapter version when using a VMM adapter to connect to OVM or other VMM adapters providers
Type: string
Constraints: Restart Required
Specifies whether communication with this Node Manager needs to be debugged. When enabled, connections to the NodeManager from the server or clients on the server will result in more information sent to the server log.
Type: boolean
Constraints: Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The host name or IP address of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.
Type: string
Constraints: Has Secure Value: 127.0.0.1 or ::1, Has Default Value: localhost
The port number of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.
Type: int
Constraints: Has Default Value: 5556, Minimum Value: 1, Maximum Value: 65534
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
Returns the node manager home directory that will be used to substitute for the shell command template
Type: string
Constraints: Restart Required
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.
Type: string
The password used by a Node Manager client to connect to the underlying service to which the Node Manager client delegates operations.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the PasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the PasswordEncrypted attribute to the encrypted value.
Caution: Using the (Password) attribute is a potential security risk because the String object (which contains the unencrypted password), remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory. Therefore, you should use the PasswordEncrypted() attribute instead.
Type: string
Constraints: Encrypted
Returns the local command line to use when invoking SSH or RSH node manager functions.
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The Node Manager client user name used to connect to the underlying service to which the client delegates operations.
Type: string
Control panel for all optional features, e.g. WSAT, ASYNC_RESPONSE etc. The mbean is designed to be managed by domain and to extend for partition if needed in future.
The properties of the weblogic.management.configuration.OptionalFeatureDeploymentMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Controls the configuration of an optional feature.
The properties of the weblogic.management.configuration.OptionalFeatureMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Identifies whether the WebLogic Server automatically deploys the internal app in the current domain/partition.
Type: boolean
Constraints: Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
An MBean representing an OSGi framework.
The properties of the weblogic.management.configuration.OsgiFrameworkMBean entity are as follows:
Determines if some WebLogic helper bundles will be installed into the framework
If this is set to "populate" then the bundles found in the WebLogic installation directory under wlserver/server/osgi-lib will be installed into this OSGi framework. Futhermore a few extra packages will be added to the bootdelegation classpath parameters in order to enable the bundles in the osgi-lib directory if they are not already there.
If this is set to "ignore" then the bundles found in the WebLogic installation directory will not be installed into the framework.
Type: string
Constraints: Restart Required, Has Default Value: populate, Legal Values: populate, ignore
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The name of the frameworks implementation class for the org.osgi.framework.launch.FrameworkFactory class.
Type: string
Constraints: Restart Required, Has Default Value: org.apache.felix.framework.FrameworkFactory
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The properties to be used when initializing the framework. All standard properties and all properties specific to the framework can be set.
Type: java.util.Properties
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The name of the org.osgi.framework.bootdelegation property. Note that this value, if set, will take precedence over anything specified in the init-properties.
Type: string
Constraints: Restart Required, Has Default Value: null
The name of the org.osgi.framework.system.packages.extra property. Note that this value, if set, will take precedence over anything specified in the init-properties.
Type: string
Constraints: Restart Required, Has Default Value: null
The location of the OSGi implementation JAR file which contains the org.osgi.framework.launch.FrameworkFactory implementation. If this field is not set then an appropriate default implementation that is shipped with the product will be used.
If this field is relative it must be relative to the start directory of the server and the file must exist everywhere this framework is deployed. If this field is not relative then the given filename must exist at the same location everywhere this framework is deployed.
Type: string
Constraints: Restart Required, Has Default Value: null
Returns true if global data sources should be added to the OSGi service registry.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Returns true if global work managers should be added to the OSGi service registry.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This Mbean has attributes concerning server overload protection.
The properties of the weblogic.management.configuration.OverloadProtectionMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Enable automatic forceshutdown of the server on failed state. The server self-health monitoring detects fatal failures and mark the server as failed. The server can be restarted using NodeManager or a HA agent.
Type: string
Constraints: Has Default Value: no-action, Legal Values: no-action, force-shutdown, admin-state
Percentage free memory after which the server overload condition is cleared. WorkManagers stop performing overloadActions and start regular execution once the overload condition is cleared.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0, Maximum Value: 99
Percentage free memory below which the server is considered overloaded. WorkManagers perform overloadAction once the server is marked as overloaded.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0, Maximum Value: 99
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Exit the server process when the kernel encounters a panic condition like an unhandled OOME. An unhandled OOME could lead to inconsistent state and a server restart is advisable if backed by node manager or a HA agent.
Type: string
Constraints: Restart Required, Has Default Value: system-exit, Legal Values: no-action, system-exit
Total number of requests that can be present in the server. This includes requests that are enqueued and those under execution.
The server performs a differentiated denial of service on reaching the shared capacity. A request with higher priority will be accepted in place of a lower priority request already in the queue. The lower priority request is kept waiting in the queue till all high priority requests are executed. Further enqueues of the low priority requests are rejected right away.
Type: int
Constraints: Restart Required, Has Default Value: 65536, Minimum Value: 1, Maximum Value: 1073741824
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies the parameters used to configure the DeploymentValidationPluginMBean.
The properties of the weblogic.management.configuration.ParameterMBean entity are as follows:
Gets the parameter description.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Gets the parameter name.
Type: string
Constraints: Read Only, Restart Required
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Gets the parameter value.
Type: string
Defines the partition file system configuration.
The properties of the weblogic.management.configuration.PartitionFileSystemMBean entity are as follows:
Specifies whether the file system should be created on-demand when the partition is first started.
Type: boolean
Constraints: Has Default Value: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies whether the file system should be preserved when the partition is deleted.
Type: boolean
Constraints: Has Default Value: true
The full path to the root of this file subsystem of the partition.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Partition scoped logging configuration.
The properties of the weblogic.management.configuration.PartitionLogMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
List of attributes from the WebLogic ServerDebugMBean that are enabled for the given partition. Note: Server level debug for a partition should be carefully enabled in consultation with a WebLogic system administrator only for a short period to capture additional debug output when troubleshooting a server problem.
Type: array of string
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Logger names and level map.
Type: java.util.Properties
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A domain partition. A configuration may define zero or more partitions.
The properties of the weblogic.management.configuration.PartitionMBean entity are as follows:
The maximum number of elements retained for monitoring RCM usage requests over time.
Type: int
Constraints: Has Default Value: 250, Minimum Value: 1, Maximum Value: 5000
All the available targets for this partition.
Type: array of weblogic.management.configuration.TargetMBean references
The JNDI name of the Batch runtime's JobRepository data source, which will be used to store data for Batch jobs submitted from applications deployed to the partition. When a Java EE component submits a Batch job, the Batch runtime updates the JobRepository tables using this data source, which is obtained by looking up the data source's JNDI name.
Type: string
The name of the application-scoped Managed Executor Service instance that will be used to run Batch jobs that are submitted from applications deployed to the partition. A Managed Executor Service Template by the same name must exist for the domain when a Batch job is submitted in the partition. If this name returns null, then the Batch runtime will use the default Java EE Managed Executor Service that is bound to the default JNDI name of: java:comp/DefaultManagedExecutorService.
Type: string
The data source required to support the persistence of jobs scheduled with the job scheduler.
Type: weblogic.management.configuration.JDBCSystemResourceMBean reference
A list of default targets for the partition (if any).
Type: array of weblogic.management.configuration.TargetMBean references
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Determines if tracking of resource consumption metrics of this Partition is initiated eagerly from the time the Partition is started, or if it is initiated lazily on first access of PartitionResourceMetricsRuntimeMBean.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The number of seconds a graceful shutdown operation waits before forcing a shut down. A graceful shutdown gives WebLogic Server subsystems time to complete certain application processing currently in progress. If subsystems are unable to complete processing within the number of seconds that you specify here, the partition will force shutdown automatically.
A value of means that the partition will wait indefinitely for a graceful shutdown to complete.
The graceful shutdown timeout applies only to graceful shutdown operations.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Indicates whether a graceful shutdown operation drops all HTTP sessions immediately.
If this is set to false, a graceful shutdown operation waits for HTTP sessions to complete or timeout.
Type: boolean
Constraints: Has Default Value: false
The table name to use for storing timers active with the Job Scheduler.
Type: string
Constraints: Has Default Value: WEBLOGIC_TIMERS
The maximum number of running long-running requests that can be submitted to all the Managed Executor Services or Managed Scheduled Executor Services in the partition on the current server.
Type: int
Constraints: Has Default Value: 50, Minimum Value: 0, Maximum Value: 65534
The maximum number of running threads that can be created by all the Managed Thread Factories in the partition on the current server.
Type: int
Constraints: Has Default Value: 50, Minimum Value: 0, Maximum Value: 65534
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Determines if the modules of applications will be deployed in parallel. This setting can be overridden at the per-application level. See AppDeploymentMBean#isParallelDeployModules()
Type: boolean
Constraints: Has Default Value: false
Determines if applications will be deployed in parallel.
Type: boolean
Constraints: Has Default Value: true
The ID for this partition.
Type: string
Constraints: Read Only, Restart Required
The number of seconds a force shutdown operation waits before timing out. If the operation does not complete within the configured timeout period, the partition will shutdown automatically if the state of the server at that time was SHUTTING_DOWN
A value of means that the partition will wait indefinitely for the life cycle operation to complete.
Type: int
Constraints: Has Secure Value: 120, Has Default Value: 30, Has Production Mode Default Value: 120, Minimum Value: 0
A reference to a partition-level work manager policy set by the system administrator.
Type: weblogic.management.configuration.PartitionWorkManagerMBean reference
The partition's primary identity domain.
Type: string
The security realm for this partition.
Type: weblogic.management.security.RealmMBean reference
The resource deployment plan path.
Type: string
A resource manager reference from the resource management.
Type: weblogic.management.configuration.ResourceManagerMBean reference
The timeout value for a partition's start and resume operations. If the partition fails to start within the timeout period, it will force a shutdown.
A value of means that the server will wait indefinitely for the operation to complete.
Type: int
Constraints: Restart Required, Has Default Value: 0, Has Production Mode Default Value: 0, Minimum Value: 0
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The directory path on the Administration Server where the uploaded applications for this partition are placed.
Type: string
The PartitionPropertyMBean is used when performing macro substitution from elements in the ResourceGroupTemplateMBean. If a macro is encountered in the ResourceGroupTemplate attribute, then the macro name will be used to locate the corresponding PartitionPropertyMBean and the value will be substituted accordingly. Note that ConfigurationMBean contains getName/setName
The properties of the weblogic.management.configuration.PartitionPropertyMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Get the value for the given macro
Type: string
Constraints: Restart Required
Defines the partition file system configuration.
The properties of the weblogic.management.configuration.PartitionUserFileSystemMBean entity are as follows:
Specifies whether the file system should be created on-demand when the partition is first started.
Type: boolean
Constraints: Has Default Value: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies whether the file system should be preserved when the partition is deleted.
Type: boolean
Constraints: Has Default Value: true
The full path to the root of this file subsystem of the partition.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies partition-level work manager policies that are configured by domain system administrators.
The properties of the weblogic.management.configuration.PartitionWorkManagerMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
A desired percentage of thread usage by a partition compared to the thread usage by all partitions. It is recommended that the sum of this value for all the partitions running in a WLS domain add up to 100, but it is not strictly enforced. When they do not add up to 100, WLS assigns thread-usage times to different partitions based on their relative values.
Type: int
Constraints: Has Default Value: 50, Minimum Value: 1, Maximum Value: 99
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The maximum number of concurrent requests that the self-tuning thread pool can be processing on behalf of a partition at any given time. The default value of -1 means that this is only limited by the size of the self-tuning thread pool.
Type: int
Constraints: Has Default Value: -1
Desired size of the Partition MaxThreadsConstraint queue for requests pending execution.
Type: int
Constraints: Restart Required, Has Default Value: 8192, Minimum Value: 256, Maximum Value: 1073741824
This imposes an upper limit on the number of standby threads that can be created for satisfying the minimum threads constraints configured in a partition. If the sum of the configured values of all minimum threads constraints in a partition exceeds this configured value, a warning message will be logged and WLS will limit the number of threads the self-tuning thread pool will allocate to the partition to satisfy its minimum threads constraints. A value of 0 means no limit is imposed on the partition.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 65534
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The total number of requests that can be present in the server for a partition, as a percentage of the sharedCapacityForWorkManagers attribute value in OverloadProtection MBean. This includes requests that are enqueued and those under execution.
Type: int
Constraints: Has Default Value: 100, Minimum Value: 1, Maximum Value: 100
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Defines an instance of a Replicated Store.
A WebLogic Replicated Store is a high performance storage option for Exalogic hosted Weblogic Messaging Services and is an alternative to WebLogic Server's File and JDBC persistent storage options. Replicated stores depend on Exalogic replicated memory that is managed by a separately administered Daemon Cluster that must be started before a WebLogic Replicated Store can boot.
See Using the WebLogic Replicated Store in Administering WebLogic Server for Oracle Exalogic Elastic Cloud.
This feature should be used only in Oracle Exalogic Elastic Cloud environments.
The properties of the weblogic.management.configuration.ReplicatedStoreMBean entity are as follows:
Overrides the name of the XAResource that this store registers with JTA.
You should not normally set this attribute. Its purpose is to allow the name of the XAResource to be overridden when a store has been upgraded from an older release and the store contained prepared transactions. The generated name should be used in all other cases.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: null, Legal Null: true
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Specifies the path of the Replicated Store Global Directory.
This must be the same directory that is used to store the Daemon Cluster rs_daemons.cfg configuration file and requires a specially tuned NFS mount. Oracle recommends using an absolute directory path on a shared NFS mount.
Type: string
Constraints: Restart Required, Legal Null: true
Specifies how the instances of a configured JMS artifact are named and distributed when deployed to a cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Distributed creates an artifact instance on each cluster member in a cluster. Required for all SAF Agents and for cluster targeted or resource group scoped JMS Servers that host distributed destinations.
Singleton creates one artifact instance on a single cluster member of a cluster. Required for cluster targeted or resource group scoped JMS Servers that host standalone (non-distributed) destinations and for cluster targeted or resource group scoped Path Services. The Migration Policy must be On-Failure or Always when using this option with a JMS Server, On-Failure when using this option with a Messaging Bridge, and Always when using this option with a Path Service.
The DistributionPolicy determines the instance name suffix for cluster targeted JMS artifacts. The suffix for a cluster targeted Singleton is -01 and for a cluster targeted Distributed is @ClusterMemberName.
Type: string
Constraints: Restart Required, Has Default Value: Distributed, Legal Values: Distributed, Singleton
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies the amount of time, in seconds, to delay before failing a cluster targeted JMS artifact instance back to its preferred server after the preferred server failed and was restarted.
This delay allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > specifies the time, in seconds, to delay before failing a JMS artifact back to its user preferred server.
A value of indicates that the instance would never failback.
A value of -1 indicates that there is no delay and the instance would failback immediately.
Note: This setting only applies when the JMS artifact is cluster targeted and the Migration Policy is set to On-Failure or Always>
Type: long
Constraints: Restart Required, Has Default Value: -1
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies the amount of time, in seconds, to delay before starting a cluster targeted JMS instance on a newly booted WebLogic server. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
This allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > is the time, in seconds, to delay before before loading resources after a failure and restart.
A value of specifies no delay.
Note: This setting only applies when the JMS artifact is cluster targeted and the Migration Policy is set to On-Failure or Always>
Type: long
Constraints: Restart Required, Has Default Value: 60
The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.
Controls the amount of WebLogic Server JVM off-heap (native) memory that is allocated for a replicated store.
For the best runtime performance, Oracle recommends setting IOBufferSize so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).
For the best boot recovery time performance of large stores, Oracle recommends setting IOBufferSize to at least 2 megabytes.
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 67108864
Specifies a local Daemon to attach to when a Daemon Cluster has multiple Daemons configured to run on the current node.
The local Daemon is chosen using the formula: ((localindex) modulo (number-of-local-daemons)). When 0, it always resolves to the first available Daemon entry in the rs_daemons.cfg file that has an address on the current node. The default value is 0.
This setting is not applicable to production environments. To ensure high availability, a Daemon Cluster in a production environment should have multiple nodes with one Daemon on each node.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: -1, Maximum Value: 65535
The name used by subsystems to refer to different stores on different servers using the same name.
For example, an EJB that uses the timer service may refer to its store using the logical name, and this name may be valid on multiple servers in the same cluster, even if each server has a store with a different physical name.
Multiple stores in the same domain or the same cluster may share the same logical name. However, a given logical name may not be assigned to more than one store on the same server.
Type: string
Constraints: Has Default Value: null, Legal Null: true
Controls migration and restart behavior of cluster targeted JMS service artifact instances. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Off disables migration and restart support for cluster targeted JMS service objects, including the ability to restart a failed persistent store instance and its associated services. This policy can not be combined with the Singleton Migration Policy.
On-Failure enables automatic migration and restart of instances on the failure of a subsystem Service or WebLogic Server instance, including automatic fail-back and load balancing of instances.
Always provides the same behavior as On-Failure and automatically migrates instances even in the event of a graceful shutdown or a partial cluster start.
Note: Cluster leasing must be configured for On-Failure and Always
Type: string
Constraints: Restart Required, Has Default Value: Off, Legal Values: Off, On-Failure, Always
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies the number of restart attempts before migrating a failed JMS artifact instance to another server in the WebLogic cluster.
A value > specifies the number of restart attempts before migrating a failed service instance.
A value of specifies the same behavior as setting getRestartInPlace to false
A value of -1 specifies the service is never migrated. Instead, it continues to attempt to restart until it either starts or the server instance shuts down.
Type: int
Constraints: Restart Required, Has Default Value: 6
Specifies the amount of time, in seconds, to delay before a partially started cluster starts all cluster targeted JMS artifact instances that are configured with a Migration Policy of Always or On-Failure.
Before this timeout expires or all servers are running, a cluster starts a subset of such instances based on the total number of servers running and the configured cluster size. Once the timeout expires or all servers have started, the system considers the cluster stable and starts any remaining services.
This delay ensures that services are balanced across a cluster even if the servers are started sequentially. It is ignored once a cluster is fully started (stable) or when individual servers are started.
A value > specifies the time, in seconds, to delay before a partially started cluster starts dynamically configured services.
A value of specifies no delay.
Type: long
Constraints: Restart Required, Has Default Value: 240
The region size, in bytes.
Data is stored in one or more uniquely named Regions within a Daemon Cluster where each region is created with this size. Oracle recommends that regions sizes should be tuned to be a small fraction of the available local Daemon memory.
Type: int
Constraints: Restart Required, Has Default Value: 134217728, Minimum Value: 33554432, Maximum Value: 1073741824
Enables periodic automatic restart of failed cluster targeted JMS artifact instance(s) running on healthy WebLogic Server instances. Restart attempts occur before attempts to migrate an instance to a different server in the cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
Restarts occur when Restart In Place is set to true, the JMS artifact is cluster targeted, and the Migration Policy is set to On-Failure or Always>
This attribute is not used by WebLogic Messaging Bridges which automatically restart internal connections as needed.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies the amount of time, in seconds, to wait in between attempts to restart a failed service instance.
Type: int
Constraints: Restart Required, Has Default Value: 30
Return all tags on this Configuration MBean
Type: array of string
The server instances, clusters, or migratable targets defined in the current domain that are candidates for hosting a file store, JDBC store, or replicated store. If scoped to a Resource Group or Resource Group Template, the target is inherited from the Virtual Target.
When selecting a cluster, the store must be targeted to the same cluster as the JMS server. When selecting a migratable target, the store must be targeted it to the same migratable target as the migratable JMS server or SAF agent. As a best practice, a path service should use its own custom store and share the same target as the store.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A resource group is a named collection of deployable resources. Typically the resources in a given resource group are related in some way, for example in that they make up a single application suite.
The properties of the weblogic.management.configuration.ResourceGroupMBean entity are as follows:
Does this resource group contain administrative applications and resources? If true, then this is considered an administrative resource group and will be handled differently by the partition lifecycle. Specifically, an administrative resource group will be left running when a partition is shut down (it will be shut down only when the partition is halted).
Note that this Boolean is independent of the targeting of the resource group and works independently of the autoTargetAdminServer Boolean.
Type: boolean
Constraints: Has Default Value: false
Should this resource group always be targeted to the Administration Server? If true, then this resource group will be targeted to the domain's Administration Server using the partition's administrative virtual target (AdminVT) in addition to any targets explicitly set on the resource group. Functionally, this is similar to getting the partition's administrative virtual target and explicitly adding it to the list of resource group targets.
Type: boolean
Constraints: Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The resource group template referenced by this resource group.
Type: weblogic.management.configuration.ResourceGroupTemplateMBean reference
Return all tags on this Configuration MBean
Type: array of string
A list of all the targets.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The directory path on the Administration Server where the uploaded applications for this resource group template are placed.
Type: string
Checks whether this resource group uses the default target from the partition that contains the resource group.
Type: boolean
Constraints: Has Default Value: true
A resource group template is a named, domain-level collection of deployable resources intended to be used as a pattern by (usually) multiple resource groups. Each resource group that refers to a given template will have its own runtime copies of the resources defined in the template.
The properties of the weblogic.management.configuration.ResourceGroupTemplateMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The directory path on the Administration Server where the uploaded applications for this resource group template are placed.
Type: string
This MBean is used to create and edit resource management policy configurations (Resource Managers) for the domain. Partition-scoped resource managers can be created under {@code PartitionMBean}.
The properties of the weblogic.management.configuration.ResourceManagementMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A {@code ResourceManagerMBean} represents a resource consumption management policy. A policy controls and governs the use of shared resources in a Server runtime, by a Partition that the policy is attached to. A resource manager holds information on constraints and recourse actions for different resources in a Server instance.
A system administrator defines a resource manager and configures child MBeans that represent particular combinations of shares and usage limits of various resources in the Server runtime.
The system administrator may then assign the resource manager to one or more Partitions to ensure fair allocation of shared resources to collocated Domain Partitions, and to ensure that one Partition doesn't exhaust shared resources (potentially affecting other collocated Partitions).
The set of resources on which resource management policies can be assigned to, and the child MBeans through which they can be configured are:
File Open: FileOpenMBean
Heap Retained: HeapRetainedMBean
CPU Utilization: CpuUtilizationMBean
The properties of the weblogic.management.configuration.ResourceManagerMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean defines the response time goal for this request class.
Response time goals can be used to differentiate request classes. We do not try to meet a response time goal for an individual request. Rather we compute a tolerable waiting time for a request class by subtracting the observed average thread use time. Then we schedule requests so that the average wait for each request class is in proportion to their tolerable waiting time. For example, consider we only have two request classes, A and B, with response time goals 2000ms and 5000ms, respectively, where the time an individual request uses a thread is much smaller. During a period in which both request classes are sufficiently requested, say, zero think time and more clients than threads, we schedule to keep the average response time in the ratio 2:5 so that it is a common fraction or multiple of the stated goal.
The properties of the weblogic.management.configuration.ResponseTimeRequestClassMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
A response time goal in milliseconds.
You can either define a response time goal or keep the -1 default value, which acts as a placeholder for the response time goal. By doing so, you have not defined the response time goal at run time but can define one later.
Type: int
Constraints: Has Default Value: -1
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
{@code RestartLoopProtectionMBean} defines the configuration to stop the partition from entering an endless restart loop. It is an optional configuration and when enabled it is a resource manager wide configuration.
The properties of the weblogic.management.configuration.RestartLoopProtectionMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Gets the value of max-restart-allowed. max-restart-allowed is defined as the maximum number of RCM initiated partition restarts allowed in the specified time interval(as specified by max-restart-allowed-interval), after which the partition will be halted upon an RCM initiated request to restart the partition.
Type: long
Constraints: Minimum Value: 0
Gets the value of max-restart-allowed-interval. The max-restart-allowed-interval is defined as a fixed-width, sliding-window time interval (in seconds) within which the specified number (as specified by max-restart-allowed) of RCM initiated partition restarts are permitted. A RCM initiated request to restart the partition that exceeds the given max-restart-allowed number in the given max-restart-allowed-interval will lead to the partition being halted than being restarted.
Type: long
Constraints: Minimum Value: 0
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The restart delay. A restart delay introduces a delay before starting the partition, as part of the RCM initiated restart action.
Type: long
Constraints: Minimum Value: 0
Checks if restart loop protection is enabled.
Type: boolean
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Controls the configuration of the RESTful Management Services interfaces to WebLogic Server.
The properties of the weblogic.management.configuration.RestfulManagementServicesMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Enables the monitoring of this WebLogic Server domain through the RESTful Management Services Web application.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies whether the REST resource features for administering WebLogic Server as a Java Service within a cloud environment should be enabled in this domain.
Type: boolean
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class represents a Store-and-Forward (SAF) agent. A SAF sending agent takes care of storing messages to a persistent storage, forwarding messages to the receiving side, and re-transmitting messages when acknowledgements do not come back in time. A SAF receiving agent takes care of detecting and eliminating duplicate messages sent by the receiving agent, and deliver messages to the final endpoint.
The properties of the weblogic.management.configuration.SAFAgentMBean entity are as follows:
The maximum interval between two successive acknowledgements sent by the receiving side.
Applies only to agents with receiving capability.
A value of -1 specifies that there is no time limit between successive acknowledgement.
Updating AcknowlegeInterval causes connections starting after the update to use the new value.
Type: long
Constraints: Has Default Value: -1
The maximum bytes quota (total amount of bytes) that can be stored in this SAF agent.
The default value of -1 specifies that there is no WebLogic-imposed limit on the number of bytes that can be stored. However, excessive bytes volume can cause memory saturation, so this value should correspond to the total amount of available system memory relative to the rest of your application load.
Applies only to agents with sending capability.
Updating BytesMaximum affects only new requests.
Range of Values: >= BytesThresholdHigh
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1
The upper threshold value that triggers events based on the number of bytes stored in the SAF agent.
The default value of -1 disables the events for this SAF agent.
Applies only to agents with sending capability.
Updating BytesThresholdHigh affects only new requests.
If the number of bytes exceeds this threshold, the triggered events are:
Log Messages: A message is logged on the server indicating a high threshold condition.
Flow Control: The agent becomes armed and instructs producers to begin decreasing their message flow.
Range of Values: <= BytesMaximum; >= BytesThresholdLow
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1
The lower threshold that triggers events based on the number of bytes stored in the SAF agent.
The default value of -1 disables the events for this SAF agent.
Applies only to agents with sending capability.
Updating BytesThresholdLow affects only new requests.
If the number of bytes falls below this threshold, the triggered events are:
Log Messages: A message is logged on the server indicating that the threshold condition has cleared.
Flow Control: The agent becomes disarmed and instructs producers to begin increasing their message flow.
Range of Values: <= BytesThresholdHigh
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1
The maximum amount of time allowed before a sending side releases the resources used by a conversation.
If there is no activity for a conversation for the specified amount of time, the sending agent releases all resources for that conversation and notifies the receiving agent to do the same.
A value of specifies that resources for a conversation are not released unless the application explicitly closes the conversation.
Updating ConversationIdleTimeMaximum causes connections starting after the update to use the new value.
Type: long
Constraints: Has Default Value: 0, Minimum Value: 0
The amount of time, in milliseconds, between the original delivery attempt and the first retry.
If RetryDelayMultiplier is set to , this defines the interval between any two successive retry attempts.
Applies only to agents with sending capability.
Updating DefaultRetryDelayBase causes connections starting after the update to use the new value.
Range of Values: <= RetryDelayMaximum if RetryDelayMultiplier is not 1.0.
Type: long
Constraints: Has Default Value: 20000, Minimum Value: 1
The maximum amount of time, in milliseconds, between two successive delivery retry attempts.
Applies only to agents with sending capability.
Updating DefaultRetryDelayMaximum causes connections starting after the update to use the new value.
Range of Values: > = RetryDelayBase if RetryDelayMultiplier is not 1.0.
Type: long
Constraints: Has Default Value: 180000, Minimum Value: 1
The factor used to multiply the previous delay time to calculate the next delay time to be used.
Applies only to agents with sending capability.
Updating DefaultRetryDelayMuliplier causes connections starting after the update to use the new value.
Range of Values: >= 1.
Type: double
Constraints: Has Default Value: 1.0, Minimum Value: 1.0
The default amount of time, in milliseconds, that the agent guarantees to reliably send messages.
A value of 0 means the agent guarantees to reliably send messages for the duration of the conversation.
Updating DefaultTimeToLive causes conversations starting after the update to use the new value.
Type: long
Constraints: Has Default Value: 0, Minimum Value: 0
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies whether the agent is paused for forwarding messages at the startup time.
When enabled, the sending agent forwards messages. Otherwise, the sending agent does not forward any messages.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies whether the agent is paused for incoming messages at startup time.
When enabled, the sending agent accepts new messages. Otherwise, the sending agent does not accept any new messages.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether a message is logged in the server log file when a message fails to be forwarded.
If selected, this applies to messages that fail to be forwarded and delivered to the final destination when there is no error handling in a SAF application or the application's error handling fails.
Applies only to agents with receiving capability.
Updating LoggingEnabled causes connections starting after the update to use the new value.
Type: boolean
Constraints: Has Default Value: true
The maximum number of bytes allowed in individual messages on this SAF agent.
The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: JMSCorrelationID and JMSType
Producers sending messages that exceed the configured maximum message size for the SAF agent will receive a ResourceAllocationException
The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
Applies only to agents with sending capability.
Updating MaximumMessageSize affects only incoming messages; stored messages are not affected.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0
The amount of memory used to store message bodies in memory before they are paged out to disk.
A value of -1 (the default) specifies that the server will automatically determine a size based on the maximum heap size of the JVM. This default will be set to either one-third the maximum heap size, or 512 megabytes, whichever is smaller.
The larger the buffer, the more memory JMS will consume when many messages are waiting on queues or topics. Once the buffer is surpassed, JMS may write message bodies to the directory specified by PagingDirectory in an effort to reduce memory usage below this buffer.
Surpassing the buffer size does not stop the JMS server from accepting new messages. It is still possible to run out of memory if messages are arriving faster than they can be written to disk. Users with high messaging loads who wish to support the highest possible availability should consider setting a quota or setting a threshold and enabling flow control.
Applies only to agents with sending capability.
Paging is always supported.
Updating the memory size resets the message count so that only requests arriving after the update are charged against the new memory size.
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1
Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores.
Use GZIP_DEFAULT_COMPRESSION to enable message compression using the JDK GZIP API with DEFAULT_COMPRESSION level.
Use GZIP_BEST_COMPRESSION to enable message compression using the JDK GZIP API with BEST_COMPRESSION level.
Use GZIP_BEST_SPEED to enable message compression using the JDK GZIP API with BEST_SPEED level.
Use LZF to enable message compression using Open Source LZF.
This attribute should be used only when configuring a WebLogic domain in an Oracle Exalogic environment.
Type: string
Constraints: Has Default Value: GZIP_DEFAULT_COMPRESSION, Legal Values: GZIP_DEFAULT_COMPRESSION, GZIP_BEST_COMPRESSION, GZIP_BEST_SPEED, LZF
The maximum message quota (total amount of messages) that can be stored in this SAF agent.
The default value of -1 specifies that the server instance has no limit on the number of messages that can be stored. However, excessive message volume can cause memory saturation, so this value should correspond to the total amount of available system memory relative to the rest of your application load.
Applies only to sending agents.
Updating the maximum message quota resets the message count so that only requests arriving after the update are charged against the new quota.
Range of Values: >= MessagesThresholdHigh
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1
The upper threshold that triggers events based on the number of messages stored in the SAF agent.
The default value of -1 disables the events for this SAF agent.
Applies only to agents with sending capability.
Updating MessagesThresholdHigh affects only new requests.
If the number of messages exceeds this threshold, the triggered events are:
Log Messages: A message is logged on the server indicating a high threshold condition.
Flow Control: The agent becomes armed and instructs producers to begin decreasing their message flow.
Range of Values: <= MessagesMaximum; >= MessagesThresholdLow
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1
The low threshold that triggers events based on the number of messages stored in the SAF agent.
The default value of -1 disables the events for this SAF agent.
Applies only to agents with sending capability.
Updating MessagesThresholdLow affects only new requests.
If the number of messages falls below this threshold, the triggered events are:
Log Messages: A message is logged on the server indicating that the threshold condition has cleared.
Flow Control: The agent becomes disarmed and instructs producers to begin increasing their message flow.
Range of Values: <= MessagesThresholdHigh.
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size. If unspecified, messages are written to the tmp directory in the host WebLogic Server instance's directory. For example, domainName/servers/servername/tmp.
For best performance, this directory should not be the same as the directory used by the SAF agent's persistent store.
Applies only to agents with sending capability.
Type: string
Constraints: Restart Required, Has Default Value: null, Legal Null: true
Enables the JMS paging store to perform message body compression on persistent and non-persistent messages. When false, the default value, no compression is performed.
This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.
Type: boolean
Constraints: Has Default Value: false
Specifies whether the agent is paused for receiving messages at the startup time.
When enabled, the sending agent receives messages. Otherwise, the sending agent does not receive any messages.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The type of service that this SAF agent provides. JMS requires only a Sending agent on the sending side for messages. Whereas, Web Services Reliable Messaging requires both a Sending and Receiving agent for messages.
Sending-only Configures an agent that stores messages in persistent storage, forwards messages to the receiving side, and re-transmits messages when acknowledgements do not come back in time.
Receiving-only Configures an agent that detects and eliminates duplicate messages sent by a receiving agent, and delivers messages to the final destination.
Both Configures an agent that has sending and receiving agent functionality.
Type: string
Constraints: Restart Required, Has Default Value: Both, Legal Values: Both, Sending-only, Receiving-only
The persistent disk-based file store or JDBC-accessible database for the SAF agent.
If a store is not configured, the server's default store is used.
Type: weblogic.management.configuration.PersistentStoreMBean reference
Constraints: Restart Required
Enables the JMS store to perform message body compression. When set to false, the default value, no compression is performed.
This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.
Type: boolean
Constraints: Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The maximum amount of time, in milliseconds, that a JMS sending agent waits before forwarding messages in a single batch. For a distributed queue or topic, WindowInterval setting is ignored.
A sending agent waits to forward the message batch until either: (A) the source destination message count is greater than or equal to the configured Window Size; (B) it has waited a specified Window Interval, whichever comes first.
Type: long
Constraints: Has Default Value: 0, Minimum Value: 0
For JMS messages, the number of messages in a batch. A sending agent waits to forward a message batch until the source destination message count is greater than or equal to this value. For a distributed queue or topic, WindowSize setting is ignored and always internally set to 1 message.
For WSRM, the maximum number of unacknowledged messages allowed between a source destination and a target destination during a conversation.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 1
This MBean is an SNMP agent that can be targeted to instances of WebLogic Server.
With SNMP, you configure agents to gather and send data about managed resources in response to a request from managers. You can also configure agents to issue unsolicited reports to managers when they detect predefined thresholds or conditions on a managed resource.
In a WebLogic Server domain, you can choose a centralized or de-centralized model for SNMP monitoring and communication:
In a centralized model, you create an instance of this MBean and target it only to the Administration Server. This agent communicates with all Managed Servers in the domain. SNMP managers communicate only with the SNMP agent on the Administration Server. This model is convenient but introduces performance overhead in WebLogic Server. In addition, if the Administration Server is unavailable, you cannot monitor the domain through SNMP.
In a de-centralized model, you create an instance of this MBean and target it to each Managed Server that you want to monitor. (Alternatively, you can create multiple instances of this MBean and target each instance to an individual Managed Server.) Your SNMP manager must communicate with the agents on individual Managed Servers.
To support domains that were created with WebLogic Server release 9.2 and earlier, a domain also hosts a singleton SNMP agent whose scope is the entire domain (see SNMPAgentMBean). SNMPAgentMBean offers the same features as an instance of this MBean (SNMPAgentDeploymentMBean) that you have targeted as described in the centralized model above. However, the underlying implementation of SNMPAgentMBean is different and it will eventually be deprecated. SNMPAgentMBean is overridden if you target an instance of this MBean to the Administration Server.
The properties of the weblogic.management.configuration.SNMPAgentDeploymentMBean entity are as follows:
Configures this SNMP agent to provide read-only access to MBean types that you have created and registered (custom MBeans).
If you enable this access, when you register a custom MBean in a WebLogic Server MBeanServer, this SNMP agent dynamically updates a runtime MIB module that WebLogic Server maintains for custom MBeans.
For each custom MBean type, WebLogic Server adds a table to the MIB module. For each instance of the custom MBean, it adds a table row. While WebLogic Server does not persist the MIB as a file or other data structure, the OIDs in the MIB remain constant across server sessions.
The MIB module for custom MBeans is managed by a subAgent. Its master agent is this WebLogic Server SNMP agent and it communicates with the master agent through the AgentX port.
Type: boolean
An identifier for this SNMP agent that is unique amongst all other SNMP agents in the current WebLogic Server domain.
If you use SNMPv3 to send messages to this SNMP agent, you must specify the SNMP engine ID when you configure the SNMP manager.
For an SNMP agent on an Administration Server, the default value is the name of the WebLogic Server domain. For an agent on a Managed Server, the default is the name of the server.
Type: string
Constraints: Legal Null: true
The port on which you want this SNMP agent to listen for incoming requests from SNMP managers that use the UDP protocol.
SNMP managers can use this port to ping the SNMP agent and request the status of specific attributes.
If you target this SNMP agent to multiple server instances, and if two or more servers are running on the same computer, WebLogic Server will automatically increment this UDP port value by 1 for each agent. WebLogic Server never assigns port 162 because it is the default port that an agent uses to send notifications. In addition, if any port is already in use, WebLogic Server skips the port and assigns the next available port.
For example, if you use the default value of this attribute and then target this agent to ManagedServer1 and ManagedServer2, and if both servers are running on the same computer, then the agent on ManagedServer1 will listen on UDP port 161 and the agent on ManagedServer2 will listen on UDP port 163.
The incremented port number is not persisted in the domain's configuration; when WebLogic Server increments port numbers, it does so in the order in which servers are started on the same computer.
If WebLogic Server re-assigns the UDP port for an SNMP agent, look in the agent's SNMPAgentRuntimeMBean to see the agent's runtime UDP port.
SNMP agents can also communicate through the host server's TCP listen port (7001 by default) or through a TCP port that is configured by a custom network channel.
Type: int
Constraints: Has Default Value: 161, Minimum Value: 1, Maximum Value: 65535
The SNMP notification version that this SNMP agent generates.
Type: int
Constraints: Has Default Value: 1, Legal Values: 1, 2, 3
The protocol that this SNMP agent uses to ensure that only authorized users can request or receive information about your WebLogic Server domain. Applicable only with SNMPv3.
The protocol also ensures message integrity and prevents masquerading and reordered, delayed, or replayed messages.
To use this protocol when receiving requests from SNMP managers, you must configure credential mapping in the WebLogic Server security realm. To use this protocol when sending responses or notifications, you must configure the security level of your trap destinations.
If you do not choose an authentication protocol, then the SNMP agent does not authenticate incoming SNMPv3 requests; anyone can use SNMPv3 to retrieve information about your WebLogic Server domain.
Type: string
Constraints: Has Default Value: noAuth, Has Production Mode Default Value: MD5, Legal Values: noAuth, MD5, SHA, Legal Null: true
Specifies whether this SNMP agent supports SNMPv1 and v2.
SNMPv1 and v2 use community strings for authentication. If you disable community strings for this SNMP agent, the agent will process only SNMPv3 requests. If an SNMP manager sends a v1 or v2 message, the agent discards the message and returns an error code to the manager.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: true
The password (community name) that you want this SNMP agent to use to secure SNMPv1 or v2 communication with SNMP managers. Requires you to enable community based access for this agent.
SNMPv3 does not use community names. Instead, it encrypts user names and passwords in its PDUs.
When you use SNMPv1 or v2, there are two community names that are needed when the WebLogic SNMP agent and SNMP managers interact:
The name that you specify in this community prefix. All SNMP managers must send this name when connecting to this SNMP agent.
The community name that the SNMP manager defines. The SNMP agent must send this name when connecting to the manager. (You supply this community name when you configure a trap destination.)
In addition to using the community prefix as a password, an SNMP agent on an Administration Server uses the prefix to qualify requests from SNMP managers. Because the Administration Server can access data for all WebLogic Server instances in a domain, a request that specifies only an attribute name is potentially ambiguous. For example, the attribute serverUptime exists for each WebLogic Server instance in a domain. To clarify requests that you send to SNMP agents on Administration Servers, use the community prefix as follows:
To request the value of an attribute on a specific Managed Server, when you send a request from an SNMP manager, append the name of the server instance to the community prefix: community_prefix@server_name
To request the value of an attribute for all server instances in a domain, send a community name with the following form: community_prefix
To secure access to the values of the WebLogic attributes when using the SNMPv1 or v2 protocols, it is recommended that you set community prefix to a value other than public
You cannot specify a null (empty) value for the community prefix. If you delete the prefix value, WebLogic Server resets the value to public. If you do not want this agent to receive SNMPv1 or v2 requests, instead of trying to set the community prefix to a null value, disable community based access. With community based access disabled, WebLogic Server ignores the community prefix value.
Type: string
Constraints: Has Secure Value: A unique value, should not be public or private, Has Default Value: public, Legal Null: true
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Has Default Value: false
Specifies whether this SNMP agent is enabled.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Configures this SNMP agent to send notifications as an INFORM instead of a TRAP. Requires you to specify the agent's SNMPTrapVersion as SNMPv2 or SNMPv3.
When an agent sends an INFORM notification, it waits for a confirmation response from the SNMP manager. If it does not receive a response, it resends the INFORM notification.
Type: boolean
Constraints: Has Default Value: false
The number of milliseconds that this SNMP agent will wait for a response to an INFORM notification.
If the agent does not receive a response within the specified interval, it will resend the notification.
Type: int
Constraints: Has Default Value: 10000, Minimum Value: 3000, Maximum Value: 30000
The listen address on which you want this SNMP agent to listen for incoming requests from SNMP managers that use the UDP protocol.
If not specified the Server's ListenAddress is used as the ListenAddress for the SNMPAgent.
Type: string
The number of milliseconds after which WebLogic Server invalidates its cache of SNMP security keys. Setting a high value creates a risk that users whose credentials have been removed can still access SNMP data.
An SNMP security key is an encrypted version of an SNMP agent's engine ID and an authentication password or privacy password. WebLogic Server generates one security key for each entry that you create in the SNMP credential map. When a WebLogic Server SNMP agent receives an SNMPv3 request, it compares the key that is in the request with its WebLogic Server keys. If it finds a match, it processes the request. The SNMP agent also encodes these keys in its responses and notifications. (You configure which keys are encoded when you create a trap destination.)
Instead of regenerating the keys for each SNMPv3 communication, WebLogic Server caches the keys. To make sure that the cache contains the latest set of SNMP credentials, WebLogic Server periodically invalidates the cache. After the cache is invalidated, the next time an SNMP agent requests credentials, WebLogic Server regenerates the cache.
Note that making a change to the credential map does not automatically update the cache. Instead, the cache is updated only after it has been invalidated.
For example, if you update a privacy password in an existing entry in the SNMP credential map, the SNMP agent is not aware of the new password until the key cache is invalidated and regenerated. An SNMP user with the old security password can still access WebLogic Server data until the cache is invalidated.
You can invalidate a key immediately instead of waiting for this invalidation interval to expire.
Type: long
Constraints: Has Default Value: 3600000, Maximum Value: 86400000
The port that this SNMP agent uses to communicate with its subagents.
The agent uses subagents to provide access to custom MBeans (MBeans that you create and register) and to other software components. WebLogic Server SNMP agents do not enable users to register their own subagents.
Type: int
Constraints: Has Default Value: 705, Minimum Value: 1, Maximum Value: 65535
The maximum number of times that this SNMP agent will resend INFORM notifications for which it has not received a response.
Type: int
Constraints: Has Default Value: 1, Minimum Value: 1, Maximum Value: 3
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
Type: string
Constraints: Read Only, Legal Null: true
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.
Type: string
The protocol that this SNMP agent uses to encrypt and unencrypt messages. Applicable only with SNMPv3. Requires you to also use an authentication protocol.
To use this protocol when sending responses or notifications, you must also configure the security level of your trap destinations.
If you do not choose a privacy protocol, then communication between this agent and managers can be viewed (but not altered) by unauthorized users.
Type: string
Constraints: Has Default Value: noPriv, Legal Values: noPriv, DES, AES_128, Legal Null: true
Specifies whether this SNMP agent sends automatically generated notifications to SNMP managers.
The SNMP agent generates automatic notifications when any of the following events occur:
The WebLogic Server instance that is hosting the SNMP agent starts.
This type of notification (coldStart) has no variable bindings.
A server instance starts or stops.
An SNMP agent on a Managed Server generates these notifications only when its host Managed Server starts or stops. An SNMP agent on an Administration Server generates these notifications when any server in the domain starts or stops.
These notification types (serverStart and serverShutdown) contain variable bindings to identify the server that started or stopped and the time at which the notification was generated.
Type: boolean
Constraints: Has Default Value: true
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This singleton MBean represents an SNMP agent that is scoped to a WebLogic Server domain.
This MBean is provided to support domains that were created with WebLogic Server release 9.2 and earlier. For new domains, create an instance of SNMPAgentDeploymentMBean and target it to the domain's Administration Server.
The properties of the weblogic.management.configuration.SNMPAgentMBean entity are as follows:
Configures this SNMP agent to provide read-only access to MBean types that you have created and registered (custom MBeans).
If you enable this access, when you register a custom MBean in a WebLogic Server MBeanServer, this SNMP agent dynamically updates a runtime MIB module that WebLogic Server maintains for custom MBeans.
For each custom MBean type, WebLogic Server adds a table to the MIB module. For each instance of the custom MBean, it adds a table row. While WebLogic Server does not persist the MIB as a file or other data structure, the OIDs in the MIB remain constant across server sessions.
The MIB module for custom MBeans is managed by a subAgent. Its master agent is this WebLogic Server SNMP agent and it communicates with the master agent through the AgentX port.
Type: boolean
An identifier for this SNMP agent that is unique amongst all other SNMP agents in the current WebLogic Server domain.
If you use SNMPv3 to send messages to this SNMP agent, you must specify the SNMP engine ID when you configure the SNMP manager.
For an SNMP agent on an Administration Server, the default value is the name of the WebLogic Server domain. For an agent on a Managed Server, the default is the name of the server.
Type: string
Constraints: Legal Null: true
The port on which you want this SNMP agent to listen for incoming requests from SNMP managers that use the UDP protocol.
SNMP managers can use this port to ping the SNMP agent and request the status of specific attributes.
If you target this SNMP agent to multiple server instances, and if two or more servers are running on the same computer, WebLogic Server will automatically increment this UDP port value by 1 for each agent. WebLogic Server never assigns port 162 because it is the default port that an agent uses to send notifications. In addition, if any port is already in use, WebLogic Server skips the port and assigns the next available port.
For example, if you use the default value of this attribute and then target this agent to ManagedServer1 and ManagedServer2, and if both servers are running on the same computer, then the agent on ManagedServer1 will listen on UDP port 161 and the agent on ManagedServer2 will listen on UDP port 163.
The incremented port number is not persisted in the domain's configuration; when WebLogic Server increments port numbers, it does so in the order in which servers are started on the same computer.
If WebLogic Server re-assigns the UDP port for an SNMP agent, look in the agent's SNMPAgentRuntimeMBean to see the agent's runtime UDP port.
SNMP agents can also communicate through the host server's TCP listen port (7001 by default) or through a TCP port that is configured by a custom network channel.
Type: int
Constraints: Has Default Value: 161, Minimum Value: 1, Maximum Value: 65535
The SNMP notification version that this SNMP agent generates.
Type: int
Constraints: Has Default Value: 1, Legal Values: 1, 2, 3
The protocol that this SNMP agent uses to ensure that only authorized users can request or receive information about your WebLogic Server domain. Applicable only with SNMPv3.
The protocol also ensures message integrity and prevents masquerading and reordered, delayed, or replayed messages.
To use this protocol when receiving requests from SNMP managers, you must configure credential mapping in the WebLogic Server security realm. To use this protocol when sending responses or notifications, you must configure the security level of your trap destinations.
If you do not choose an authentication protocol, then the SNMP agent does not authenticate incoming SNMPv3 requests; anyone can use SNMPv3 to retrieve information about your WebLogic Server domain.
Type: string
Constraints: Has Default Value: noAuth, Has Production Mode Default Value: MD5, Legal Values: noAuth, MD5, SHA, Legal Null: true
Specifies whether this SNMP agent supports SNMPv1 and v2.
SNMPv1 and v2 use community strings for authentication. If you disable community strings for this SNMP agent, the agent will process only SNMPv3 requests. If an SNMP manager sends a v1 or v2 message, the agent discards the message and returns an error code to the manager.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: true
The password (community name) that you want this SNMP agent to use to secure SNMPv1 or v2 communication with SNMP managers. Requires you to enable community based access for this agent.
SNMPv3 does not use community names. Instead, it encrypts user names and passwords in its PDUs.
When you use SNMPv1 or v2, there are two community names that are needed when the WebLogic SNMP agent and SNMP managers interact:
The name that you specify in this community prefix. All SNMP managers must send this name when connecting to this SNMP agent.
The community name that the SNMP manager defines. The SNMP agent must send this name when connecting to the manager. (You supply this community name when you configure a trap destination.)
In addition to using the community prefix as a password, an SNMP agent on an Administration Server uses the prefix to qualify requests from SNMP managers. Because the Administration Server can access data for all WebLogic Server instances in a domain, a request that specifies only an attribute name is potentially ambiguous. For example, the attribute serverUptime exists for each WebLogic Server instance in a domain. To clarify requests that you send to SNMP agents on Administration Servers, use the community prefix as follows:
To request the value of an attribute on a specific Managed Server, when you send a request from an SNMP manager, append the name of the server instance to the community prefix: community_prefix@server_name
To request the value of an attribute for all server instances in a domain, send a community name with the following form: community_prefix
To secure access to the values of the WebLogic attributes when using the SNMPv1 or v2 protocols, it is recommended that you set community prefix to a value other than public
You cannot specify a null (empty) value for the community prefix. If you delete the prefix value, WebLogic Server resets the value to public. If you do not want this agent to receive SNMPv1 or v2 requests, instead of trying to set the community prefix to a null value, disable community based access. With community based access disabled, WebLogic Server ignores the community prefix value.
Type: string
Constraints: Has Secure Value: A unique value, should not be public or private, Has Default Value: public, Legal Null: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Has Default Value: false
Specifies whether this SNMP agent is enabled.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Configures this SNMP agent to send notifications as an INFORM instead of a TRAP. Requires you to specify the agent's SNMPTrapVersion as SNMPv2 or SNMPv3.
When an agent sends an INFORM notification, it waits for a confirmation response from the SNMP manager. If it does not receive a response, it resends the INFORM notification.
Type: boolean
Constraints: Has Default Value: false
The number of milliseconds that this SNMP agent will wait for a response to an INFORM notification.
If the agent does not receive a response within the specified interval, it will resend the notification.
Type: int
Constraints: Has Default Value: 10000, Minimum Value: 3000, Maximum Value: 30000
The listen address on which you want this SNMP agent to listen for incoming requests from SNMP managers that use the UDP protocol.
If not specified the Server's ListenAddress is used as the ListenAddress for the SNMPAgent.
Type: string
The number of milliseconds after which WebLogic Server invalidates its cache of SNMP security keys. Setting a high value creates a risk that users whose credentials have been removed can still access SNMP data.
An SNMP security key is an encrypted version of an SNMP agent's engine ID and an authentication password or privacy password. WebLogic Server generates one security key for each entry that you create in the SNMP credential map. When a WebLogic Server SNMP agent receives an SNMPv3 request, it compares the key that is in the request with its WebLogic Server keys. If it finds a match, it processes the request. The SNMP agent also encodes these keys in its responses and notifications. (You configure which keys are encoded when you create a trap destination.)
Instead of regenerating the keys for each SNMPv3 communication, WebLogic Server caches the keys. To make sure that the cache contains the latest set of SNMP credentials, WebLogic Server periodically invalidates the cache. After the cache is invalidated, the next time an SNMP agent requests credentials, WebLogic Server regenerates the cache.
Note that making a change to the credential map does not automatically update the cache. Instead, the cache is updated only after it has been invalidated.
For example, if you update a privacy password in an existing entry in the SNMP credential map, the SNMP agent is not aware of the new password until the key cache is invalidated and regenerated. An SNMP user with the old security password can still access WebLogic Server data until the cache is invalidated.
You can invalidate a key immediately instead of waiting for this invalidation interval to expire.
Type: long
Constraints: Has Default Value: 3600000, Maximum Value: 86400000
The port that this SNMP agent uses to communicate with its subagents.
The agent uses subagents to provide access to custom MBeans (MBeans that you create and register) and to other software components. WebLogic Server SNMP agents do not enable users to register their own subagents.
Type: int
Constraints: Has Default Value: 705, Minimum Value: 1, Maximum Value: 65535
The maximum number of times that this SNMP agent will resend INFORM notifications for which it has not received a response.
Type: int
Constraints: Has Default Value: 1, Minimum Value: 1, Maximum Value: 3
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
Type: string
Constraints: Read Only, Legal Null: true
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.
Type: string
The protocol that this SNMP agent uses to encrypt and unencrypt messages. Applicable only with SNMPv3. Requires you to also use an authentication protocol.
To use this protocol when sending responses or notifications, you must also configure the security level of your trap destinations.
If you do not choose a privacy protocol, then communication between this agent and managers can be viewed (but not altered) by unauthorized users.
Type: string
Constraints: Has Default Value: noPriv, Legal Values: noPriv, DES, AES_128, Legal Null: true
Specifies whether this SNMP agent sends automatically generated notifications to SNMP managers.
The SNMP agent generates automatic notifications when any of the following events occur:
The WebLogic Server instance that is hosting the SNMP agent starts.
This type of notification (coldStart) has no variable bindings.
A server instance starts or stops.
An SNMP agent on a Managed Server generates these notifications only when its host Managed Server starts or stops. An SNMP agent on an Administration Server generates these notifications when any server in the domain starts or stops.
These notification types (serverStart and serverShutdown) contain variable bindings to identify the server that started or stopped and the time at which the notification was generated.
Type: boolean
Constraints: Has Default Value: true
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class describes the settings to receive MBean-attribute change notification.
The properties of the weblogic.management.configuration.SNMPAttributeChangeMBean entity are as follows:
The name of the MBean instance that you want to monitor. If you leave the name undefined, WebLogic Server monitors all instances of the MBean type that you specify in Monitored MBean Type.
Do not enter the full JMX object name of the MBean instance. Instead, enter only the value that you provided when you created the instance. To create unique MBean object names, WebLogic Server encodes several name-value pairs into each object name. One of these pairs is Name=name, and this is the value that you enter for MBean Name. For example:
"MedRec:Name=MedRecServer
Type=ServerRuntime"
In the previous example, specify MedRecServer as the name of the MBean instance.
Type: string
The MBean type that defines the attribute you want to monitor. Do not include the MBean suffix. For example, specify Server to monitor a ServerMBean.
WebLogic Server does not support using Attribute Change notifications to monitor run-time attributes. Runtime MBeans always include the word Runtime in their names. For example, the ServerRuntime MBean provides access to runtime attributes while the Server MBean provides access to configuration attributes. To monitor changes in an MBean that includes Runtime in its name, use a String Monitor, Gauge Monitor, or Counter Monitor.
Type: string
The name of the attribute that you want to monitor. This attribute must be in the WebLogic Server MIB.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain. The EnabledServers attribute allows the users to limit the scope of the monitored data sources to the specific named Servers. The EnabledServers list is ignored when the SNMAgentDeploymentMBean is targeted to a Managed Server. In the case of a Managed Server the SNMP Agent only looks at the data available in the WebLogic Server where the SNMP Agent is deployed.
For traps based on MBean attributes the SNMP Agent refers to the Domain Runtime MBean Server when it is running on the Admin Server and the Runtime MBean Server when it is deployed to a Managed Server.
In the case of SNMPJMXMonitorMBean and SNMPAttributeChangeMBean the MonitoredMBeanType and MonitoredMBeanName attributes specify the type and name of a WebLogic Server MBean for which the trap will be setup. MBeans that meet the Type and Name criteria are qualified to set the trap on. The EnabledServers attribute allows a user to specify additional criteria based on the Location of an MBean when the SNMP Agent is targeted to the Admin Server. MBeans whose Location matches one of the Servers in the EnabledServers list are considered eligible for the trap to be generated for a corresponding JMX notification. When the EnabledServers attribute is not specified all MBeans whose Type and Name match are considered as valid sources for the SNMP trap.
In the case of SNMPLogFilterMBean the EnabledServers attribute allows a user to specify the Servers in the Domain whose log messages will be monitored when the Agent is running on the Admin Server. When EnabledServers is not specified for an Agent running on the Admin Server log messages on all Managed Servers in the domain are monitored for sending traps. This attribute is not applicable when the SNMP Agent is targeted to a Managed Server, in this case the traps are sent based on log messages generated by the respective Managed Server where the Agent is deployed.
Type: array of weblogic.management.configuration.ServerMBean references
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class describes the criteria for a Counter-based Monitor. A notification will be generated when this criteria is satisfied.
The properties of the weblogic.management.configuration.SNMPCounterMonitorMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain. The EnabledServers attribute allows the users to limit the scope of the monitored data sources to the specific named Servers. The EnabledServers list is ignored when the SNMAgentDeploymentMBean is targeted to a Managed Server. In the case of a Managed Server the SNMP Agent only looks at the data available in the WebLogic Server where the SNMP Agent is deployed.
For traps based on MBean attributes the SNMP Agent refers to the Domain Runtime MBean Server when it is running on the Admin Server and the Runtime MBean Server when it is deployed to a Managed Server.
In the case of SNMPJMXMonitorMBean and SNMPAttributeChangeMBean the MonitoredMBeanType and MonitoredMBeanName attributes specify the type and name of a WebLogic Server MBean for which the trap will be setup. MBeans that meet the Type and Name criteria are qualified to set the trap on. The EnabledServers attribute allows a user to specify additional criteria based on the Location of an MBean when the SNMP Agent is targeted to the Admin Server. MBeans whose Location matches one of the Servers in the EnabledServers list are considered eligible for the trap to be generated for a corresponding JMX notification. When the EnabledServers attribute is not specified all MBeans whose Type and Name match are considered as valid sources for the SNMP trap.
In the case of SNMPLogFilterMBean the EnabledServers attribute allows a user to specify the Servers in the Domain whose log messages will be monitored when the Agent is running on the Admin Server. When EnabledServers is not specified for an Agent running on the Admin Server log messages on all Managed Servers in the domain are monitored for sending traps. This attribute is not applicable when the SNMP Agent is targeted to a Managed Server, in this case the traps are sent based on log messages generated by the respective Managed Server where the Agent is deployed.
Type: array of weblogic.management.configuration.ServerMBean references
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
A value to be subtracted from the threshold value when the threshold value is crossed.
If Modulus is 0, a notification is generated each time the agent polls the monitored attribute and its value still exceeds or equals the threshold value.
If Modulus is larger than 0, the value of the modulus is subtracted from the threshold each time the threshold is crossed.
Type: long
Constraints: Minimum Value: 0
The name of an MBean attribute to monitor. This attribute must be in the WebLogic Server MIB.
Type: string
Constraints: Restart Required
The name of the MBean instance that you want to monitor. If you leave the name undefined, WebLogic Server monitors all instances of the MBean type that you specify in Monitored MBean Type.
If you target SNMP agents to individual Managed Servers, make sure that the MBean instance you specify is active on the Managed Servers you have targeted. For example, if you specify MServer1 as the name of a ServerRuntimeMBean instance, this monitor will only function if you target an SNMP agent either to the Administration Server or to a Managed Server named MServer1
Do not enter the full JMX object name of the MBean instance. Instead, enter only the value of the object name's Name=name name-value pair. To create unique MBean object names, WebLogic Server encodes several name-value pairs into each object name. One of these pairs is Name=name. For example:
"MedRec:Name=MedRecServer
Type=ServerRuntime"
In the previous example, specify MedRecServer as the name of the MBean instance.
Type: string
Constraints: Restart Required
The MBean type that defines the attribute you want to monitor. Do not include the MBean suffix. For example, ServerRuntime
Type: string
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
A value to be added to the threshold value each time the observed value equals or exceeds the threshold.
Type: long
Constraints: Minimum Value: 0
The frequency (in seconds) that WebLogic Server checks the attribute value.
Type: int
Constraints: Restart Required, Has Default Value: 10, Minimum Value: 1, Maximum Value: 65535
Return all tags on this Configuration MBean
Type: array of string
Specifies a value that triggers the Counter Monitor to generate a notification.
The monitor generates a notification the first time the observed value transitions from below the threshold to at or above the threshold. While the observed value remains at or above the threshold, the Counter Monitor does not generate additional notifications. If the observed value falls below the threshold and then later equals or exceeds the threshold, the Counter Monitor does not generate an additional notification.
You can specify an offset value to cause this threshold value to increase each time the observed value equals or exceeds the threshold. The first time the observed value equals or exceeds the new threshold value, this monitor generates a notification and adds the offset value to the new threshold value.
For example, if you set Threshold to 1000 and Offset to 2000, when the observed attribute equals or exceeds 1000, the Counter Monitor sends a notification and increases the threshold to 3000. When the observed attribute equals or exceeds 3000, the Counter Monitor sends a notification and increases the threshold again to 5000.
Type: long
Constraints: Minimum Value: 0
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class describes the criteria for a Gauge-based Monitor. A notification will be generated when this criteria is satisfied.
The properties of the weblogic.management.configuration.SNMPGaugeMonitorMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain. The EnabledServers attribute allows the users to limit the scope of the monitored data sources to the specific named Servers. The EnabledServers list is ignored when the SNMAgentDeploymentMBean is targeted to a Managed Server. In the case of a Managed Server the SNMP Agent only looks at the data available in the WebLogic Server where the SNMP Agent is deployed.
For traps based on MBean attributes the SNMP Agent refers to the Domain Runtime MBean Server when it is running on the Admin Server and the Runtime MBean Server when it is deployed to a Managed Server.
In the case of SNMPJMXMonitorMBean and SNMPAttributeChangeMBean the MonitoredMBeanType and MonitoredMBeanName attributes specify the type and name of a WebLogic Server MBean for which the trap will be setup. MBeans that meet the Type and Name criteria are qualified to set the trap on. The EnabledServers attribute allows a user to specify additional criteria based on the Location of an MBean when the SNMP Agent is targeted to the Admin Server. MBeans whose Location matches one of the Servers in the EnabledServers list are considered eligible for the trap to be generated for a corresponding JMX notification. When the EnabledServers attribute is not specified all MBeans whose Type and Name match are considered as valid sources for the SNMP trap.
In the case of SNMPLogFilterMBean the EnabledServers attribute allows a user to specify the Servers in the Domain whose log messages will be monitored when the Agent is running on the Admin Server. When EnabledServers is not specified for an Agent running on the Admin Server log messages on all Managed Servers in the domain are monitored for sending traps. This attribute is not applicable when the SNMP Agent is targeted to a Managed Server, in this case the traps are sent based on log messages generated by the respective Managed Server where the Agent is deployed.
Type: array of weblogic.management.configuration.ServerMBean references
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The name of an MBean attribute to monitor. This attribute must be in the WebLogic Server MIB.
Type: string
Constraints: Restart Required
The name of the MBean instance that you want to monitor. If you leave the name undefined, WebLogic Server monitors all instances of the MBean type that you specify in Monitored MBean Type.
If you target SNMP agents to individual Managed Servers, make sure that the MBean instance you specify is active on the Managed Servers you have targeted. For example, if you specify MServer1 as the name of a ServerRuntimeMBean instance, this monitor will only function if you target an SNMP agent either to the Administration Server or to a Managed Server named MServer1
Do not enter the full JMX object name of the MBean instance. Instead, enter only the value of the object name's Name=name name-value pair. To create unique MBean object names, WebLogic Server encodes several name-value pairs into each object name. One of these pairs is Name=name. For example:
"MedRec:Name=MedRecServer
Type=ServerRuntime"
In the previous example, specify MedRecServer as the name of the MBean instance.
Type: string
Constraints: Restart Required
The MBean type that defines the attribute you want to monitor. Do not include the MBean suffix. For example, ServerRuntime
Type: string
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The frequency (in seconds) that WebLogic Server checks the attribute value.
Type: int
Constraints: Restart Required, Has Default Value: 10, Minimum Value: 1, Maximum Value: 65535
Return all tags on this Configuration MBean
Type: array of string
The high threshold at which a notification should be generated. A notification is generated the first time the monitored value is equal to or greater than this value.
Subsequent crossings of the high threshold value do not cause additional notifications unless the attribute value becomes equal to or less than the low threshold value.
Type: double
The low threshold at which a notification should be generated. A notification is generated the first time the monitored value is less than or equal to this value.
Subsequent crossings of the low threshold value do not cause additional notifications unless the attribute value becomes equal to or greater than the high threshold value.
Type: double
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean represents a filter to qualify log messages which are logged to the server logfile. A message must qualify criteria specified as a filter in order to generate a notification. Multiple instances of this MBean can be defined, if needed. If there are multiple instances, a message must qualify atleast one filter to qualify for the server logfile.
The properties of the weblogic.management.configuration.SNMPLogFilterMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain. The EnabledServers attribute allows the users to limit the scope of the monitored data sources to the specific named Servers. The EnabledServers list is ignored when the SNMAgentDeploymentMBean is targeted to a Managed Server. In the case of a Managed Server the SNMP Agent only looks at the data available in the WebLogic Server where the SNMP Agent is deployed.
For traps based on MBean attributes the SNMP Agent refers to the Domain Runtime MBean Server when it is running on the Admin Server and the Runtime MBean Server when it is deployed to a Managed Server.
In the case of SNMPJMXMonitorMBean and SNMPAttributeChangeMBean the MonitoredMBeanType and MonitoredMBeanName attributes specify the type and name of a WebLogic Server MBean for which the trap will be setup. MBeans that meet the Type and Name criteria are qualified to set the trap on. The EnabledServers attribute allows a user to specify additional criteria based on the Location of an MBean when the SNMP Agent is targeted to the Admin Server. MBeans whose Location matches one of the Servers in the EnabledServers list are considered eligible for the trap to be generated for a corresponding JMX notification. When the EnabledServers attribute is not specified all MBeans whose Type and Name match are considered as valid sources for the SNMP trap.
In the case of SNMPLogFilterMBean the EnabledServers attribute allows a user to specify the Servers in the Domain whose log messages will be monitored when the Agent is running on the Admin Server. When EnabledServers is not specified for an Agent running on the Admin Server log messages on all Managed Servers in the domain are monitored for sending traps. This attribute is not applicable when the SNMP Agent is targeted to a Managed Server, in this case the traps are sent based on log messages generated by the respective Managed Server where the Agent is deployed.
Type: array of weblogic.management.configuration.ServerMBean references
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
A list of message IDs or ID ranges that cause a WebLogic Server SNMP agent to generate a notification.
If no IDs are specified, this filter selects all message IDs.
Example list: 20,50-100,300
Type: array of string
A string that is searched for in the message text. Only messages that contain the string are selected. If a string is not specified, all messages are selected.
Type: string
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The minimum severity of a message that causes a WebLogic Server SNMP agent to generate a notification.
Type: string
Constraints: Has Default Value: Notice
A list of subsystems whose messages are selected by this log filter. If none are specified, messages from all subsystems are selected.
Type: array of string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
A list of user IDs that causes a WebLogic Server SNMP agent to generate a notification.
Every message includes the user ID from the security context in which the message was generated.
If the user ID field for a message matches one of the user IDs you specify in the filter, WebLogic Server generates a notification.
If this log filter doesn't specify user IDs, WebLogic Server can generate a notification for messages from all user IDs.
Type: array of string
This MBean represents an SNMP agent that is proxied by a WebLogic Server SNMP agent.
The properties of the weblogic.management.configuration.SNMPProxyMBean entity are as follows:
The community name to be passed on for all SNMPv1 requests to this proxied SNMP agent.
If you specify a security name for this proxied agent, the WebLogic SNMP agent ignores this community name. Instead, the agent encodes the security name in an SNMPv3 request and forwards the SNMPv3 request to this proxied agent.
Type: string
Constraints: Has Secure Value: null, Has Default Value: public
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The root of the object identifier (OID) tree that this proxied SNMP agent controls.
Type: string
The port number on which this proxied SNMP agent is listening.
Type: int
Constraints: Minimum Value: 0, Maximum Value: 65535
The security level that the proxied SNMP agent expects for the specified security name.
Type: string
Constraints: Has Default Value: noAuthNoPriv, Has Production Mode Default Value: authNoPriv, Legal Values: noAuthNoPriv, authNoPriv, authPriv, Legal Null: true
The user name on whose behalf the WebLogic SNMP agent forwards v3 requests. If not specified, the request is forwarded as a v1 request.
If you specify a security name, you must also specify a security level that is equal to or lower than the security level that is configured for communication between the WebLogic SNMP agent and SNMP managers. For example, if the WebLogic SNMP agent requires incoming SNMPv3 requests to use the authentication protocol but no privacy protocol, the security level for this proxy must be either Authentication Only or None. Note that if you want to use the authorization or privacy protocols, you must configure credential mapping in the WebLogic Server security realm.
The WebLogic SNMP agent cannot forward or pass through the credentials that are contained in SNMPv3 requests from SNMP managers. Instead, the agent authenticates and performs other security operations on incoming requests, and then constructs a new request to forward to a proxied agent.
Type: string
Constraints: Legal Null: true
Return all tags on this Configuration MBean
Type: array of string
The number of milliseconds that the WebLogic Server SNMP agent waits for a response to requests that it forwards to this proxy agent.
If the interval elapses without a response, the WebLogic SNMP agent sends an error to the requesting manager.
Type: long
Constraints: Has Default Value: 5000, Minimum Value: 0
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class describes the criteria for a String-based Monitor. A notification is generated when this criteria is satisfied.
The properties of the weblogic.management.configuration.SNMPStringMonitorMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain. The EnabledServers attribute allows the users to limit the scope of the monitored data sources to the specific named Servers. The EnabledServers list is ignored when the SNMAgentDeploymentMBean is targeted to a Managed Server. In the case of a Managed Server the SNMP Agent only looks at the data available in the WebLogic Server where the SNMP Agent is deployed.
For traps based on MBean attributes the SNMP Agent refers to the Domain Runtime MBean Server when it is running on the Admin Server and the Runtime MBean Server when it is deployed to a Managed Server.
In the case of SNMPJMXMonitorMBean and SNMPAttributeChangeMBean the MonitoredMBeanType and MonitoredMBeanName attributes specify the type and name of a WebLogic Server MBean for which the trap will be setup. MBeans that meet the Type and Name criteria are qualified to set the trap on. The EnabledServers attribute allows a user to specify additional criteria based on the Location of an MBean when the SNMP Agent is targeted to the Admin Server. MBeans whose Location matches one of the Servers in the EnabledServers list are considered eligible for the trap to be generated for a corresponding JMX notification. When the EnabledServers attribute is not specified all MBeans whose Type and Name match are considered as valid sources for the SNMP trap.
In the case of SNMPLogFilterMBean the EnabledServers attribute allows a user to specify the Servers in the Domain whose log messages will be monitored when the Agent is running on the Admin Server. When EnabledServers is not specified for an Agent running on the Admin Server log messages on all Managed Servers in the domain are monitored for sending traps. This attribute is not applicable when the SNMP Agent is targeted to a Managed Server, in this case the traps are sent based on log messages generated by the respective Managed Server where the Agent is deployed.
Type: array of weblogic.management.configuration.ServerMBean references
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The name of an MBean attribute to monitor. This attribute must be in the WebLogic Server MIB.
Type: string
Constraints: Restart Required
The name of the MBean instance that you want to monitor. If you leave the name undefined, WebLogic Server monitors all instances of the MBean type that you specify in Monitored MBean Type.
If you target SNMP agents to individual Managed Servers, make sure that the MBean instance you specify is active on the Managed Servers you have targeted. For example, if you specify MServer1 as the name of a ServerRuntimeMBean instance, this monitor will only function if you target an SNMP agent either to the Administration Server or to a Managed Server named MServer1
Do not enter the full JMX object name of the MBean instance. Instead, enter only the value of the object name's Name=name name-value pair. To create unique MBean object names, WebLogic Server encodes several name-value pairs into each object name. One of these pairs is Name=name. For example:
"MedRec:Name=MedRecServer
Type=ServerRuntime"
In the previous example, specify MedRecServer as the name of the MBean instance.
Type: string
Constraints: Restart Required
The MBean type that defines the attribute you want to monitor. Do not include the MBean suffix. For example, ServerRuntime
Type: string
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Generates a notification if the value of the monitored attribute and the value of String to Compare are different.
Type: boolean
Constraints: Has Default Value: false
Generates a notification if the value of the monitored attribute and the value of String to Compare are the same.
Type: boolean
Constraints: Has Default Value: false
The frequency (in seconds) that WebLogic Server checks the attribute value.
Type: int
Constraints: Restart Required, Has Default Value: 10, Minimum Value: 1, Maximum Value: 65535
The string against which the value of the monitored attribute will be compared.
A notification is generated when the criteria specified by Notify Match or Notify Differ is satisfied.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean describes a destination to which an SNMP agent sends SNMP TRAP and INFORM notifications.
The properties of the weblogic.management.configuration.SNMPTrapDestinationMBean entity are as follows:
The password (community name) that a WebLogic Server SNMP agent sends to the SNMP manager when the agent generates SNMPv1 or SNMPv2 notifications.
The community name that you enter in this trap destination must match the name that the SNMP manager defines.
Type: string
Constraints: Has Secure Value: null, Has Default Value: public
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The DNS name or IP address of the computer on which the SNMP manager is running.
The WebLogic SNMP agent sends trap notifications to the host and port that you specify.
Type: string
Constraints: Has Secure Value: 127.0.0.1 or ::1, Has Default Value: localhost
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The UDP port on which the SNMP manager is listening.
Type: int
Constraints: Has Default Value: 162, Minimum Value: 1, Maximum Value: 65535
Specifies the security protocols that the SNMP agent uses when sending SNMPv3 responses or notifications to the SNMP manager that this trap destination represents. Requires you to specify a security name for this trap destination.
Type: string
Constraints: Has Default Value: noAuthNoPriv, Has Production Mode Default Value: authNoPriv, Legal Values: noAuthNoPriv, authNoPriv, authPriv, Legal Null: true
Specifies the user name that the WebLogic Server SNMP agent encodes into SNMPv3 responses or notifications. Requires you to create a credential map for this user name in the WebLogic Server security realm.
The credential map contains an authentication password and an optional privacy password for this user.
The user name and passwords must match the credentials required by the SNMP manager that this trap destination represents.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean represents the configuration of the SSL protocol.
The properties of the weblogic.management.configuration.SSLMBean entity are as follows:
Determines whether the SSL implementation in Weblogic Server is JSSE based.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Indicates whether warning messages are logged in the server log when SSL connections are rejected.
Type: boolean
Constraints: Has Default Value: true
Indicate whether SSLv2Hello is enabled
Type: boolean
Constraints: Has Default Value: true
Type: boolean
Constraints: Has Default Value: true
Test if the AllowUnEncryptedNullCipher is enabled
see setAllowUnencryptedNullCipher(boolean enable) for the NullCipher feature.
Type: boolean
Constraints: Has Default Value: false
Indicates the cipher suites being used on a particular WebLogic Server.
The strongest negotiated cipher suite is chosen during the SSL handshake. The set of cipher suites used by default by JSEE depends on the specific JDK version with which WebLogic Server is configured.
For a list of possible values, see Cipher Suites
Type: array of string
Determines the alias of the client SSL certificate to be used as identity for outbound SSL connections. The certificate is assumed to be stored in the server configured keystore.
Note that to use the client SSL certificate, setUseClientCertForOutbound must be enabled.
Type: string
Constraints: Has Default Value: null
The passphrase used to retrieve the private key for the client SSL certificate specified in getClientCertAlias from the server configured keystore. This passphrase is assigned to the private key when the private key is generated.
Note that this attribute is usually used when outbound SSL connections specify a client SSL certificate identity.
Note that when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the ClientCertPrivateKeyPassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted passphrase.
Type: string
Constraints: Encrypted, Has Default Value: null
Indicates whether or not clients must present digital certificates from a trusted certificate authority to WebLogic Server.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Indicates whether the server can be reached through the default SSL listen port.
If the administration port is enabled for the WebLogic Server domain, then administrative traffic travels over the administration port and application traffic travels over the Listen Port and SSL Listen Port. If the administration port is disabled, then all traffic travels over the Listen Port and SSL Listen Port.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: false
Indicates the number of times WebLogic Server can use an exportable key between a domestic server and an exportable client before generating a new key. The more secure you want WebLogic Server to be, the fewer times the key should be used before generating a new key.
Type: int
Constraints: Has Default Value: 500, Minimum Value: 1, Maximum Value: 2147483647
Specifies whether to ignore the installed implementation of the weblogic.security.SSL.HostnameVerifier interface (when this server is acting as a client to another application server).
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
The name of the class that implements the weblogic.security.SSL.HostnameVerifier interface.
This class verifies whether the connection to the host with the hostname from URL should be allowed. The class is used to prevent man-in-the-middle attacks. The weblogic.security.SSL.HostnameVerifier has a verify() method that WebLogic Server calls on the client during the SSL handshake.
Type: string
Constraints: Has Default Value: null
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Indicates where SSL should find the server's identity (certificate and private key) as well as the server's trust (trusted CAs).
If set to KEYSTORES, then SSL retrieves the identity and trust from the server's keystores (that are configured on the Server).
If set to FILES_OR_KEYSTORE_PROVIDERS, then SSL first looks in the deprecated KeyStore providers for the identity and trust. If not found, then it looks in the flat files indicated by the SSL Trusted CA File Name, Server Certificate File Name, and Server Key File Name attributes.
Domains created in WebLogic Server version 8.1 or later, default to KEYSTORES. Domains created before WebLogic Server version 8.1, default to FILES_OR_KEYSTORE_PROVIDERS.
Type: string
Constraints: Has Default Value: KeyStores, Legal Values: KeyStores, FilesOrKeyStoreProviders
Indicates the client certificate validation rules for inbound SSL.
This attribute only applies to ports and network channels using 2-way SSL.
Type: string
Constraints: Has Default Value: BuiltinSSLValidationOnly, Legal Values: BuiltinSSLValidationOnly, BuiltinSSLValidationAndCertPathValidators
The TCP/IP port at which this server listens for SSL connection requests.
Type: int
Constraints: Has Default Value: 7002, Minimum Value: 1, Maximum Value: 65535
Specifies the number of milliseconds that WebLogic Server waits for an SSL connection before timing out. SSL connections take longer to negotiate than regular connections.
If clients are connecting over the Internet, raise the default number to accommodate additional network latency.
Type: int
Constraints: Has Default Value: 25000, Minimum Value: 1, Maximum Value: 2147483647
Get the minimum SSL/TLS protocol version currently configured.
Type: string
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Indicates the server certificate validation rules for outbound SSL.
This attribute always applies to outbound SSL that is part of WebLogic Server (that is, an Administration Server talking to the Node Manager). It does not apply to application code in the server that is using outbound SSL unless the application code uses a weblogic.security.SSL.ServerTrustManager that is configured to use outbound SSL validation.
Type: string
Constraints: Has Default Value: BuiltinSSLValidationOnly, Legal Values: BuiltinSSLValidationOnly, BuiltinSSLValidationAndCertPathValidators
The string alias used to store and retrieve the outbound private key in the keystore. This private key is associated with either a server or a client digital certificate. This attribute value is derived from other settings and cannot be physically set.
The returned value is determined as follows:
If the isUseClientCertForOutbound returns true, the value from getClientCertAlias is returned.
Otherwise, the value from getServerPrivateKeyAlias is returned.
Type: string
Constraints: Read Only, Has Default Value: null
The passphrase used to retrieve the outbound private key from the keystore. This passphrase is assigned to the private key when it is generated. This attribute value is derived from other settings and cannot be physically set.
The returned value is determined as follows:
If the isUseClientCertForOutbound returns true, the value from getClientCertPrivateKeyPassPhrase is returned.
Otherwise, the value from getServerPrivateKeyPassPhrase is returned.
Type: string
Constraints: Read Only, Encrypted, Has Default Value: null
The string alias used to store and retrieve the server's private key in the keystore. This private key is associated with the server's digital certificate.
Type: string
Constraints: Has Default Value: null
The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated.
Type: string
Constraints: Restart Required, Encrypted
Return all tags on this Configuration MBean
Type: array of string
The form of SSL that should be used.
By default, WebLogic Server is configured to use one-way SSL (implied by the Client Certs Not Requested value). Selecting Client Certs Requested But Not Enforced enables two-way SSL. With this option, the server requests a certificate from the client, but the connection continues if the client does not present a certificate. Selecting Client Certs Requested And Enforced also enables two-way SSL and requires a client to present a certificate. However, if a certificate is not presented, the SSL connection is terminated.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: false
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Determines whether to use the configured client SSL certificate as identity for outbound SSL connections.
Note that to use a client SSL certificate, one must be specified in setClientCertAlias
Type: boolean
Constraints: Has Default Value: false
Sets whether the client should use the server certificates/key as the client identity when initiating an outbound connection over https.
Type: boolean
Constraints: Has Default Value: false
Controls the behavior of Secure Mode in the current WebLogic Server domain. Attributes control whether secure mode is enabled and control the validation that is performed during startup.
The properties of the weblogic.management.configuration.SecureModeMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Returns whether restrictive policies will be used for JMX authorization.
If secure mode is enabled and restrictive policies are enabled, then the default policies for JMX only allow MBean access to the standard WLS roles (Admin, Deployer, Operator, or Monitor).
Type: boolean
Constraints: Restart Required, Has Default Value: true
Returns whether the domain will run in secure mode.
In secure mode, the configuration defaults are those recommended for securing a domain. The authorization policies for JNDI and MBean access are more restrictive in secure mode. In addition, WLS will validate the domain configuration and log warnings and errors for any insecure settings.
Secure mode requires the domain to be in production mode.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Returns whether warnings should be logged if auditing not enabled.
If secure mode is enabled and warnings are enabled, then messages will be logged if auditing is not enabled.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Returns whether warnings should be logged if applications are secure.
If secure mode is enabled and warnings are enabled, then messages will be logged for insecure application elements.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Returns whether warnings should be logged if the File System is not secure.
If secure mode is enabled and warnings are enabled, then messages will be logged for insecure file system setting.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Returns whether warnings should be logged if the SSL configuration is not secure.
If secure mode is enabled and warnings are enabled, then messages will be logged for insecure SSL configuration settings.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Returns whether warnings should be logged if the Java Security Manager is not enabled.
If secure mode is enabled and warning is enabled, then a messages will be logged if the Java Security Manager is not enabled.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Provides domain-wide security configuration information.
The properties of the weblogic.management.configuration.SecurityConfigurationMBean entity are as follows:
Domain's administrative identity domain.
Type: string
Constraints: Restart Required
Returns true if allow access to credential in clear text. This can be overridden by the system property -Dweblogic.management.clearTextCredentialAccessEnabled
Type: boolean
Constraints: Has Default Value: false
Specifies whether this WebLogic Server domain enables compatiblity with previous connection filters.
This attribute changes the protocols names used when filtering needs to be performed.
Type: boolean
Constraints: Has Default Value: false
The name of the Java class that implements a connection filter (that is, the weblogic.security.net.ConnectionFilter interface). If no class name is specified, no connection filter will be used.
This attribute replaces the deprecated ConnectionFilter attribute on the SecurityMBean.
Type: string
Constraints: Has Default Value: null
The rules used by any connection filter that implements the ConnectionFilterRulesListener interface. When using the default implementation and when no rules are specified, all connections are accepted. The default implementation rules are in the format: target localAddress localPort action protocols
This attribute replaces the deprecated ConnectionFilterRules attribute on the SecurityMBean.
Type: array of string
Constraints: Has Default Value: null
Specifies whether this WebLogic Server domain should log accepted connections.
This attribute can be used by a system administrator to dynamically check the incoming connections in the log file to determine if filtering needs to be performed.
This attribute replaces the deprecated ConnectionLoggerEnabled attribute on the SecurityMBean.
Type: boolean
Constraints: Has Default Value: false
Indicates whether the console is enabled for fully delegate authorization.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The password for the domain. In WebLogic Server version 6.0, this attribute was the password of the system user. In WebLogic Server version 7.0, this attribute can be any string. For the two domains to interoperate, the string must be the same for both domains.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the UserPasswordEncrypted attribute to the encrypted value.
Type: string
Constraints: Restart Required, Encrypted
Indicates whether or not cross-domain security is enabled.
Type: boolean
Constraints: Has Default Value: false
Returns the default security realm or null if no realm has been selected as the default security realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Restart Required
Whether or not to downgrade to anonymous principals that cannot be verified. This is useful for server-server communication between untrusted domains.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Whether or not the system should enforce strict URL pattern or not.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Whether or not the system should allow requests with invalid Basic Authentication credentials to access unsecure resources.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies a list of remote domains for which cross-domain check should not be applied.
Type: array of string
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Returns true if all role mapping, authorization, credential mapping, and audit providers configured in the domain must support the IdentityDomainAwareProviderMBean interface's administrative identity domain.
Type: boolean
Constraints: Has Default Value: false
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
The password that the Administration Server uses to communicate with Node Manager when starting, stopping, or restarting Managed Servers.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the NodeManagerPasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the NodeManagerPasswordEncrypted attribute to the encrypted value.
Using this attribute (NodeManagerPassword) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, you should use NodeManagerPasswordEncrypted
Type: string
Constraints: Restart Required, Encrypted
The user name that the Administration Server uses to communicate with Node Manager when starting, stopping, or restarting Managed Servers.
Type: string
Constraints: Has Default Value:
Returns the value of the nonce timeout in seconds.
Type: int
Constraints: Has Default Value: 120, Minimum Value: 15
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.
Type: string
Specifies whether the WebLogic Server principal name is compared using a case insensitive match when the equals method for the principal object is performed.
If this attribute is enabled, matches are case insensitive.
Note: Note that principal comparison is not used by the WebLogic Security Service to determine access to protected resources. This attribute is intended for use with JAAS authorization, which may require case insensitive principal matching behavior.
Type: boolean
Constraints: Has Default Value: false
Specifies whether the GUID and DN data in a WebLogic Server principal object are used when the equals method of that object is invoked.
If enabled, the GUID and DN data (if included among the attributes in a WebLogic Server principal object) and the principal name are compared when this method is invoked.
Type: boolean
Constraints: Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Determines whether the Demo Identity and Demo Trust key stores should be obtained from the Oracle Key Store Service (KSS).
If enabled, Weblogic Server will request the Demo Identity and Domain Trust key stores from KSS. Subsequent to installation however, the KSS Demo key stores may have been manipulated such that appropriate Demo certificates or keys are not available.
Please verify the following KSS Demo Identity keystore has an X.509 private key and corresponding public identity certificate signed by the Demo Certificate Authority (CA):
system
demoidentity
DemoIdentity
Please verify the following KSS Domain Trust keystore has a trusted Demo Certificate Authority X.509 certificate:
system
trust
Type: boolean
Constraints: Restart Required, Has Default Value: false
This property defines the case sensitive URL-pattern matching behavior for security constraints, servlets, filters, virtual-hosts, and so on, in the Web application container and external security policies. Note: This is a Windows-only flag that is provided for backward compatibility when upgrading from pre-9.0 versions of WebLogic Server. On Unix platforms, setting this value to true causes undesired behavior and is not supported. When the value is set to os, the pattern matching will be case- sensitive on all platforms except the Windows file system. Note that on non-Windows file systems, WebLogic Server does not enforce case sensitivity and relies on the file system for optimization. As a result, if you have a Windows Samba mount from Unix or Mac OS that has been installed in case-insensitive mode, there is a chance of a security risk. If so, specify case-insensitive lookups by setting this attribute to true. Note also that this property is used to preserve backward compatibility on Windows file systems only. In prior releases, WebLogic Server was case- insensitive on Windows. As of WebLogic Server 9.0, URL-pattern matching is strictly enforced. During the upgrade of older domains, the value of this parameter is explicitly set to os by the upgrade plug-in to preserve backward compatibility.
Type: string
Constraints: Restart Required, Has Default Value: false, Legal Values: os, true, false
SelfTuning MBean contains the global work manager component MBeans.
The properties of the weblogic.management.configuration.SelfTuningMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
A desired percentage of thread usage by a partition compared to the thread usage by all partitions. It is recommended that the sum of this value for all the partitions running in a WLS domain add up to 100, but it is not strictly enforced. When they do not add up to 100, WLS assigns thread-usage times to different partitions based on their relative values. This attribute is for use in the global domain only. Use the PartitionWorkManager MBean for specifying partition fair share values for partitions.
Type: int
Constraints: Has Default Value: 50, Minimum Value: 1, Maximum Value: 99
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Defines the debug attributes that are specific to WebLogic Server.
While all attributes will be supported in adherence with the standard WebLogic Server deprecation policies, the resultant debug content is free to change in both form and content across releases.
The properties of the weblogic.management.configuration.ServerDebugMBean entity are as follows:
Debug Application Container deployment processing
Type: boolean
Constraints: Restart Required
Gets the fastswap ClassChangeNotifier debug attribute of ServerDebugMBean
Type: boolean
Constraints: Has Secure Value: false
Debug ClassFinder processing
Type: boolean
Constraints: Restart Required
Debug ClassLoader processing
Type: boolean
Detailed debug of ClassLoader processing
Type: boolean
Debug WebApp ClassLoader processing
Type: boolean
Debug ClassPathServlet processing
Type: boolean
Constraints: Restart Required
Debug abbreviations over JVM to JVM connections
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug AppContainer's scanning and processing of annotations
Type: boolean
Constraints: Has Secure Value: false
Debug Application Container processing
Type: boolean
Constraints: Has Secure Value: false
Debug async replication/persistence information.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug the BeanTree Harvester delegate metric control process.
Type: boolean
Debug the BeanTree Harvester delegate metric collection process.
Type: boolean
Debug the BeanTree Harvester delegate metric resolution process.
Type: boolean
Debug BeanTree Harvester delegate threading issues.
Type: boolean
Debugs Buzz protocol.
Type: boolean
Constraints: Has Default Value: false
Debugs Buzz protocol details.
Type: boolean
Constraints: Has Default Value: false
Debugs Buzz protocol http.
Type: boolean
Constraints: Has Default Value: false
Debug Security PKI X.509 certificate revocation checking
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Contextual Trace Debugger for Class Loading
Type: boolean
Verbose Debugger for Class Loading
Type: boolean
Gets the DebugClassRedef attribute of ServerDebugMBean
Type: boolean
Constraints: Has Secure Value: false
Gets the fastswap DebugClassSize debug attribute of ServerDebugMBean
Type: boolean
Constraints: Has Secure Value: false
Debug each GroupMessage that is sent or received by multicast.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug each Announcement, StateDump, and Attributes message that is sent or received by multicast.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug for each fragment that is sent or received by multicast.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug each cluster Heartbeat that is sent or received by multicast.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug concurrent general processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug concurrent context processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug concurrent MES processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug concurrent MSES processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug concurrent MTF processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug concurrent transaction processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug management configuration edit processing
Type: boolean
Debug management configuration runtime processing
Type: boolean
Debug JVM to JVM connections
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug connector service action processing
Type: boolean
Constraints: Has Default Value: false
Debug cluster consensus lease processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug each DGC enrollment.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug Data replication service (DRS) API calls.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug DRS Heartbeats.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug DRS Message traffic.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug DRS Queueing traffic.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug DRS State transitions.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug DRS Update status processing.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug deploy command processing
Type: boolean
Debug deployment processing
Type: boolean
Debug deployment concise processing
Type: boolean
Debug deployment plan processing
Type: boolean
Debug deployment service processing
Type: boolean
Debug internal deployment service processing
Type: boolean
Debug deployment service status update processing
Type: boolean
Debug deployment service transport processing
Type: boolean
Debug deployment service HTTP transport processing
Type: boolean
Debug descriptor framework processing
Type: boolean
Debug diagnostic accessor processing
Type: boolean
Debug diagnostic archive processing
Type: boolean
Debug diagnostic archive retirement processing
Type: boolean
Debug diagnostic collection processing
Type: boolean
Debug diagnostic context processing
Type: boolean
Debug data gathering processing
Type: boolean
Debug diagnostic file archive processing
Type: boolean
Debug diagnostic image processing
Type: boolean
Debug diagnostic instrumentation processing
Type: boolean
Debug instrumentation actions/monitors
Type: boolean
Debug instrumentation configuration processing
Type: boolean
Debug instrumentation event records
Type: boolean
Debug instrumentation weaving
Type: boolean
Debug instrumentation weaving for matches only
Type: boolean
Debug diagnostic jdbc archive processing
Type: boolean
Debug diagnostic lifecycle handler processing
Type: boolean
Debug diagnostic query processing
Type: boolean
Debug the WLDF runtime control MBeans.
Type: boolean
Debug the WLDF runtime control service.
Type: boolean
Debug diagnostic policy processing.
Type: boolean
Debug diagnostic policy events processing.
Type: boolean
Debug diagnostic policy event processing details.
Type: boolean
Debug diagnostic wlstore archive processing
Type: boolean
Debug the bean extensions ELResolver in the Diagnostics expressions framework
Type: boolean
Debug the custom BeanInfo providers for the Diagnostics expressions framework
Type: boolean
Debug the ELContext in the Diagnostics expressions framework
Type: boolean
Debug the DiagnosticsELResolver in the Diagnostics expressions framework
Type: boolean
Debug the Diagnostics expressions framework function mapper
Type: boolean
Debug the Diagnostics expressions framework functions
Type: boolean
Debug metrics collection for the Diagnostics expressions framework
Type: boolean
Debug metrics polling for the Diagnostics expressions framework
Type: boolean
Debug the Diagnostics expressions poller extract() buffers
Type: boolean
Debug diagnostic harvester processing
Type: boolean
Detailed debug of diagnostic harvester processing
This should be used in conjunction with DebugDiagnosticsHarvester.
Type: boolean
Debug MBean harvester processing.
This should probably be used in conjunction with DebugDiagnosticsHarvester.
Type: boolean
Debug tree bean harvester processing
Type: boolean
Debug the MBean ELResolver in the Diagnostics expressions framework
Type: boolean
Debug diagnostic module processing
Type: boolean
Debug the diagnostics policy script action.
Type: boolean
Debug the Diagnostics utils
Type: boolean
Debug the value tracing ELResolver in the Diagnostics expressions framework
Type: boolean
Debug Domain Log Handler processing
Type: boolean
Debug Dynamic Service Migration processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug EJB Caching
Type: boolean
Constraints: Has Secure Value: false
Debug EJB CMP deployment processing
Type: boolean
Constraints: Has Secure Value: false
Debug EJB CMP runtime processing
Type: boolean
Constraints: Has Secure Value: false
Debug EJB compilation
Type: boolean
Constraints: Has Secure Value: false
Debug EJB deployment
Type: boolean
Constraints: Has Secure Value: false
Debug EJB invocation processing
Type: boolean
Constraints: Has Secure Value: false
Debug EJB locking
Type: boolean
Constraints: Has Secure Value: false
Debug EJB MDB Connection processing
Type: boolean
Constraints: Has Secure Value: false
Debug EJB metadata processing
Type: boolean
Constraints: Has Secure Value: false
Debug EJB pooling
Type: boolean
Constraints: Has Secure Value: false
Debug EJB Security
Type: boolean
Constraints: Has Secure Value: false
Debug EJB Swapping
Type: boolean
Constraints: Has Secure Value: false
Debug EJB Timer processing
Type: boolean
Constraints: Has Secure Value: false
Debug the elastic actions framework
Type: boolean
Debug the elastic services framework
Type: boolean
Debug Embedded LDAP processing
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Debug Embedded LDAP processing (log level)
Type: int
Constraints: Restart Required, Has Secure Value: 0, Has Default Value: 0, Minimum Value: 0, Maximum Value: 11
Debug Embedded LDAP processing (output to console)
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Embedded LDAP Write All Overrides to Property Files
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Debug Event Manager processing
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug the Diagnostics expressions framework extension bean localizer
Type: boolean
Debug the Diagnostics expressions extensions manager
Type: boolean
Debug stub-level fail-over processing
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug the file distribution servlet that runs on the Admin Server and is invoked over HTTP by a booting managed server.
Type: boolean
Debug WebApp Container HTTP processing.
Type: boolean
Constraints: Has Secure Value: false
Debug WebApp Container for supplimentary HTTP processing.
Type: boolean
Constraints: Has Secure Value: false
Debug log manager in the webapp container.
Type: boolean
Constraints: Has Secure Value: false
Debug Http Session management in the webapp container.
Type: boolean
Constraints: Has Secure Value: false
Debug IIOP connection management processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug buffer-level IIOP processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug IIOP CosNaming processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug IIOP Object Transaction Service (OTS) processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug IIOP object replacement processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug IIOP security processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug IIOP startup processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug IIOP message processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug IIOP tunnelling
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug interceptors processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Java EE management processing
Type: boolean
JAXP debugging option: Debug level
Type: int
Constraints: Restart Required, Has Secure Value: 0, Has Default Value: 0, Minimum Value: 0, Maximum Value: 3
JAXP debugging option: Debug name
Type: string
Constraints: Restart Required, Has Secure Value: null, Has Default Value: null, Legal Null: true
JAXP debugging option: Debug IncludeClass
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
JAXP debugging option: Debug IncludeLocation
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
JAXP debugging option: Debug IncludeName
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
JAXP debugging option: Debug IncludeTime
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
JAXP debugging option: Debug UseShortClass
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
Debug JDBC Connection setup/teardown processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JDBC Internal processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug ONS client
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Oracle RAC processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JDBC RMI processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug REPLAY client
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JDBC SQL processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Oracle UCP processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMSBackEnd processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMS boot operations
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMS CDS processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMSCommon processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMSConfig processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMS Dispatcher processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMS Dispatcher Proxy
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMS Distributed Topic processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMSFrontEnd processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMS MessagePath processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMSModule deployment processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMS Pause/Resume processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMS SAF processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug DebugJMST3Server processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug the pooling and wrapping of JMS connections, sessions, and other objects. This feature is enabled when a JMS connection factory, from any vendor, is used inside an EJB or a servlet using the "resource-reference" element in the deployment descriptor.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JMX processing
Type: boolean
Debug JMX CompatibilityMBeanServer service processing
Type: boolean
Debug core JMX processing
Type: boolean
Debug core JMX connection processing
Type: boolean
Debug JMX domain service processing
Type: boolean
Debug JMX edit service processing
Type: boolean
Debug JMX runtime service processing
Type: boolean
Debug basic naming service machinery.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JNDI state and object factories.
Type: boolean
Constraints: Has Secure Value: false
Debug naming service name resolution.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA 2PC processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Detailed Debug of JTA 2PC processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA CDI log processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA imported transactions
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Detailed debug of JTA imported transactions
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA Health Monitoring
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA JDBC processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA Logging Last Resource
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA ServerLifecycle
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA TLOG Migration
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA naming
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Detailed debug of JTA naming
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA non-XA resources
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA transaction propagation
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA Recovery processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA resource health
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA Resource name filter
Type: string
Debug JTA transaction log processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JTA XA resources
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Detailed Debug of JTA XA processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA data cache
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA post-compilation
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA RDBMS JDBC interaction
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA RDBMS schema manipulation
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA RDBMS SQL interaction
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA management and monitoring
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA MetaData processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA profiling
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA Query processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA runtime diagnostics
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JPA tools
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug the cluster leader election messages.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug application library processing
Type: boolean
Constraints: Has Secure Value: false
Debug Lifecycle Manager
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug stub-level load-balancing processing
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug how is LocalRemoteJVM working.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug log configuration processing
Type: boolean
Debug the JMX Harvester delegate metric control process.
Type: boolean
Debug the JMX Harvester delegate metric collection process.
Type: boolean
Debug the JMX Harvester delegate metric resolution process.
Type: boolean
Debug JMX Harvester delegate threading issues.
Type: boolean
Debug the Harvester MBean registration queue events
Type: boolean
Debug the Harvester MBean registration prioritized events processing
Type: boolean
Debug the Harvester MBean registration processing
Type: boolean
Debug the Harvester MBean type utility
Type: boolean
Debug Management Services Resources
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Dye mask criteria used to determine whether debug will be emitted for a request. Specifies the names of the Dye flags that will be inspected at runtime to determine whether debug needs to be emitted for a request.
Type: array of string
Debug messages sent over JVM to JVM connections
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug Messaging Bridge runtime processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Detailed debug of Messaging Bridge runtime processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Messaging Bridge start up processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debugging for the messaging kernel. The messaging kernel is low- level messaging code that is used by the JMS and store and forward subsystems.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debugging for the messaging kernel as the server is being rebooted. This provides detailed information on every persistent message that is recovered.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debugging for the messaging kernel ownable lock. This provides detailed information on lock owners.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Muxer processing
Type: boolean
Constraints: Restart Required, Has Default Value: false
Debug Muxer connection processing
Type: boolean
Constraints: Restart Required, Has Default Value: false
Detailed debug for Muxer processing
Type: boolean
Constraints: Restart Required, Has Default Value: false
Debug Muxer exception processing
Type: boolean
Constraints: Restart Required, Has Default Value: false
Debug Muxer timeout processing
Type: boolean
Constraints: Restart Required, Has Default Value: false
Debug NodeManagerRuntime
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Parameters for debug logging defined as name value pairs. The parameters are prefixed with the name of the debug flag. The parameter names supported for a debug flag is specific to the implementation of the debug output.
Type: java.util.Properties
Constraints: Has Secure Value: null
Debug PartitionResourceMetricsRuntimeMBean operations.
Type: boolean
Debug management patching runtime processing
Type: boolean
Debug the Path Service
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Detailed debug for the Path Service
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Resource Adapter XA general/top-level processing
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter class loading
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter connection event processing
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter outbound connection operations (get, close, associate, disassociate, ping)
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter (un)deploy, security id settings
Type: boolean
Constraints: Has Default Value: false
Debug ResourceAdapter Lifecycle processing
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter local tx outgoing message processing
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter descriptor parsing
Type: boolean
Constraints: Has Default Value: false
Debug Java EE Resource Adapter pool management (size management) processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Resource Adapter operations on a connection pool (proxy testing)
Type: boolean
Constraints: Has Default Value: false
Debug setup of resource ref processing (container and application managed security set by calling application components)
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter Work submission and cancel processing
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter work event processing
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter XA incoming message processing
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter XA outgoing message processing
Type: boolean
Constraints: Has Default Value: false
Debug Resource Adapter XA Work request processing
Type: boolean
Constraints: Has Default Value: false
Debug RC4 cipher processing
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Debug RCM
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug the diagnostics policy REST action.
Type: boolean
Debug RSA security processing
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Debug ReadyApp processing.
Type: boolean
Constraints: Has Secure Value: false
Debug cluster replication information.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug low-level cluster replication information.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug cluster replication size information.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JAX-RS 1 / Jersey 1 Client integration
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug JAX-RS 2 / Jersey 2 integration
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug routing of messages over JVM to JVM connections
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug Messaging SAF Admin.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Messaging SAF Manager.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Messaging SAF ReceivingAgent.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Messaging SAF SendingAgent.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Messaging SAF Store.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Messaging SAF Transport.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Detailed debug of Messaging SAF.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug the SNMP agent framework.
Type: boolean
The debug attribute to enable or disable the SNMP Agent Extension Provider discovery and initialization.
Type: boolean
Debug the SNMP TCP protocol handler.
Type: boolean
Debug the SNMP vendor toolkit implementation.
Type: boolean
Debug SSL processing
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Debug Weblogic SCA Container
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework Adjudication processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security Framework Atn processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security Framework Atz processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security Framework Auditor processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security Framework CertPath processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security Framework Credential Mapper processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security Framework Entitlements Engine processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework Encryption Service processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security Framework JACC processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework JACC nonPolicy processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework JACC Policy processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework KeyStore processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security Password Guessing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework predicate processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Realm processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework Role Mapping
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security Framework SAML2 Provider atn processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework SAML2 Provider credential mapper processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework SAML2 library processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework SAML2 SSO profile services
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework SAML Provider atn processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework SAML Provider credential mapper processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework SAML library processing
Type: boolean
Constraints: Has Default Value: false
Debug Security Framework SAML SSO profile services
Type: boolean
Constraints: Has Default Value: false
Debug Security SSL and TLS processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security SSL and TLS exception processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Security Service
Type: boolean
Constraints: Has Default Value: false
Debug Security User Lockout processing
Type: boolean
Constraints: Has Default Value: false
Debug WorkManager self-tuning processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug Server ServerLifeCycle processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug low-level Server Migration processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
If statistics about server start will be logged after the running message.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug the persistent store's administration code. This will produce debug events when instances of the store are created and deleted, and when the server is booted.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug persistent store high-level logical operations, such as read, write, delete, and update. Multiple logical operations may occur in a single physical operation.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug persistent store logical boot operations (lists all recovered records).
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debugging for persistent store low-level physical operations which typically directly correspond to file or JDBC operations. Multiple logical operations may occur in a single physical operation.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Detailed debug for persistent store low-level physical operations which typically directly correspond to file or JDBC operations.
This will produce a great deal of debugging for every disk I/O performed by the store. Multiple logical operations may occur in a single physical operation.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug HTTP tunneling connection open/close processing.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug HTTP tunneling connection timed out processing.
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug URL resolution for incoming http requests
Type: boolean
Constraints: Has Secure Value: false
Debug Verbose RCM
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug low-level wan replication processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug WTC configuration processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug WTC corba execution
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug WTC gwt execution
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug WTC jatmi execution
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug WTC XATMI Message processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug WTC user data processing
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug WTC tBridge execution
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Debug identity assertion flow when identity assertion occurs in the webapp container.
Type: boolean
Constraints: Has Secure Value: false
Debug WebApp Module deployment callbacks
Type: boolean
Constraints: Has Secure Value: false
Debug webapp security
Type: boolean
Constraints: Has Secure Value: false
Debug Work context (out of band data propagation)
Type: boolean
Constraints: Restart Required, Has Secure Value: false
XMLEntityCache debugging option: Debug level
Type: int
Constraints: Restart Required, Has Secure Value: 0, Has Default Value: 0, Minimum Value: 0, Maximum Value: 3
XMLEntityCache debugging option: Debug name
Type: string
Constraints: Restart Required, Has Secure Value: null, Has Default Value: null, Legal Null: true
XMLEntityCache debugging option: Debug IncludeClass
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
XMLEntityCache debugging option: Debug IncludeLocation
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
XMLEntityCache debugging option: Debug IncludeName
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
XMLEntityCache debugging option: Debug IncludeTime
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
XMLEntityCache debugging option: Debug UseShortClass
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
XML Registry debugging option: Debug levels
Type: int
Constraints: Restart Required, Has Secure Value: 0, Has Default Value: 0, Minimum Value: 0, Maximum Value: 3
XML Registry debugging option: Debug name
Type: string
Constraints: Restart Required, Has Secure Value: null, Has Default Value: null, Legal Null: true
XML Registry debugging option: Debug IncludeClass
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
XML Registry debugging option: Debug IncludeLocation
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
XML Registry debugging option: Debug IncludeName
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
XML Registry debugging option: Debug IncludeTime
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
XML Registry debugging option: Debug UseShortClass
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
Gets the fastswap DefaultStore debug attribute of ServerDebugMBean
Type: boolean
Constraints: Has Secure Value: false
Specifies how context based debugging is enabled for the Server. The default behavior in the Off mode is that debug output is emitted for all requests.
The DiagnosticContextDebugMode works in conjunction with the DebugMaskCriterias specified in the And or Or modes. For context based debugging the WLDF Instrumentation needs to be enabled and DyeInjection monitor needs to be configured for the Server.
When the context debug mode is set to And mode, debug is emitted only for the requests that have all the bits in the WLDF dye vector set for the flags specified in the DebugMaskCriterias attribute.
When the context debug mode is set to Or mode, debug is emitted only for the requests that have any one of the bits in the WLDF dye vector set for the flags specified in the DebugMaskCriterias attribute.
Type: string
Constraints: Has Default Value: Off, Legal Values: Off, And, Or
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Force VM garbage collection on each DGC interval
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Debug listenThread processing
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug DGC with Statistics
Type: boolean
Constraints: Restart Required, Has Secure Value: false
Debug Master Deployer processing
Type: boolean
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Enables or disables whether Partition Administrators can enable Debug Logging for their respective Partitions.
Type: boolean
Constraints: Has Default Value: false
Gets the fastswap RedefiningClassLoader debug attribute of ServerDebugMBean
Type: boolean
Constraints: Has Secure Value: false
Returns the server for this bean
Type: weblogic.management.configuration.ServerMBean reference
Constraints: Restart Required
Debug Slave Deployer processing
Type: boolean
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Debug WebModule processing
Type: boolean
Constraints: Restart Required
Configuration to mark the server as failed when threads are stuck. A failed server in turn can be configured to shutdown or go into admin state.
The properties of the weblogic.management.configuration.ServerFailureTriggerMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The number of seconds that a thread must be continually working before this server diagnoses the thread as being stuck.
For example, if you set this to 600 seconds, WebLogic Server considers a thread to be "stuck" after 600 seconds of continuous use.
Type: int
Constraints: Restart Required, Has Default Value: 600, Minimum Value: 0, Maximum Value: 2147483647
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The number of stuck threads after which the server is transitioned into FAILED state. There are options in OverloadProtectionMBean to suspend and shutdown a FAILED server. By default, the server continues to run in FAILED state.
If the StuckThreadCount value is set to zero then the server never transitions into FAILED server irrespective of the number of stuck threads.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class represents a individual WebLogic Server. A WebLogic Server is a Java process that is a container for Java EE applications.
The properties of the weblogic.management.configuration.ServerMBean entity are as follows:
Specifies whether COM support is enabled on the regular (non-SSL) port. COM is not supported on the SSL port. (The remaining fields on this page are relevant only if you check this box.)
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
The number of idle periods allowed before the object is collected.
Type: int
Constraints: Restart Required, Has Default Value: 5
Specifies whether this server has IIOP support enabled for both the regular (non-SSL) and SSL ports.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The table name for this server's Logging Last Resource (LLR) database table(s). WebLogic Server creates the table(s) and then uses them during transaction processing for the LLR transaction optimization. This setting must be unique for each server. The default table name is WL_LLR_SERVERNAME
This setting only applies if this server hosts one or more LLR-enabled JDBC data sources.
The format for the tables that WebLogic Server creates is [[[catalog.]schema.]name.] Each "." in the table name is significant, and schema generally corresponds to username in many databases.
IMPORTANT: If this value is changed but the LLR table already exists in the database, you must preserve the existing table's data. Consequently, when changing the table name, the existing database table must be renamed by a database administrator to match the new configured table name. Otherwise, transaction records may be lost, resulting in heuristic failures that aren't logged.
IMPORTANT: Each server's table name must be unique. Multiple LLR-enabled data sources within the same server may share the same table, but multiple servers must not share the same table. If multiple same-named servers share a table, the behavior is undefined and it is likely that transactions will not recover properly after a crash, creating heuristic hazards.
Type: string
Constraints: Restart Required
The JDBC Login Timeout value. Specified value is passed into java.sql.DriverManager.setLoginTimeout(). Note that this DriverManager setting will impact *all* JDBC drivers loaded into this JVM. Feature is disabled by default.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0, Maximum Value: 300
Use this unmapped resource reference mode to specify the behavior of any resource reference to a Connection Factory when the resource reference does not directly specify a JNDI name by a lookup attribute, or by a mappedName attribute, or by a jndi-name in a descriptor file. If a JNDI name is specified, the resource reference either resolves to the specified object in the JNDI tree or generates a javax.naming.NameNotFoundException.
Following are the available unmapped resource reference modes:
FailSafe : In this mode, an application JMS connection factory resource reference that does not specify a JNDI name resolves to an object bound to the JNDI tree with the same name as the resource reference name if one can be found in JNDI tree. Otherwise, it throws a javax.naming.NameNotFoundException. A resource reference without a JNDI name never returns a Java EE 7 Default Connection Factory in this mode.
This mode yields pre-12.2.1 WebLogic Server behavior. This mode is Java EE compliant, but the Java EE 7 specification disallows it from being the default mode.
ReturnDefault : This policy is a Java EE compliant mode and it is the default mode. It complies with Java EE 7 while doing a best effort to try delivering FailSafe behavior when it is expected.
(a) If the resource reference name matches the local JNDI name of a configured foreign JMS provider mapping, then WebLogic Server returns the remote JNDI entry from the mapping if it can be resolved, or it throws a javax.naming.NameNotFoundException.
(b) If the resource reference does not match with a foreign JMS provider mapping, and if the resource reference name matches the name of an object that is already bound to the JNDI tree, WebLogic Server returns the JNDI tree object.
(c) If neither (a) nor (b) apply, then WebLogic Server returns "java:comp/DefaultJMSConnectionFactory". In addition, it adds an 'Info' message in the server log indicating that a special behavior has occurred. This log message will occur at most once per application per server boot.
Type: string
Constraints: Has Default Value: ReturnDefault, Legal Values: ReturnDefault, FailSafe
Specifies whether this server uses JMS default connection factories.
WebLogic Server provides the following JMS default connection factories:
weblogic.jms.ConnectionFactory
weblogic.jms.XAConnectionFactory An XA factory is required for JMS applications to use JTA user-transactions, but is not required for transacted sessions. All other preconfigured attributes for the default connection factories are set to the same default values as a user-defined connection factory. If the preconfigured settings of the default factories are appropriate for your application, you do not need to configure any additional factories for your application.
Note: When using the default connection factories, you have no control over targeting the WebLogic Server instances where the connection factory may be deployed. However, you can disable the default connection factories on a per-server basis. To deploy a connection factory on independent servers, on specific servers within a cluster, or on an entire cluster, you need to configure a connection factory and specify the appropriate server targets. The default Java EE 7 JMS Connection Factory, java:comp/DefaultJMSConnectionFactory, will be available even when the WebLogic JMS default connection factories are disabled.
Type: boolean
Constraints: Has Default Value: true
List of factories that create transportable objects.
Type: array of string
Constraints: Restart Required
Returns the timeout value to be used by NodeManagerRuntime when creating a a socket connection to the agent. Default set high as SSH agent may require a high connection establishment time.
Type: int
Constraints: Restart Required, Has Default Value: 180000, Minimum Value: 0
Specifies whether this server supports Tuxedo GIOP (TGIOP) requests. (Requires you to configure WebLogic Tuxedo Connector (WTC) for this server.)
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: true
The server's XML entity cache, which is used to configure the behavior of JAXP (Java API for XML Parsing).
Type: weblogic.management.configuration.XMLEntityCacheMBean reference
Constraints: Restart Required
The server's XML registry, which is used to configure the behavior of JAXP (Java API for XML Parsing).
Type: weblogic.management.configuration.XMLRegistryMBean reference
Constraints: Restart Required
The number of backlogged, new TCP connection requests that should be allowed for this server's regular and SSL ports.
Setting the backlog to may prevent this server from accepting any incoming connection on some operating systems.
Type: int
Constraints: Has Default Value: 300, Minimum Value: 0
Enables increased efficiency of the self-tuning thread pool by aligning it with the Exalogic processor architecture threading capabilities. Use only when configuring a WebLogic domain for Oracle Exalogic.
Enabling this attribute increases efficiency during I/O in environments with high network throughput.
Disabling this attribute allows the thread pool to self-tune to match the demand of the workload at the expense of longer ramp up time.
Type: boolean
Constraints: Restart Required
The number of seconds between reconnection attempts to the admin server. When the admin server fails the managed server will periodically try to connect back to it.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 2147483647
The secure administration port for the server. This port requires that you enable the domain's administration port and that SSL is configured and enabled.
By default, the server uses the administration port that is specified at the domain level. To override the domain-level administration port for the current server instance, set this server's administration port.
Type: int
Constraints: Has Secure Value: 7002, Minimum Value: 0, Maximum Value: 65535
Returns the protocol to be used for administrative connections when none is specified.
Type: string
Constraints: Restart Required, Legal Values: t3s, https, iiops, t3, http, iiop
Specifies whether self-tuning should allow shrinking of its priority based queue for pending requests after it has grown in size due to busy workload, and whether it should try to purge work requests that have already been picked up for processing due to minimum threads constraints before growing the queue. Setting this to true would help reduce memory footprint after the busy work period has ended, at the expense of the overhead of growing the request queue again at the next period of busy workload. It would also help to reduce the amount of memory allocated for the request queue, at the expense of the overhead required in purging already processed work requests from the queue.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies whether Node Manager can automatically restart this server and its services on another machine if the server fails.
Type: boolean
Constraints: Restart Required
Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.
Type: boolean
Constraints: Has Default Value: true
Buzz endpoint address.
Type: string
Constraints: Restart Required
Enables Buzz for sending/receiving messages with peers. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Buzz endpoint port.
A value of means system-allocated (dynamic) port.
Type: int
Constraints: Restart Required, Has Default Value: 0
Limits the list of candidate machines that the cluster specifies. (Requires you to enable this server for automatic migration and to configure the cluster with a set of candidate machines.)
If this server fails and if it is enabled for automatic migration, Node Manager automatically restarts it. By default, Node Manager restarts the server on any of the candidate machines that the cluster specifies (in order of preference that you configured in the cluster). To change the default, you use this server's list of candidate machines to create a subset of the cluster-wide candidates. You can also change the order of preference.
Type: array of weblogic.management.configuration.MachineMBean references
Constraints: Restart Required
The ClasspathServlet will serve any class file in the classpath and is registered by default in every Web application (including management). It does not need to be turned on for many applications though, and represents a security hole if unchecked.
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
Specifies whether the HttpClusterServlet proxies the client certificate in a special header.
By default (or if you specify false), the weblogic.xml deployment descriptor for each web application that is deployed on this server determines whether the web application trusts certificates sent from the proxy server plugin. By default (or if the deployment descriptor specifies false), users cannot log in to the web application from a proxy server plugin.
A value of true causes proxy-server plugins to pass identity certifications from clients to all web applications that are deployed on this server instance. A proxy-server plugin encodes each identify certification in the WL-Proxy-Client-Cert header and passes the header to WebLogic Server instances. A WebLogic Server instance takes the certificate information from the header, trusting that it came from a secure source, and uses that information to authenticate the user.
If you specify true, use a weblogic.security.net.ConnectionFilter to ensure that this WebLogic Server instance accepts connections only from the machine on which the proxy-server plugin is running. Specifying true without using a connection filter creates a security vulnerability because the WL-Proxy-Client-Cert header can be spoofed.
A cluster can also specify whether the HttpClusterServlet proxies the client certificate in a special header. The cluster-level setting overrides the setting in individual servers that are part of the cluster.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
The cluster, or group of WebLogic Server instances, to which this server belongs.
If set, the server will listen for cluster multicast events.
Type: weblogic.management.configuration.ClusterMBean reference
Constraints: Restart Required
The proportion of the load that this server will bear, relative to other servers in a cluster.
If all servers have the default weight or the same weight, each bears an equal proportion of the load. If one server has weight 50 and all other servers have weight 100, the 50-weight server will bear half as much load as any other server.
Type: int
Constraints: Restart Required, Has Default Value: 100, Minimum Value: 1, Maximum Value: 100
The system-level Coherence cluster resource associated with this server.
Type: weblogic.management.configuration.CoherenceClusterSystemResourceMBean reference
Constraints: Restart Required
The maximum number of seconds that this server waits for a complete message to be received. If you configure network channels for this server, each channel can override this message timeout.
This timeout helps guard against a denial of service attack in which a caller indicates that it will be sending a message of a certain size which it never finishes sending.
CompleteMessageTimeout affects the HTTP Response, such that if WebLogic Server discovers sockets inactive for longer than the CompleteMessageTimeout, the server will close these sockets.
Type: int
Constraints: Has Default Value: 60, Minimum Value: 0, Maximum Value: 480
The maximum number of seconds that this server waits for a complete HTTP response to be sent.
A value of disables the complete write timeout. The default value is derived from the CompleteHTTPMessageTimeout. If it is -1, then the CompleteMessageTimeout value is used for the default value.
Type: int
Constraints: Restart Required, Minimum Value: 0
The amount of time that this server should wait to establish an outbound socket connection before timing out. A value of disables server connect timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 240
The source of the identity keystore. For a JKS keystore, the source is the path and file name. For an Oracle Key Store Service (KSS) keystore, the source is the KSS URI.
If using a JKS keystore, the keystore path name must either be absolute or relative to where the server was booted.
If using a KSS keystore, the keystore URI must be of the form:
kss://system/keystorename
where keystorename is the name of the keystore registered in KSS.
The value in this attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
Type: string
Constraints: Has Default Value: null
The encrypted custom identity keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the CustomIdentityKeyStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the CustomIdentityKeyStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (CustomIdentityKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use CustomIdentityKeyStorePassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
The type of the keystore. Generally, this is JKS. If using the Oracle Key Store Service, this would be KSS
If empty or null, then the JDK's default keystore type (specified in java.security) is used. The custom identity key store type is only used if KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
Type: string
Constraints: Has Default Value: null
The source of the custom trust keystore. For a JKS keystore, the source is the path and file name. For an Oracle Key Store Service (KSS) keystore, the source is the KSS URI.
If using a JKS keystore, the keystore path name must either be absolute or relative to where the server was booted.
If using a KSS keystore, the keystore URI must be of the form:
kss://system/keystorename
where keystorename is the name of the keystore registered in KSS.
The value in this attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_CUSTOM_TRUST
Type: string
Constraints: Has Default Value: null
The custom trust keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_CUSTOM_TRUST.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the CustomTrustKeyStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the CustomTrustKeyStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (CustomTrustKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use CustomTrustKeyStorePassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
The type of the keystore. Generally, this is JKS. If using the Oracle Key Store Service, this would be KSS
If empty or null, then the JDK's default keystore type (specified in java.security) is used. This keystore type is only used if KeyStores is CUSTOM_IDENTITY_AND_CUSTOM_TRUST.
Type: string
Constraints: Has Default Value: null
The password for the default IIOP user. (Requires you to enable IIOP.)
As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the DefaultIIOPPasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
Using this attribute (DefaultIIOPPassword) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use DefaultIIOPPasswordEncrypted
Type: string
Constraints: Restart Required, Encrypted, Has Default Value: null
The user name of the default IIOP user. (Requires you to enable IIOP.)
Type: string
Constraints: Restart Required, Has Default Value: null
Specifies whether all default servlets in the servlet engine are disabled.
This includes: weblogic.servlet.ClasspathServlet weblogic.servlet.utils.iiop.GetIORServlet weblogic.rjvm.http.TunnelSendServlet weblogic.rjvm.http.TunnelRecvServlet weblogic.rjvm.http.TunnelLoginServlet weblogic.rjvm.http.TunnelCloseServlet If set to true, this property overrides the ClasspathServletDisabled property.
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
The protocol to use for connections when none is specified.
Type: string
Constraints: Restart Required, Has Default Value: t3, Legal Values: t3, t3s, http, https, iiop, iiops
The protocol to use for secure connections when none is specified.
Type: string
Constraints: Restart Required, Has Default Value: t3s, Legal Values: t3s, https, iiops
The password for the default user associated with the Tuxedo GIOP (TGIOP) protocol. (Requires you to configure WebLogic Tuxedo Connector (WTC) for this server.)
As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the DefaultTGIOPPasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the DefaultTGIOPPasswordEncrypted attribute to the encrypted value.
Using this attribute (DefaultTGIOPPassword) is a potential security risk in because the String object (which contains the unencrypted password) remains the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use DefaultTGIOPPasswordEncrypted
Type: string
Constraints: Restart Required, Encrypted
The default user associated with the Tuxedo GIOP (TGIOP) protocol. (Requires you to configure WebLogic Tuxedo Connector (WTC) for this server.)
Type: string
Constraints: Restart Required, Has Secure Value: null, Has Default Value: guest
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies whether to clean up all ThreadLocals storage from self-tuning thread pool threads after they have finished processing each work request. By default, the self-tuning thread pool only cleans up ThreadLocal storage in its threads after an application is undeployed to avoid ClassLoader memory leak.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The external IP address or DNS name for this server.
This address will be sent with HTTP session cookies and with dynamic server lists to HTTP proxies. It will also be used by external application clients to enable the propagation of RMI traffic through network address translating (NAT) firewalls.
You must specify an external DNS name for configurations in which a firewall is performing network address translation, unless clients are accessing WebLogic Server using t3 and the default channel. For example, define the external DNS name for configurations in which a firewall is performing network address translation, and clients are accessing WebLogic Server using HTTP via a proxy plug-in.
Type: string
Constraints: Restart Required, Has Default Value: null
The options passed to the EJB compiler during server-side generation.
Each EJB component can override the compiler options that you specify here. The following options are valid:
Forces generation of wrapper classes. Without this flag the classes may not be regenerated if it is determined to be unnecessary.
Generate ejb stub and skel as part of ejbc. Avoid HotCodeGen to have better performance.
Keep the generated .java files.
Java compiler to exec. If not specified, the -compilerclass option will be used.
Specifies the compiler class to invoke.
Compile debugging info into class file.
Passed through to Symantec's sj.
Classpath to use.
Source version.
Flags passed through to java runtime.
Type: string
Constraints: Restart Required, Has Default Value: null
The options passed to the RMIC compiler during server-side generation.
Each EJB component can override the compiler options that you specify here.
Type: string
Constraints: Restart Required, Has Default Value: null
Enables gathered writes over NIO socket channels. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Number of seconds a graceful shutdown operation waits before forcing a shut down. A graceful shutdown gives WebLogic Server subsystems time to complete certain application processing currently in progress. If subsystems are unable to complete processing within the number of seconds that you specify here, then the server will force shutdown automatically.
A value of means that the server will wait indefinitely for graceful shutdown to complete.
The graceful shutdown timeout applies only to graceful shutdown operations.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
The number of seconds that defines the frequency of this server's self-health monitoring. The server monitors the health of it's subsystems every HealthCheckIntervalSeconds and changes the Server's overall state if required.
Type: int
Constraints: Has Default Value: 180, Minimum Value: 1, Maximum Value: 2147483647
The number of seconds the Node Manager should wait before starting to monitor the server.
Type: int
Constraints: Has Default Value: 120, Minimum Value: 0, Maximum Value: 2147483647
Gets the hostsMigratableServices attribute of the ServerMBean object
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: true
Returns the HttpTraceSupportEnabled value
Type: boolean
Constraints: Restart Required, Has Default Value: false
Whether or not HTTP support is enabled on the regular port or SSL port.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The maximum number of seconds that a connection is allowed to be idle before it is closed by the server. The T3 and T3S protocols ignore this attribute. If you configure network channels for this server, each channel can override this idle connection message timeout.
This timeout helps guard against server deadlock through too many open connections.
Type: int
Constraints: Has Secure Value: 65, Has Default Value: 65, Minimum Value: 0
The number of idle periods until peer is considered unreachable.
Type: int
Constraints: Restart Required, Has Default Value: 4, Minimum Value: 4, Maximum Value: 65534
Indicates whether a graceful shutdown operation drops all HTTP sessions immediately.
If this is set to false, a graceful shutdown operation waits for HTTP sessions to complete or timeout.
Type: boolean
Constraints: Has Default Value: false
Specifies whether the server returns stack traces for RMI calls that generate exceptions.
With RMI stack tracking enabled, if a client issues an RMI call to a server subsystem or to a module running within the server, and if the subsystem or module generates an exception that includes a stack trace, the server will return the exception as well as the stack trace. With it disabled, the server will return the exception without the stack trace details.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: true
The IP address of the NIC that this server should use for multicast traffic.
Type: string
Constraints: Restart Required
The Java compiler to use for all applications hosted on this server that need to compile Java code.
Type: string
Constraints: Has Secure Value: javac, Has Default Value: javac
The options to append to the Java compiler classpath when compiling Java code.
Type: string
Constraints: Restart Required, Has Secure Value: null, Has Default Value: null
The options to prepend to the Java compiler classpath when compiling Java code.
Type: string
Constraints: Restart Required, Has Secure Value: null, Has Default Value: null
The password for the Java Standard Trust keystore. This password is defined when the keystore is created.
If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST or DEMO_IDENTITY_AND_DEMO_TRUST.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the JavaStandardTrustKeyStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the JavaStandardTrustKeyStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (JavaStandardTrustKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use JavaStandardTrustKeyStorePassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
Which configuration rules should be used for finding the server's identity and trust keystores?
Type: string
Constraints: Has Default Value: DemoIdentityAndDemoTrust, Legal Values: DemoIdentityAndDemoTrust, CustomIdentityAndJavaStandardTrust, CustomIdentityAndCustomTrust, CustomIdentityAndCommandLineTrust
The IP address or DNS name this server uses to listen for incoming connections. For example, enter 12.34.5.67 or mymachine, respectively.
Note that the value you specify for the listen address is not the URL to the host machine and it does not include the communication protocol, listen port, or channel.
Servers can be reached through the following URL:
protocol://listen-address:listen-port
Any network channel that you configure for this server can override this listen address.
If a server's listen address is undefined, clients can reach the server through an IP address of the computer that hosts the server, a DNS name that resolves to the host, or the localhost string. The localhost string can be used only for requests from clients that are running on the same computer as the server.
If you want to limit the valid addresses for a server instance, specify one of the following:
IP address. If you provide an IP address, clients can specify either the IP address or a DNS name that maps to the IP address. Clients that specify an IP address and attempt to connect through an SSL port must disable hostname verification.
DNS name. If you provide a DNS name, clients can specify either the DNS name or the corresponding IP address.
Do not leave the listen address undefined on a computer that uses multiple IP address (a multihomed computer). On such a computer, the server will bind to all available IP addresses.
Note also that if you are using the demo certificates in a multi-server domain, Managed Server instances will fail to boot if you specify the fully-qualified DNS name. For information about this limitation and suggested workarounds, see "Limitation on CertGen Usage" in Administering Security for Oracle WebLogic Server
Type: string
Constraints: Restart Required
The default TCP port that this server uses to listen for regular (non-SSL) incoming connections.
Administrators must have the right privileges before binding to a port or else this operation will not be successful and it will render the console un-reachable.
If this port is disabled, the SSL port must be enabled. Additional ports can be configured using network channels. The cluster (multicast) port is configured separately.
Type: int
Constraints: Has Default Value: 7001, Minimum Value: 1, Maximum Value: 65535
Specifies whether this server can be reached through the default plain-text (non-SSL) listen port.
If you disable this listen port, you must enable the default SSL listen port.
You can define additional listen ports for this server by configuring network channels.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: true
Returns the maximum time that the server will wait for server sockets to bind before starting a listen thread.
Properties to consider for removal
Type: int
Constraints: Restart Required, Has Default Value: 60
Determines whether the server should bind server sockets early.
Early binding detects port conflicts quickly and also gives user feedback on the default listen port as to the server state.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Specifies whether the server message log includes exceptions that are raised in remote systems.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: false
The login timeout for this server's default regular (non-SSL) listen port. This is the maximum amount of time allowed for a new connection to establish.
A value of indicates there is no maximum.
Type: int
Constraints: Has Secure Value: 5000, Has Default Value: 5000, Minimum Value: 0, Maximum Value: 100000
The WebLogic Server host computer (machine) on which this server is meant to run.
If you want to use Node Manager to start this server, you must assign the server to a machine and you must configure the machine for Node Manager.
You cannot change this value if a server instance is already running.
Type: weblogic.management.configuration.MachineMBean reference
Constraints: Restart Required
Specifies whether this Managed Server can be started when the Administration Server is unavailable.
In such a case, the Managed Server retrieves its configuration by reading a configuration file and other files directly.
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: true
The maximum number of running long-running requests that can be submitted to all the Managed Executor Services or Managed Scheduled Executor Services in the server.
Type: int
Constraints: Has Default Value: 100, Minimum Value: 0, Maximum Value: 65534
The maximum number of running threads that can be created by all the Managed Thread Factories in the server.
Type: int
Constraints: Has Default Value: 100, Minimum Value: 0, Maximum Value: 65534
The maximum number of bytes allowed in messages that are received over all supported protocols, unless overridden by a protocol-specific setting or a custom channel setting.
The order of precedence for setting message size maximums is as follows:
A channel-wide maximum in a custom network channel.
A protocol-specific setting in the default network channel.
See
getMaxCOMMessageSize() getMaxCOMMessageSize
getMaxHTTPMessageSize() getMaxHTTPMessageSize
getMaxIIOPMessageSize() getMaxIIOPessageSize
getMaxT3MessageSize() getMaxT3MessageSize
The message maximum in this attribute.
This maximum message size helps guard against a denial of service attack in which a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests.
A client can set this value using the -Dweblogic.MaxMessageSize property.
Type: int
Constraints: Has Secure Value: 10000000, Has Default Value: 10000000, Minimum Value: 4096, Maximum Value: 2000000000
The maximum number of open sockets allowed in server at a given point of time.
When the maximum threshold is reached, the server stops accepting new requests until the number of sockets drops below the threshold.
A value less than indicates an unlimited size.
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 2147483647
Indicates whether message IDs in logged messages will include a prefix. Message ids are 6 digit numeric strings that can be optionally presented in a log entry with a prefix. The prefix used by server messages is "BEA-".
Type: boolean
Constraints: Restart Required, Has Default Value: true
Non-blocking IO is enabled by default on the server side.
The default value is weblogic.socket.NIOSocketMuxer.
The Certicom SSL implementation is not supported with NIOSocketMuxer. If you need to secure internet communication, Oracle recommends enabling JSSE (Java Secure Socket Extension).
Type: string
Constraints: Restart Required
An alphanumeric name for this server instance. (Spaces are not valid.)
The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.
The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.
After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.
Type: string
Constraints: Read Only, Restart Required
Specifies whether native I/O is enabled for the server.
Type: boolean
Constraints: Restart Required, Has Default Value: true
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.
Type: string
Get the number of retries to contact admin server, before starting in Managed Server Independence Mode
Type: int
Constraints: Has Default Value: 3, Minimum Value: 0, Maximum Value: 65534
Specifies whether new server-to-server connections may consider the default server channel when initiating a connection. This is only relevant if the connection needs to be bound to the default listen address. This will only work for binary protocols that support both outbound and inbound traffic.
When this feature is not enabled, connections are initiated using a local address selected by the underlying hardware. For the default channel this is usually what is wanted for IP-routing to be effective. Note that since the default is false, other outbound channels will be considered in preference to the default channel.
Default administration channels, created when the domain-wide administration port is turned on, are always considered and bound when initiating an administrative connection. To allow IP-routing for administration traffic create custom admin with NetworkAccessPointMBean#isOutboundEnabled isOutboundEnabled set to false instead of enabling the domain-wide ADMIN port.
Type: boolean
Constraints: Has Default Value: false
Specifies whether the SSL identity specified by SSLMBean#getServerPrivateKeyAlias() getSSLMBean#ServerPrivateKeyAlias for this server should be used for outbound SSL connections on the default server channel. In normal circumstances the outbound identity is determined by the caller's environment.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
The time interval in milliseconds of the heartbeat period. A value of 0 indicates that heartbeats are turned off.
Type: int
Constraints: Restart Required, Has Default Value: 60000, Minimum Value: 0
Defines secondary clustered instances considered for hosting replicas of the primary HTTP session states created on the server.
Type: string
Constraints: Restart Required
Specifies whether the server message log includes exception stack trace that are raised in remote systems.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
The reliable delivery policy for web services.
Type: weblogic.management.configuration.WSReliableDeliveryPolicyMBean reference
Constraints: Restart Required
Defines preferred clustered instances considered for hosting replicas of the primary HTTP session states created on the server.
Type: string
Constraints: Restart Required
When WLS is running on Exalogic machines, cluster replication traffic could go over multiple replication channels. However multiple replication channels need not be configured on each clustered server instance. Only one replication channel with explicit IP-Address needs to be configured for each server and replicationPorts range can be specified for each server. For eg. range 7001-7010 will create 10 replication channels with ports 7001 to 7010 for the given server. These channels inherits all the properties of the configured replication channel except the listen port.Names of these channels will be derived from the configured replication channel with suffic {x} added where x could be 1,2.. as per the number of ports specified. Public ports are same as the listen port for these additional channels.
Type: string
Constraints: Restart Required
Resolve the listen address to use for all T3 communication
Type: boolean
Constraints: Restart Required, Has Default Value: false
The number of seconds the Node Manager should wait before restarting this server.
After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails.
If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.
Type: int
Constraints: Has Default Value: 3600, Minimum Value: 300, Maximum Value: 2147483647
The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.
Type: int
Constraints: Has Default Value: 2, Minimum Value: 0, Maximum Value: 2147483647
Get the number of seconds between the retries to contact admin server, before starting in Managed Server Independence Mode
Type: int
Constraints: Has Default Value: 5, Minimum Value: 1, Maximum Value: 65534
Specifies whether the kernel is allowed to perform reverse DNS lookups.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Enables scattered reads over NIO socket channels. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Number of seconds a force shutdown operation waits before timing out and killing itself. If the operation does not complete within the configured timeout seconds, the server will shutdown automatically if the state of the server at that time was SHUTTING_DOWN
A value of means that the server will wait indefinitely for life cycle operation to complete.
Type: int
Constraints: Has Secure Value: 120, Has Default Value: 30, Has Production Mode Default Value: 120, Minimum Value: 0
The template used to configure this server.
Type: weblogic.management.configuration.ServerTemplateMBean reference
Constraints: Restart Required
Specifies whether the server's buffer size for sending or receiving data through a raw socket should be set to 4KB.
Otherwise, the server does not impose a limit to the buffer size and defers to the operating system. This option is useful only on some operating systems for improving performance. It should be disabled in most environments.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The number of socket reader threads.
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 65534
The directory path on the Managed Server where all staged (prepared) applications are placed.
If an absolute directory name is not specified, the path is relative to the root directory "/". Once configured, you cannot change the staging directory name. Remove all applications from the server prior to changing this attribute. The default staging directory is "stage", relative to the server root.
Type: string
Constraints: Restart Required
The mode that specifies whether an application's files are copied from a source on the Administration Server to the Managed Server's staging area during application preparation.
During application preparation, the application's files are copied from the source on the Administration Server to the Managed Server's staging area. If you specify nostage or external_stage, the copy will not occur. This is useful when the staging area is a shared directory, already containing the application files, or if this is a single server domain. The administrator must ensure that the Managed Server's staging directory is set appropriately. Deployment errors will result if the application is not available during the preparation or activation of the application. Each application can override the staging mode specified here.
Type: string
Constraints: Restart Required, Legal Values: stage, nostage, external_stage
The state in which this server should be started. If you specify STANDBY, you must also enable the domain-wide administration port.
In the RUNNING state, a server offers its services to clients and can operate as a full member of a cluster. In the ADMIN state, the server is up and running, but available only for administration operations, allowing you to perform server and application-level administration tasks without risk to running applications. In the STANDBY state, a server instance does not process any request; its regular Listen Port is closed. The Administration Port is open. It only accepts life cycle commands that transition the server instance to either the RUNNING or the SHUTDOWN state. Other Administration requests are not accepted. A STANDBY server's only purpose is to resume into the RUNNING state quickly; it saves server startup time.
Type: string
Constraints: Has Default Value: RUNNING
Timeout value for server start and resume operations. If the server fails to start in the timeout period, it will force shutdown.
A value of means that the server will wait indefinitely for the operation to complete.
Type: int
Constraints: Restart Required, Has Default Value: 0, Has Production Mode Default Value: 0, Minimum Value: 0
The number of seconds after which WebLogic Server periodically scans threads to see if they have been continually working for the configured maximum length of time.
Type: int
Constraints: Restart Required, Has Default Value: 60, Minimum Value: 0, Maximum Value: 2147483647
Return all tags on this Configuration MBean
Type: array of string
The percentage of execute threads from the default queue that can be used as socket readers.
Type: int
Constraints: Has Default Value: 33, Minimum Value: 1, Maximum Value: 99
The path prefix for the server's JTA transaction log files. If the pathname is not absolute, the path is assumed to be relative to the server's root directory.
For a clustered server, if you plan to be able to migrate the Transaction Recovery Service from this server if it fails to another server (backup server) in the same cluster, you must store transaction log files on persistent storage, such as a Storage Area Network (SAN) device or a dual-ported disk, available to both servers.
Do not use an NFS file system to store transaction log files. Because of the caching scheme in NFS, transaction log files on disk may not always be current. Using transaction log files stored on an NFS device for recovery may cause data corruption.
Type: string
Constraints: Restart Required, Has Default Value: ./
The policy that determines how transaction log file entries are written to disk. This policy can affect transaction performance. (Note: To be transactionally safe, the Direct-Write policy may require additional OS or environment changes on some Windows systems.)
WebLogic Server supports the following policies:
Cache-Flush. Flushes operating system and on-disk caches after each write.
Direct-Write. Tells the operating system to write directly to disk with each write. Direct-Write performs better than Cache-Flush.
If Direct-Write is not supported on the host platform, the policy becomes Cache-Flush and a log message is printed.
Note: On Windows, the "Direct-Write" policy may leave transaction data in the on-disk cache without writing it to disk immediately. This is not transactionally safe because a power failure can cause loss of on-disk cache data. For transactionally safe writes using "Direct-Write" on Windows, either disable all write caching for the disk (enabled by default), or use a disk with a battery-backed cache.
The on-disk cache for a hard-drive on Windows can be disabled through system administration: Control-Panel -> System -> Hardware-tab -> Device-Manager-button -> Disk-Drives -> name-of-drive -> Policies-tab -> "Enable write caching on the disk" check-box. Some file systems do not allow this value to be changed. For example, a RAID system that has a reliable cache.
Type: string
Constraints: Restart Required, Has Default Value: Direct-Write, Legal Values: Cache-Flush, Direct-Write, Legal Null: true
The interval (in seconds) at which to ping a tunneled client to see if it is still alive.
If you create network channels for this server, each channel can override this setting.
Type: int
Constraints: Has Default Value: 45, Minimum Value: 1
The amount of time (in seconds) after which a missing tunneled client is considered dead.
If you create network channels for this server, each channel can override this setting.
Type: int
Constraints: Has Default Value: 40, Minimum Value: 1
Specifies whether tunneling for the T3, T3S, HTTP, HTTPS, IIOP, and IIOPS protocols should be enabled for this server.
If you create network channels for this server, each channel can override this setting.
Type: boolean
Constraints: Has Default Value: false
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The directory path on the Administration Server where all uploaded applications are placed.
If an absolute directory name is not specified, the path is relative to the root directory "/". The default staging directory is "stage", relative to the server root. On the Managed Server this returns null, and is not configurable.
Type: string
Constraints: Has Secure Value: An absolute directory that is outside the root directory of any WebLogic Server instance or application, and that resides on a physical disk that is separate from the WebLogic Server host's system disk.
Backward compatibility mode to switch to 8.1 execute queues instead of WorkManagers. Each of the WorkManagers is converted to an individual execute queue. Setting this attribute requires a server restart.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Reduces lock contention by using concurrent buffer queue to park incoming requests. Enabling this attribute increases throughput as requests are scheduled without acquiring any locks.
Type: boolean
Constraints: Restart Required
Specifies whether to includes detailed information in self-tuning thread pool thread names. Setting this flag as true would include additional information, such as the name of the Work Manager for which the execute thread is executing the task, but at the expense of overhead in keeping the thread name updated with such information.
Type: boolean
Constraints: Has Default Value: false
Specifies whether self-tuning should use the enhanced IncrementAdvisor implementation that uses a different algorithm to adjust the size of the self-tuning thread pool.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Reduces lock contention by using the enhanced ConcurrentCalendarQueue as the priority based queue for pending requests that are waiting for a thread.
This attribute should be enabled only in an Oracle Exalogic environment.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Enables the use of the ADM_DDL store procedure for LLR. The default value is false (not enabled).
When enabled, a WLS_ prefix and _DYD suffix is is automatically added to the LLR table name at runtime so the LLR table name in server configuration is not consistent with the actual table name in database.
Type: boolean
Constraints: Restart Required
Specifies whether this server uses the proprietary WL-Proxy-Client-IP header.
Set this attribute to true to specify that this server instance uses the proprietary WL-Proxy-Client-IP header, which is recommended if the server instance will receive requests from a proxy plug-in. If the server instance is a member of a cluster that will receive proxied requests, enable the WebLogic plug-in at the cluster level. For servers that are members of a cluster, the setting at the cluster level overrides the server's setting. When the WebLogic plug-in is enabled at the cluster level, a call to getRemoteAddr will return the address of the browser client from the proprietary WL-Proxy-Client-IP header instead of the Web server.
Set this attrbute to false to disable the weblogic-plugin-enabled parameter, weblogic-plugin-enabled=false, in the config.xml file.
Note: If you are using Oracle HTTP Server, the WebLogic Proxy Plug-In, or Oracle Traffic Director to distribute client requests to a Managed Server or a cluster, Oracle recommends setting this attribute to true
Type: boolean
Constraints: Restart Required, Has Default Value: false
This bean is used to configure the attributes necessary to start up a server on a remote machine.
The properties of the weblogic.management.configuration.ServerStartMBean entity are as follows:
The MWHome directory (path on the machine running Node Manager) to use when starting this server.
Specify the directory on the Node Manager machine under which all of Oracle's Middleware products were installed. For example, c:\bea
This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.MWHome property.
Node Manager does not pass this value to start scripts. It does specify -Dbea.home when invoking a Java command line to start the server.
Type: string
The arguments to use when starting this server.
These are the first arguments appended immediately after java portion of the startup command. For example, you can set Java heap memory or specify any weblogic.Server option.
This property should not be used to specify weblogic.management.username or weblogic.management.password as these values will be ignored during server startup. Instead the username and password properties should be set. This will also enable Node Manager to properly encrypt these values on the Managed Server's machine.
Separate arguments with a space.
This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.Arguments property. Node Manager will pass this value to a start script using the JAVA_OPTIONS environment variable. When issuing a Java command line to start the server, Node Manager will pass the arguments as options.
Type: string
The classpath (path on the machine running Node Manager) to use when starting this server.
At a minimum you will need to specify the following values for the class path option: WL_HOME/server/lib/weblogic_sp.jar;WL_HOME/server/lib/weblogic.jar
where WL_HOME is the directory in which you installed WebLogic Server on the Node Manager machine.
The shell environment determines which character you use to separate path elements. On Windows, you typically use a semicolon (;). In a BASH shell, you typically use a colon (:).
This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.ClassPath property. Node Manager will pass this value to a start script using the CLASSPATH environment variable. When issuing a Java command line to start the server, Node Manager will pass -Djava.class.path.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The Java home directory (path on the machine running Node Manager) to use when starting this server.
Specify the parent directory of the JDK's bin directory. For example, c:\bea\jdk141
This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.JavaHome or property.
Node Manager will pass this value to a start script using the JAVA_HOME environment variable. When issuing a Java command line to start the server, Node Manager will use the Java executable from the specified location.
Type: string
The Java Vendor value to use when starting this server.
If the server is part of a cluster and configured for automatic migration across possibly different platforms with different vendors providing the JDKs, then, both JavaVendor and JavaHome should be set in the generated configuration file instead.
This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.JavaVendor property.
Node Manager does not pass this value invoking a Java command line to start the server. It does pass this value in the environment variable JAVA_VENDOR to the start script.
Type: string
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
Type: string
Constraints: Read Only, Legal Null: true
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.
Type: string
The password of the username used to boot the server and perform server health monitoring.
As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the PasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the PasswordEncrypted attribute to the encrypted value.
Using this attribute (Password) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use PasswordEncrypted
Type: string
Constraints: Encrypted
The directory that this server uses as its root directory. This directory must be on the computer that hosts Node Manager. If you do not specify a Root Directory value, the domain directory is used by default.
Type: string
The security policy file (directory and filename on the machine running Node Manager) to use when starting this server.
This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.SecurityPolicyFile property .
When Node Manager is using a start script, the security policy file will be defined in an environment variable, SECURITY_POLICY. Additionally, when Node Manager is launching the process directly using a Java command, the security policy file will be defined with -Djava.security.policy=
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The user name to use when booting this server.
The Administration Console inserts the user name that you supplied when you logged in to the console. The Domain Configuration Wizard inserts the user name that you defined when you created the domain.
Type: string
Constraints: Has Default Value:
This class represents a WebLogic Server. A WebLogic Server is a Java process that is a container for Java EE applications.
The properties of the weblogic.management.configuration.ServerTemplateMBean entity are as follows:
Specifies whether COM support is enabled on the regular (non-SSL) port. COM is not supported on the SSL port. (The remaining fields on this page are relevant only if you check this box.)
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
The number of idle periods allowed before the object is collected.
Type: int
Constraints: Restart Required, Has Default Value: 5
Specifies whether this server has IIOP support enabled for both the regular (non-SSL) and SSL ports.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The table name for this server's Logging Last Resource (LLR) database table(s). WebLogic Server creates the table(s) and then uses them during transaction processing for the LLR transaction optimization. This setting must be unique for each server. The default table name is WL_LLR_SERVERNAME
This setting only applies if this server hosts one or more LLR-enabled JDBC data sources.
The format for the tables that WebLogic Server creates is [[[catalog.]schema.]name.] Each "." in the table name is significant, and schema generally corresponds to username in many databases.
IMPORTANT: If this value is changed but the LLR table already exists in the database, you must preserve the existing table's data. Consequently, when changing the table name, the existing database table must be renamed by a database administrator to match the new configured table name. Otherwise, transaction records may be lost, resulting in heuristic failures that aren't logged.
IMPORTANT: Each server's table name must be unique. Multiple LLR-enabled data sources within the same server may share the same table, but multiple servers must not share the same table. If multiple same-named servers share a table, the behavior is undefined and it is likely that transactions will not recover properly after a crash, creating heuristic hazards.
Type: string
Constraints: Restart Required
The JDBC Login Timeout value. Specified value is passed into java.sql.DriverManager.setLoginTimeout(). Note that this DriverManager setting will impact *all* JDBC drivers loaded into this JVM. Feature is disabled by default.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0, Maximum Value: 300
Use this unmapped resource reference mode to specify the behavior of any resource reference to a Connection Factory when the resource reference does not directly specify a JNDI name by a lookup attribute, or by a mappedName attribute, or by a jndi-name in a descriptor file. If a JNDI name is specified, the resource reference either resolves to the specified object in the JNDI tree or generates a javax.naming.NameNotFoundException.
Following are the available unmapped resource reference modes:
FailSafe : In this mode, an application JMS connection factory resource reference that does not specify a JNDI name resolves to an object bound to the JNDI tree with the same name as the resource reference name if one can be found in JNDI tree. Otherwise, it throws a javax.naming.NameNotFoundException. A resource reference without a JNDI name never returns a Java EE 7 Default Connection Factory in this mode.
This mode yields pre-12.2.1 WebLogic Server behavior. This mode is Java EE compliant, but the Java EE 7 specification disallows it from being the default mode.
ReturnDefault : This policy is a Java EE compliant mode and it is the default mode. It complies with Java EE 7 while doing a best effort to try delivering FailSafe behavior when it is expected.
(a) If the resource reference name matches the local JNDI name of a configured foreign JMS provider mapping, then WebLogic Server returns the remote JNDI entry from the mapping if it can be resolved, or it throws a javax.naming.NameNotFoundException.
(b) If the resource reference does not match with a foreign JMS provider mapping, and if the resource reference name matches the name of an object that is already bound to the JNDI tree, WebLogic Server returns the JNDI tree object.
(c) If neither (a) nor (b) apply, then WebLogic Server returns "java:comp/DefaultJMSConnectionFactory". In addition, it adds an 'Info' message in the server log indicating that a special behavior has occurred. This log message will occur at most once per application per server boot.
Type: string
Constraints: Has Default Value: ReturnDefault, Legal Values: ReturnDefault, FailSafe
Specifies whether this server uses JMS default connection factories.
WebLogic Server provides the following JMS default connection factories:
weblogic.jms.ConnectionFactory
weblogic.jms.XAConnectionFactory An XA factory is required for JMS applications to use JTA user-transactions, but is not required for transacted sessions. All other preconfigured attributes for the default connection factories are set to the same default values as a user-defined connection factory. If the preconfigured settings of the default factories are appropriate for your application, you do not need to configure any additional factories for your application.
Note: When using the default connection factories, you have no control over targeting the WebLogic Server instances where the connection factory may be deployed. However, you can disable the default connection factories on a per-server basis. To deploy a connection factory on independent servers, on specific servers within a cluster, or on an entire cluster, you need to configure a connection factory and specify the appropriate server targets. The default Java EE 7 JMS Connection Factory, java:comp/DefaultJMSConnectionFactory, will be available even when the WebLogic JMS default connection factories are disabled.
Type: boolean
Constraints: Has Default Value: true
List of factories that create transportable objects.
Type: array of string
Constraints: Restart Required
Returns the timeout value to be used by NodeManagerRuntime when creating a a socket connection to the agent. Default set high as SSH agent may require a high connection establishment time.
Type: int
Constraints: Restart Required, Has Default Value: 180000, Minimum Value: 0
Specifies whether this server supports Tuxedo GIOP (TGIOP) requests. (Requires you to configure WebLogic Tuxedo Connector (WTC) for this server.)
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: true
The server's XML entity cache, which is used to configure the behavior of JAXP (Java API for XML Parsing).
Type: weblogic.management.configuration.XMLEntityCacheMBean reference
Constraints: Restart Required
The server's XML registry, which is used to configure the behavior of JAXP (Java API for XML Parsing).
Type: weblogic.management.configuration.XMLRegistryMBean reference
Constraints: Restart Required
The number of backlogged, new TCP connection requests that should be allowed for this server's regular and SSL ports.
Setting the backlog to may prevent this server from accepting any incoming connection on some operating systems.
Type: int
Constraints: Has Default Value: 300, Minimum Value: 0
Enables increased efficiency of the self-tuning thread pool by aligning it with the Exalogic processor architecture threading capabilities. Use only when configuring a WebLogic domain for Oracle Exalogic.
Enabling this attribute increases efficiency during I/O in environments with high network throughput.
Disabling this attribute allows the thread pool to self-tune to match the demand of the workload at the expense of longer ramp up time.
Type: boolean
Constraints: Restart Required
The number of seconds between reconnection attempts to the admin server. When the admin server fails the managed server will periodically try to connect back to it.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 2147483647
The secure administration port for the server. This port requires that you enable the domain's administration port and that SSL is configured and enabled.
By default, the server uses the administration port that is specified at the domain level. To override the domain-level administration port for the current server instance, set this server's administration port.
Type: int
Constraints: Has Secure Value: 7002, Minimum Value: 0, Maximum Value: 65535
Returns the protocol to be used for administrative connections when none is specified.
Type: string
Constraints: Restart Required, Legal Values: t3s, https, iiops, t3, http, iiop
Specifies whether self-tuning should allow shrinking of its priority based queue for pending requests after it has grown in size due to busy workload, and whether it should try to purge work requests that have already been picked up for processing due to minimum threads constraints before growing the queue. Setting this to true would help reduce memory footprint after the busy work period has ended, at the expense of the overhead of growing the request queue again at the next period of busy workload. It would also help to reduce the amount of memory allocated for the request queue, at the expense of the overhead required in purging already processed work requests from the queue.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies whether Node Manager can automatically restart this server and its services on another machine if the server fails.
Type: boolean
Constraints: Restart Required
Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.
Type: boolean
Constraints: Has Default Value: true
Buzz endpoint address.
Type: string
Constraints: Restart Required
Enables Buzz for sending/receiving messages with peers. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Buzz endpoint port.
A value of means system-allocated (dynamic) port.
Type: int
Constraints: Restart Required, Has Default Value: 0
Limits the list of candidate machines that the cluster specifies. (Requires you to enable this server for automatic migration and to configure the cluster with a set of candidate machines.)
If this server fails and if it is enabled for automatic migration, Node Manager automatically restarts it. By default, Node Manager restarts the server on any of the candidate machines that the cluster specifies (in order of preference that you configured in the cluster). To change the default, you use this server's list of candidate machines to create a subset of the cluster-wide candidates. You can also change the order of preference.
Type: array of weblogic.management.configuration.MachineMBean references
Constraints: Restart Required
The ClasspathServlet will serve any class file in the classpath and is registered by default in every Web application (including management). It does not need to be turned on for many applications though, and represents a security hole if unchecked.
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
Specifies whether the HttpClusterServlet proxies the client certificate in a special header.
By default (or if you specify false), the weblogic.xml deployment descriptor for each web application that is deployed on this server determines whether the web application trusts certificates sent from the proxy server plugin. By default (or if the deployment descriptor specifies false), users cannot log in to the web application from a proxy server plugin.
A value of true causes proxy-server plugins to pass identity certifications from clients to all web applications that are deployed on this server instance. A proxy-server plugin encodes each identify certification in the WL-Proxy-Client-Cert header and passes the header to WebLogic Server instances. A WebLogic Server instance takes the certificate information from the header, trusting that it came from a secure source, and uses that information to authenticate the user.
If you specify true, use a weblogic.security.net.ConnectionFilter to ensure that this WebLogic Server instance accepts connections only from the machine on which the proxy-server plugin is running. Specifying true without using a connection filter creates a security vulnerability because the WL-Proxy-Client-Cert header can be spoofed.
A cluster can also specify whether the HttpClusterServlet proxies the client certificate in a special header. The cluster-level setting overrides the setting in individual servers that are part of the cluster.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
The cluster, or group of WebLogic Server instances, to which this server belongs.
If set, the server will listen for cluster multicast events.
Type: weblogic.management.configuration.ClusterMBean reference
Constraints: Restart Required
The proportion of the load that this server will bear, relative to other servers in a cluster.
If all servers have the default weight or the same weight, each bears an equal proportion of the load. If one server has weight 50 and all other servers have weight 100, the 50-weight server will bear half as much load as any other server.
Type: int
Constraints: Restart Required, Has Default Value: 100, Minimum Value: 1, Maximum Value: 100
The system-level Coherence cluster resource associated with this server.
Type: weblogic.management.configuration.CoherenceClusterSystemResourceMBean reference
Constraints: Restart Required
The maximum number of seconds that this server waits for a complete message to be received. If you configure network channels for this server, each channel can override this message timeout.
This timeout helps guard against a denial of service attack in which a caller indicates that it will be sending a message of a certain size which it never finishes sending.
CompleteMessageTimeout affects the HTTP Response, such that if WebLogic Server discovers sockets inactive for longer than the CompleteMessageTimeout, the server will close these sockets.
Type: int
Constraints: Has Default Value: 60, Minimum Value: 0, Maximum Value: 480
The maximum number of seconds that this server waits for a complete HTTP response to be sent.
A value of disables the complete write timeout. The default value is derived from the CompleteHTTPMessageTimeout. If it is -1, then the CompleteMessageTimeout value is used for the default value.
Type: int
Constraints: Restart Required, Minimum Value: 0
The amount of time that this server should wait to establish an outbound socket connection before timing out. A value of disables server connect timeout.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 240
The source of the identity keystore. For a JKS keystore, the source is the path and file name. For an Oracle Key Store Service (KSS) keystore, the source is the KSS URI.
If using a JKS keystore, the keystore path name must either be absolute or relative to where the server was booted.
If using a KSS keystore, the keystore URI must be of the form:
kss://system/keystorename
where keystorename is the name of the keystore registered in KSS.
The value in this attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
Type: string
Constraints: Has Default Value: null
The encrypted custom identity keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the CustomIdentityKeyStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the CustomIdentityKeyStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (CustomIdentityKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use CustomIdentityKeyStorePassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
The type of the keystore. Generally, this is JKS. If using the Oracle Key Store Service, this would be KSS
If empty or null, then the JDK's default keystore type (specified in java.security) is used. The custom identity key store type is only used if KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
Type: string
Constraints: Has Default Value: null
The source of the custom trust keystore. For a JKS keystore, the source is the path and file name. For an Oracle Key Store Service (KSS) keystore, the source is the KSS URI.
If using a JKS keystore, the keystore path name must either be absolute or relative to where the server was booted.
If using a KSS keystore, the keystore URI must be of the form:
kss://system/keystorename
where keystorename is the name of the keystore registered in KSS.
The value in this attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_CUSTOM_TRUST
Type: string
Constraints: Has Default Value: null
The custom trust keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_CUSTOM_TRUST.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the CustomTrustKeyStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the CustomTrustKeyStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (CustomTrustKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use CustomTrustKeyStorePassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
The type of the keystore. Generally, this is JKS. If using the Oracle Key Store Service, this would be KSS
If empty or null, then the JDK's default keystore type (specified in java.security) is used. This keystore type is only used if KeyStores is CUSTOM_IDENTITY_AND_CUSTOM_TRUST.
Type: string
Constraints: Has Default Value: null
The password for the default IIOP user. (Requires you to enable IIOP.)
As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the DefaultIIOPPasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
Using this attribute (DefaultIIOPPassword) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use DefaultIIOPPasswordEncrypted
Type: string
Constraints: Restart Required, Encrypted, Has Default Value: null
The user name of the default IIOP user. (Requires you to enable IIOP.)
Type: string
Constraints: Restart Required, Has Default Value: null
Specifies whether all default servlets in the servlet engine are disabled.
This includes: weblogic.servlet.ClasspathServlet weblogic.servlet.utils.iiop.GetIORServlet weblogic.rjvm.http.TunnelSendServlet weblogic.rjvm.http.TunnelRecvServlet weblogic.rjvm.http.TunnelLoginServlet weblogic.rjvm.http.TunnelCloseServlet If set to true, this property overrides the ClasspathServletDisabled property.
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: false
The protocol to use for connections when none is specified.
Type: string
Constraints: Restart Required, Has Default Value: t3, Legal Values: t3, t3s, http, https, iiop, iiops
The protocol to use for secure connections when none is specified.
Type: string
Constraints: Restart Required, Has Default Value: t3s, Legal Values: t3s, https, iiops
The password for the default user associated with the Tuxedo GIOP (TGIOP) protocol. (Requires you to configure WebLogic Tuxedo Connector (WTC) for this server.)
As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the DefaultTGIOPPasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the DefaultTGIOPPasswordEncrypted attribute to the encrypted value.
Using this attribute (DefaultTGIOPPassword) is a potential security risk in because the String object (which contains the unencrypted password) remains the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use DefaultTGIOPPasswordEncrypted
Type: string
Constraints: Restart Required, Encrypted
The default user associated with the Tuxedo GIOP (TGIOP) protocol. (Requires you to configure WebLogic Tuxedo Connector (WTC) for this server.)
Type: string
Constraints: Restart Required, Has Secure Value: null, Has Default Value: guest
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies whether to clean up all ThreadLocals storage from self-tuning thread pool threads after they have finished processing each work request. By default, the self-tuning thread pool only cleans up ThreadLocal storage in its threads after an application is undeployed to avoid ClassLoader memory leak.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The external IP address or DNS name for this server.
This address will be sent with HTTP session cookies and with dynamic server lists to HTTP proxies. It will also be used by external application clients to enable the propagation of RMI traffic through network address translating (NAT) firewalls.
You must specify an external DNS name for configurations in which a firewall is performing network address translation, unless clients are accessing WebLogic Server using t3 and the default channel. For example, define the external DNS name for configurations in which a firewall is performing network address translation, and clients are accessing WebLogic Server using HTTP via a proxy plug-in.
Type: string
Constraints: Restart Required, Has Default Value: null
The options passed to the EJB compiler during server-side generation.
Each EJB component can override the compiler options that you specify here. The following options are valid:
Forces generation of wrapper classes. Without this flag the classes may not be regenerated if it is determined to be unnecessary.
Generate ejb stub and skel as part of ejbc. Avoid HotCodeGen to have better performance.
Keep the generated .java files.
Java compiler to exec. If not specified, the -compilerclass option will be used.
Specifies the compiler class to invoke.
Compile debugging info into class file.
Passed through to Symantec's sj.
Classpath to use.
Source version.
Flags passed through to java runtime.
Type: string
Constraints: Restart Required, Has Default Value: null
The options passed to the RMIC compiler during server-side generation.
Each EJB component can override the compiler options that you specify here.
Type: string
Constraints: Restart Required, Has Default Value: null
Enables gathered writes over NIO socket channels. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Number of seconds a graceful shutdown operation waits before forcing a shut down. A graceful shutdown gives WebLogic Server subsystems time to complete certain application processing currently in progress. If subsystems are unable to complete processing within the number of seconds that you specify here, then the server will force shutdown automatically.
A value of means that the server will wait indefinitely for graceful shutdown to complete.
The graceful shutdown timeout applies only to graceful shutdown operations.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0
The number of seconds that defines the frequency of this server's self-health monitoring. The server monitors the health of it's subsystems every HealthCheckIntervalSeconds and changes the Server's overall state if required.
Type: int
Constraints: Has Default Value: 180, Minimum Value: 1, Maximum Value: 2147483647
The number of seconds the Node Manager should wait before starting to monitor the server.
Type: int
Constraints: Has Default Value: 120, Minimum Value: 0, Maximum Value: 2147483647
Gets the hostsMigratableServices attribute of the ServerMBean object
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: true
Returns the HttpTraceSupportEnabled value
Type: boolean
Constraints: Restart Required, Has Default Value: false
Whether or not HTTP support is enabled on the regular port or SSL port.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The maximum number of seconds that a connection is allowed to be idle before it is closed by the server. The T3 and T3S protocols ignore this attribute. If you configure network channels for this server, each channel can override this idle connection message timeout.
This timeout helps guard against server deadlock through too many open connections.
Type: int
Constraints: Has Secure Value: 65, Has Default Value: 65, Minimum Value: 0
The number of idle periods until peer is considered unreachable.
Type: int
Constraints: Restart Required, Has Default Value: 4, Minimum Value: 4, Maximum Value: 65534
Indicates whether a graceful shutdown operation drops all HTTP sessions immediately.
If this is set to false, a graceful shutdown operation waits for HTTP sessions to complete or timeout.
Type: boolean
Constraints: Has Default Value: false
Specifies whether the server returns stack traces for RMI calls that generate exceptions.
With RMI stack tracking enabled, if a client issues an RMI call to a server subsystem or to a module running within the server, and if the subsystem or module generates an exception that includes a stack trace, the server will return the exception as well as the stack trace. With it disabled, the server will return the exception without the stack trace details.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: true
The IP address of the NIC that this server should use for multicast traffic.
Type: string
Constraints: Restart Required
The Java compiler to use for all applications hosted on this server that need to compile Java code.
Type: string
Constraints: Has Secure Value: javac, Has Default Value: javac
The options to append to the Java compiler classpath when compiling Java code.
Type: string
Constraints: Restart Required, Has Secure Value: null, Has Default Value: null
The options to prepend to the Java compiler classpath when compiling Java code.
Type: string
Constraints: Restart Required, Has Secure Value: null, Has Default Value: null
The password for the Java Standard Trust keystore. This password is defined when the keystore is created.
If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST or DEMO_IDENTITY_AND_DEMO_TRUST.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the JavaStandardTrustKeyStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the JavaStandardTrustKeyStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (JavaStandardTrustKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use JavaStandardTrustKeyStorePassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
Which configuration rules should be used for finding the server's identity and trust keystores?
Type: string
Constraints: Has Default Value: DemoIdentityAndDemoTrust, Legal Values: DemoIdentityAndDemoTrust, CustomIdentityAndJavaStandardTrust, CustomIdentityAndCustomTrust, CustomIdentityAndCommandLineTrust
The IP address or DNS name this server uses to listen for incoming connections. For example, enter 12.34.5.67 or mymachine, respectively.
Note that the value you specify for the listen address is not the URL to the host machine and it does not include the communication protocol, listen port, or channel.
Servers can be reached through the following URL:
protocol://listen-address:listen-port
Any network channel that you configure for this server can override this listen address.
If a server's listen address is undefined, clients can reach the server through an IP address of the computer that hosts the server, a DNS name that resolves to the host, or the localhost string. The localhost string can be used only for requests from clients that are running on the same computer as the server.
If you want to limit the valid addresses for a server instance, specify one of the following:
IP address. If you provide an IP address, clients can specify either the IP address or a DNS name that maps to the IP address. Clients that specify an IP address and attempt to connect through an SSL port must disable hostname verification.
DNS name. If you provide a DNS name, clients can specify either the DNS name or the corresponding IP address.
Do not leave the listen address undefined on a computer that uses multiple IP address (a multihomed computer). On such a computer, the server will bind to all available IP addresses.
Note also that if you are using the demo certificates in a multi-server domain, Managed Server instances will fail to boot if you specify the fully-qualified DNS name. For information about this limitation and suggested workarounds, see "Limitation on CertGen Usage" in Administering Security for Oracle WebLogic Server
Type: string
Constraints: Restart Required
The default TCP port that this server uses to listen for regular (non-SSL) incoming connections.
Administrators must have the right privileges before binding to a port or else this operation will not be successful and it will render the console un-reachable.
If this port is disabled, the SSL port must be enabled. Additional ports can be configured using network channels. The cluster (multicast) port is configured separately.
Type: int
Constraints: Has Default Value: 7001, Minimum Value: 1, Maximum Value: 65535
Specifies whether this server can be reached through the default plain-text (non-SSL) listen port.
If you disable this listen port, you must enable the default SSL listen port.
You can define additional listen ports for this server by configuring network channels.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: true
Returns the maximum time that the server will wait for server sockets to bind before starting a listen thread.
Properties to consider for removal
Type: int
Constraints: Restart Required, Has Default Value: 60
Determines whether the server should bind server sockets early.
Early binding detects port conflicts quickly and also gives user feedback on the default listen port as to the server state.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Specifies whether the server message log includes exceptions that are raised in remote systems.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: false
The login timeout for this server's default regular (non-SSL) listen port. This is the maximum amount of time allowed for a new connection to establish.
A value of indicates there is no maximum.
Type: int
Constraints: Has Secure Value: 5000, Has Default Value: 5000, Minimum Value: 0, Maximum Value: 100000
The WebLogic Server host computer (machine) on which this server is meant to run.
If you want to use Node Manager to start this server, you must assign the server to a machine and you must configure the machine for Node Manager.
You cannot change this value if a server instance is already running.
Type: weblogic.management.configuration.MachineMBean reference
Constraints: Restart Required
Specifies whether this Managed Server can be started when the Administration Server is unavailable.
In such a case, the Managed Server retrieves its configuration by reading a configuration file and other files directly.
Type: boolean
Constraints: Restart Required, Has Secure Value: true, Has Default Value: true
The maximum number of running long-running requests that can be submitted to all the Managed Executor Services or Managed Scheduled Executor Services in the server.
Type: int
Constraints: Has Default Value: 100, Minimum Value: 0, Maximum Value: 65534
The maximum number of running threads that can be created by all the Managed Thread Factories in the server.
Type: int
Constraints: Has Default Value: 100, Minimum Value: 0, Maximum Value: 65534
The maximum number of bytes allowed in messages that are received over all supported protocols, unless overridden by a protocol-specific setting or a custom channel setting.
The order of precedence for setting message size maximums is as follows:
A channel-wide maximum in a custom network channel.
A protocol-specific setting in the default network channel.
See
getMaxCOMMessageSize() getMaxCOMMessageSize
getMaxHTTPMessageSize() getMaxHTTPMessageSize
getMaxIIOPMessageSize() getMaxIIOPessageSize
getMaxT3MessageSize() getMaxT3MessageSize
The message maximum in this attribute.
This maximum message size helps guard against a denial of service attack in which a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests.
A client can set this value using the -Dweblogic.MaxMessageSize property.
Type: int
Constraints: Has Secure Value: 10000000, Has Default Value: 10000000, Minimum Value: 4096, Maximum Value: 2000000000
The maximum number of open sockets allowed in server at a given point of time.
When the maximum threshold is reached, the server stops accepting new requests until the number of sockets drops below the threshold.
A value less than indicates an unlimited size.
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 2147483647
Indicates whether message IDs in logged messages will include a prefix. Message ids are 6 digit numeric strings that can be optionally presented in a log entry with a prefix. The prefix used by server messages is "BEA-".
Type: boolean
Constraints: Restart Required, Has Default Value: true
Non-blocking IO is enabled by default on the server side.
The default value is weblogic.socket.NIOSocketMuxer.
The Certicom SSL implementation is not supported with NIOSocketMuxer. If you need to secure internet communication, Oracle recommends enabling JSSE (Java Secure Socket Extension).
Type: string
Constraints: Restart Required
An alphanumeric name for this server instance. (Spaces are not valid.)
The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.
The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.
After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.
Type: string
Constraints: Read Only, Restart Required
Specifies whether native I/O is enabled for the server.
Type: boolean
Constraints: Restart Required, Has Default Value: true
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.
Type: string
Get the number of retries to contact admin server, before starting in Managed Server Independence Mode
Type: int
Constraints: Has Default Value: 3, Minimum Value: 0, Maximum Value: 65534
Specifies whether new server-to-server connections may consider the default server channel when initiating a connection. This is only relevant if the connection needs to be bound to the default listen address. This will only work for binary protocols that support both outbound and inbound traffic.
When this feature is not enabled, connections are initiated using a local address selected by the underlying hardware. For the default channel this is usually what is wanted for IP-routing to be effective. Note that since the default is false, other outbound channels will be considered in preference to the default channel.
Default administration channels, created when the domain-wide administration port is turned on, are always considered and bound when initiating an administrative connection. To allow IP-routing for administration traffic create custom admin with NetworkAccessPointMBean#isOutboundEnabled isOutboundEnabled set to false instead of enabling the domain-wide ADMIN port.
Type: boolean
Constraints: Has Default Value: false
Specifies whether the SSL identity specified by SSLMBean#getServerPrivateKeyAlias() getSSLMBean#ServerPrivateKeyAlias for this server should be used for outbound SSL connections on the default server channel. In normal circumstances the outbound identity is determined by the caller's environment.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
The time interval in milliseconds of the heartbeat period. A value of 0 indicates that heartbeats are turned off.
Type: int
Constraints: Restart Required, Has Default Value: 60000, Minimum Value: 0
Defines secondary clustered instances considered for hosting replicas of the primary HTTP session states created on the server.
Type: string
Constraints: Restart Required
Specifies whether the server message log includes exception stack trace that are raised in remote systems.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
The reliable delivery policy for web services.
Type: weblogic.management.configuration.WSReliableDeliveryPolicyMBean reference
Constraints: Restart Required
Defines preferred clustered instances considered for hosting replicas of the primary HTTP session states created on the server.
Type: string
Constraints: Restart Required
When WLS is running on Exalogic machines, cluster replication traffic could go over multiple replication channels. However multiple replication channels need not be configured on each clustered server instance. Only one replication channel with explicit IP-Address needs to be configured for each server and replicationPorts range can be specified for each server. For eg. range 7001-7010 will create 10 replication channels with ports 7001 to 7010 for the given server. These channels inherits all the properties of the configured replication channel except the listen port.Names of these channels will be derived from the configured replication channel with suffic {x} added where x could be 1,2.. as per the number of ports specified. Public ports are same as the listen port for these additional channels.
Type: string
Constraints: Restart Required
Resolve the listen address to use for all T3 communication
Type: boolean
Constraints: Restart Required, Has Default Value: false
The number of seconds the Node Manager should wait before restarting this server.
After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails.
If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.
Type: int
Constraints: Has Default Value: 3600, Minimum Value: 300, Maximum Value: 2147483647
The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.
Type: int
Constraints: Has Default Value: 2, Minimum Value: 0, Maximum Value: 2147483647
Get the number of seconds between the retries to contact admin server, before starting in Managed Server Independence Mode
Type: int
Constraints: Has Default Value: 5, Minimum Value: 1, Maximum Value: 65534
Specifies whether the kernel is allowed to perform reverse DNS lookups.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Enables scattered reads over NIO socket channels. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Number of seconds a force shutdown operation waits before timing out and killing itself. If the operation does not complete within the configured timeout seconds, the server will shutdown automatically if the state of the server at that time was SHUTTING_DOWN
A value of means that the server will wait indefinitely for life cycle operation to complete.
Type: int
Constraints: Has Secure Value: 120, Has Default Value: 30, Has Production Mode Default Value: 120, Minimum Value: 0
Specifies whether the server's buffer size for sending or receiving data through a raw socket should be set to 4KB.
Otherwise, the server does not impose a limit to the buffer size and defers to the operating system. This option is useful only on some operating systems for improving performance. It should be disabled in most environments.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The number of socket reader threads.
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 65534
The directory path on the Managed Server where all staged (prepared) applications are placed.
If an absolute directory name is not specified, the path is relative to the root directory "/". Once configured, you cannot change the staging directory name. Remove all applications from the server prior to changing this attribute. The default staging directory is "stage", relative to the server root.
Type: string
Constraints: Restart Required
The mode that specifies whether an application's files are copied from a source on the Administration Server to the Managed Server's staging area during application preparation.
During application preparation, the application's files are copied from the source on the Administration Server to the Managed Server's staging area. If you specify nostage or external_stage, the copy will not occur. This is useful when the staging area is a shared directory, already containing the application files, or if this is a single server domain. The administrator must ensure that the Managed Server's staging directory is set appropriately. Deployment errors will result if the application is not available during the preparation or activation of the application. Each application can override the staging mode specified here.
Type: string
Constraints: Restart Required, Legal Values: stage, nostage, external_stage
The state in which this server should be started. If you specify STANDBY, you must also enable the domain-wide administration port.
In the RUNNING state, a server offers its services to clients and can operate as a full member of a cluster. In the ADMIN state, the server is up and running, but available only for administration operations, allowing you to perform server and application-level administration tasks without risk to running applications. In the STANDBY state, a server instance does not process any request; its regular Listen Port is closed. The Administration Port is open. It only accepts life cycle commands that transition the server instance to either the RUNNING or the SHUTDOWN state. Other Administration requests are not accepted. A STANDBY server's only purpose is to resume into the RUNNING state quickly; it saves server startup time.
Type: string
Constraints: Has Default Value: RUNNING
Timeout value for server start and resume operations. If the server fails to start in the timeout period, it will force shutdown.
A value of means that the server will wait indefinitely for the operation to complete.
Type: int
Constraints: Restart Required, Has Default Value: 0, Has Production Mode Default Value: 0, Minimum Value: 0
The number of seconds after which WebLogic Server periodically scans threads to see if they have been continually working for the configured maximum length of time.
Type: int
Constraints: Restart Required, Has Default Value: 60, Minimum Value: 0, Maximum Value: 2147483647
Return all tags on this Configuration MBean
Type: array of string
The percentage of execute threads from the default queue that can be used as socket readers.
Type: int
Constraints: Has Default Value: 33, Minimum Value: 1, Maximum Value: 99
The path prefix for the server's JTA transaction log files. If the pathname is not absolute, the path is assumed to be relative to the server's root directory.
For a clustered server, if you plan to be able to migrate the Transaction Recovery Service from this server if it fails to another server (backup server) in the same cluster, you must store transaction log files on persistent storage, such as a Storage Area Network (SAN) device or a dual-ported disk, available to both servers.
Do not use an NFS file system to store transaction log files. Because of the caching scheme in NFS, transaction log files on disk may not always be current. Using transaction log files stored on an NFS device for recovery may cause data corruption.
Type: string
Constraints: Restart Required, Has Default Value: ./
The policy that determines how transaction log file entries are written to disk. This policy can affect transaction performance. (Note: To be transactionally safe, the Direct-Write policy may require additional OS or environment changes on some Windows systems.)
WebLogic Server supports the following policies:
Cache-Flush. Flushes operating system and on-disk caches after each write.
Direct-Write. Tells the operating system to write directly to disk with each write. Direct-Write performs better than Cache-Flush.
If Direct-Write is not supported on the host platform, the policy becomes Cache-Flush and a log message is printed.
Note: On Windows, the "Direct-Write" policy may leave transaction data in the on-disk cache without writing it to disk immediately. This is not transactionally safe because a power failure can cause loss of on-disk cache data. For transactionally safe writes using "Direct-Write" on Windows, either disable all write caching for the disk (enabled by default), or use a disk with a battery-backed cache.
The on-disk cache for a hard-drive on Windows can be disabled through system administration: Control-Panel -> System -> Hardware-tab -> Device-Manager-button -> Disk-Drives -> name-of-drive -> Policies-tab -> "Enable write caching on the disk" check-box. Some file systems do not allow this value to be changed. For example, a RAID system that has a reliable cache.
Type: string
Constraints: Restart Required, Has Default Value: Direct-Write, Legal Values: Cache-Flush, Direct-Write, Legal Null: true
The interval (in seconds) at which to ping a tunneled client to see if it is still alive.
If you create network channels for this server, each channel can override this setting.
Type: int
Constraints: Has Default Value: 45, Minimum Value: 1
The amount of time (in seconds) after which a missing tunneled client is considered dead.
If you create network channels for this server, each channel can override this setting.
Type: int
Constraints: Has Default Value: 40, Minimum Value: 1
Specifies whether tunneling for the T3, T3S, HTTP, HTTPS, IIOP, and IIOPS protocols should be enabled for this server.
If you create network channels for this server, each channel can override this setting.
Type: boolean
Constraints: Has Default Value: false
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The directory path on the Administration Server where all uploaded applications are placed.
If an absolute directory name is not specified, the path is relative to the root directory "/". The default staging directory is "stage", relative to the server root. On the Managed Server this returns null, and is not configurable.
Type: string
Constraints: Has Secure Value: An absolute directory that is outside the root directory of any WebLogic Server instance or application, and that resides on a physical disk that is separate from the WebLogic Server host's system disk.
Backward compatibility mode to switch to 8.1 execute queues instead of WorkManagers. Each of the WorkManagers is converted to an individual execute queue. Setting this attribute requires a server restart.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Reduces lock contention by using concurrent buffer queue to park incoming requests. Enabling this attribute increases throughput as requests are scheduled without acquiring any locks.
Type: boolean
Constraints: Restart Required
Specifies whether to includes detailed information in self-tuning thread pool thread names. Setting this flag as true would include additional information, such as the name of the Work Manager for which the execute thread is executing the task, but at the expense of overhead in keeping the thread name updated with such information.
Type: boolean
Constraints: Has Default Value: false
Specifies whether self-tuning should use the enhanced IncrementAdvisor implementation that uses a different algorithm to adjust the size of the self-tuning thread pool.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Reduces lock contention by using the enhanced ConcurrentCalendarQueue as the priority based queue for pending requests that are waiting for a thread.
This attribute should be enabled only in an Oracle Exalogic environment.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Enables the use of the ADM_DDL store procedure for LLR. The default value is false (not enabled).
When enabled, a WLS_ prefix and _DYD suffix is is automatically added to the LLR table name at runtime so the LLR table name in server configuration is not consistent with the actual table name in database.
Type: boolean
Constraints: Restart Required
Specifies whether this server uses the proprietary WL-Proxy-Client-IP header.
Set this attribute to true to specify that this server instance uses the proprietary WL-Proxy-Client-IP header, which is recommended if the server instance will receive requests from a proxy plug-in. If the server instance is a member of a cluster that will receive proxied requests, enable the WebLogic plug-in at the cluster level. For servers that are members of a cluster, the setting at the cluster level overrides the server's setting. When the WebLogic plug-in is enabled at the cluster level, a call to getRemoteAddr will return the address of the browser client from the proprietary WL-Proxy-Client-IP header instead of the Web server.
Set this attrbute to false to disable the weblogic-plugin-enabled parameter, weblogic-plugin-enabled=false, in the config.xml file.
Note: If you are using Oracle HTTP Server, the WebLogic Proxy Plug-In, or Oracle Traffic Director to distribute client requests to a Managed Server or a cluster, Oracle recommends setting this attribute to true
Type: boolean
Constraints: Restart Required, Has Default Value: false
Provides methods for configuring a shutdown class. A shutdown class is a Java program that is automatically loaded and executed when a WebLogic Server instance is shut down gracefully.
The properties of the weblogic.management.configuration.ShutdownClassMBean entity are as follows:
Arguments that a server uses to initialize a class.
Separate multiple arguments with a comma. For example:
first=MyFirstName,last=MyLastName
Type: string
Constraints: Restart Required
The fully qualified name of a class to load and run. The class must be on the server's classpath.
For example, mycompany.mypackage.myclass
Type: string
Constraints: Restart Required, Legal Null: true
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean represents configuration for SAML 2.0-based local site Single Sign-On Services.
The properties of the weblogic.management.configuration.SingleSignOnServicesMBean entity are as follows:
Specifies whether the POST one-use check is enabled.
If set, the local site POST binding endpoints will store identifiers of all inbound documents to ensure that those documents are not presented more than once.
Type: boolean
Constraints: Has Default Value: true
The keystore alias for the key to be used when signing documents.
The key is used to generate signatures on all the outgoing documents, such as authentication requests and responses. If you do not specify an alias, the server's configured SSL private key alias from the server's SSL configuration is used by default.
Type: string
Constraints: Has Default Value: null
The passphrase used to retrieve the local site's SSO signing key from the keystore.
If you do not specify a keystore alias and passphrase, the server's configured private key alias and private key passphrase from the server's SSL configuration is used by default.
Type: string
Constraints: Encrypted, Has Default Value: null
The maximum size of the artifact cache.
This cache contains the artifacts issued by the local site that are awaiting referencing by a partner. Specify '0' to indicate that the cache is unbounded.
Type: int
Constraints: Has Default Value: 10000
The maximum timeout (in seconds) of artifacts stored in the local cache.
This cache stores artifacts issued by the local site that are awaiting referencing by a partner. Artifacts that reach this maximum timeout duration are expired in the local cache even if no reference request has been received from the partner. If a reference request is subsequently received from the partner, the cache behaves as if the artifact had never been generated.
Type: int
Constraints: Has Default Value: 300
The maximum size of the authentication request cache.
This cache stores documents issued by the local Service Provider that are awaiting response from a partner Identity Provider.
Specify '0' to indicate that the cache is unbounded.
Type: int
Constraints: Has Default Value: 10000
The maximum timeout (in seconds) of <AuthnRequest> documents stored in the local cache.
This cache stores documents issued by the local Service provider that are awaiting response from a partner Identity Provider. Documents that reach this maximum timeout duration are expired from the local cache even if no response is received from the Identity Provider. If a response is subsequently returned by the Identity Provider, the cache behaves as if the <AuthnRequest> had never been generated.
Type: int
Constraints: Has Default Value: 300
The password used to assign Basic Authentication credentials to outgoing HTTPS connections
Type: string
Constraints: Encrypted
The username that is used to assign Basic authentication credentials to outgoing HTTPS connections.
Type: string
The contact person's company name.
Type: string
Constraints: Has Default Value: null
The contact person's e-mail address.
Type: string
Constraints: Has Default Value: null
The contact person given (first) name.
Type: string
Constraints: Has Default Value: null
The contact person surname (last name).
Type: string
Constraints: Has Default Value: null
The contact person's telephone number.
Type: string
Constraints: Has Default Value: null
The contact person type.
Type: string
Constraints: Has Default Value: null
The Service Provider's default URL.
When an unsolicited SSO response arrives at the Service Provider without an accompanying target URL, the user (if authenticated) is redirected to this default URL.
Type: string
Constraints: Has Default Value: null
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The string that uniquely identifies the local site.
Type: string
Constraints: Has Default Value: null
Specifies whether the Identity Provider must authenticate users directly and not use a previous security context. The default is false.
Note the following:
Setting ForceAuthn to true -- that is, enabling Force Authentication -- has no effect in WebLogic Server. SAML logout is not supported in WebLogic Server, so even if the user is already authenticated at the Identity Provider site and ForceAuthn is set to true, the user is not forced to authenticate again at the Identity Provider site.
Setting both ForceAuthn and IsPassive to true -- that is, Force Authentication and Passive are enabled -- is an invalid configuration that causes WebLogic server to generate an exception and also causes the single sign-on session to fail.
Type: boolean
Constraints: Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies whether the Artifact binding is enabled for the Identity Provider.
Type: boolean
Constraints: Has Default Value: true
Specifies whether the local site is enabled for the Identity Provider role.
Type: boolean
Constraints: Has Default Value: false
Specifies whether the POST binding is enabled for the Identity Provider.
Type: boolean
Constraints: Has Default Value: true
Specifies the preferred binding type for endpoints of the Identity Provider services. Must be set to None, HTTP/POST, HTTP/Artifact, or HTTP/Redirect
Type: string
Constraints: Has Default Value: None, Legal Values: None, HTTP/POST, HTTP/Artifact, HTTP/Redirect, Legal Null: true
Specifies whether the Redirect binding is enabled for the Identity Provider.
Type: boolean
Constraints: Has Default Value: true
The name of the query parameter to be used for conveying the login-return URL to the login form web application.
Type: string
Constraints: Has Default Value: null
The URL of the login form web application to which unauthenticated requests are directed.
By default, the login URL is /saml2/idp/login using Basic authentication. Typically you specify this URL if you are using a custom login web application.
Type: string
Constraints: Has Default Value: /saml2/idp/login, Legal Null: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The organization name.
This string specifies the name of the organization to which a user may refer for obtaining additional information about the local site.
Type: string
Constraints: Has Default Value: null
The organization URL.
This string specifies a location to which a user may refer for information about the local site. This string is not used by SAML 2.0 services for the actual handling or processing of messages.
Type: string
Constraints: Has Default Value: null
Determines whether the Identity Provider and the user must not take control of the user interface from the requester and interact with the user in a noticeable fashion. The default setting is false
The WebLogic Server SAML 2.0 services generate an exception if Passive (IsPassive) is enabled and the end user is not already authenticated at the Identity Provider site. In this situation, web single sign-on fails.
Type: boolean
Constraints: Has Default Value: false
The published site URL.
When publishing SAML 2.0 metadata, this URL is used as a base URL to construct endpoint URLs for the various SAML 2.0 services. The published site URL is also used during request processing to generate and/or parse various URLs.
The hostname and port portion of the URL should be the hostname and port at which the server is visible externally; this may not be the same as the hostname and port by which the server is known locally. If you are configuring SAML 2.0 services in a cluster, the hostname and port may correspond to the load balancer or proxy server that distributes client requests to servers in the cluster.
The remainder of the URL should be a single path component corresponding to the application context at which the SAML 2.0 services application is deployed (typically /saml2).
Type: string
Constraints: Has Default Value: null
Specifies whether the recipient/destination check is enabled. When true, the recipient of the SAML Request/Response must match the URL in the HTTP Request.
Type: boolean
Constraints: Has Default Value: true
Specifies whether the persistent cache (LDAP or RDBMS) is used for storing SAML 2.0 artifacts and authentication requests.
RDBMS is required by the SAML 2.0 security providers in production environments. Use LDAP only in development environments.
If this is not set, artifacts and requests are saved in memory.
If you are configuring SAML 2.0 services for two or more WebLogic Server instances in a domain, you must enable the replicated cache individually on each server. In addition, if you are configuring SAML 2.0 services in a cluster, each Managed Server must also be configured individually.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether the Artifact binding is enabled for the Service Provider.
Type: boolean
Constraints: Has Default Value: true
Specifies whether the local site is enabled for the Service Provider role.
This attribute must be enabled in order to publish the metadata file.
Type: boolean
Constraints: Has Default Value: false
Specifies whether the POST binding is enabled for the Service Provider.
Type: boolean
Constraints: Has Default Value: true
Specifies the preferred binding type for endpoints of Service Provider services. Must be set to "None", "POST", or "Artifact".
Type: string
Constraints: Has Default Value: None, Legal Values: None, HTTP/POST, HTTP/Artifact, Legal Null: true
Specifies whether authentication requests must be signed. If set, all outgoing authentication requests are signed.
Type: boolean
Constraints: Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
The string alias used to store and retrieve the server's private key, which is used to establish outgoing TLS/SSL connections.
If you do not specify an alias, the server's configured SSL private key alias from the server's SSL configuration is used for the TLS alias by default.
Type: string
The passphrase used to retrieve the server's private key from the keystore.
If you do not specify either an alias or a passphrase, the server's configured SSL private key alias and private key passphrase from the server's SSL configuration is used for the TLS alias and passphrase by default.
Type: string
Constraints: Encrypted
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies whether incoming artifact requests must be signed.
This attribute can be set if the Artifact binding is enabled.
Type: boolean
Constraints: Has Default Value: false
Specifies whether incoming SAML 2.0 assertions must be signed.
Type: boolean
Constraints: Has Default Value: false
Specifies whether incoming authentication requests must be signed. If set, authentication requests that are not signed are not accepted.
Type: boolean
Constraints: Has Default Value: false
Specifies whether Basic Authentication client authentication is required.
If enabled, callers to HTTPS bindings of the local site must specify a Basic authentication header, and the username and password must be validated against the Basic authentication values of the binding client partner.
Type: boolean
Constraints: Has Default Value: false
Specifies whether TLS/SSL client authentication is required.
If enabled, callers to TLS/SSL bindings of the local site must specify client authentication (two-way SSL), and the identity specified must validate against the TLS certificate of the binding client partner.
Type: boolean
Constraints: Has Default Value: false
A service that will be automatically maintained as a Singleton in a cluster. There will always be exactly one instance of it active at any given time.
The properties of the weblogic.management.configuration.SingletonServiceMBean entity are as follows:
A migratable service could fail to come up on every possible configured server. This attribute controls how many further attempts, after the service has failed on every server at least once, should be tried. Note that each attempt specified here indicates another full circuit of migrations amongst all the configured servers. So for a 3-server cluster, and a value of 2, a total of 4 additional migrations will be attempted. (the original server is never a valid destination)
Type: int
Constraints: Restart Required, Has Default Value: 2
Return a list of servers that are candidates to host the services deployed to this migratable target. If the ConstrainedCandidateServer list is empty, all servers in the cluster are returned. If the ConstrainedCandidateServer is not empty those servers only will be returned. The user preferred server will be the first element in the list returned.
Type: array of weblogic.management.configuration.ServerMBean references
The fully qualified name of a class to load and run. The class must be on the server's classpath.
For example, mycompany.mypackage.myclass
Type: string
Constraints: Restart Required, Legal Null: true
Returns the cluster this singleton service is associated with.
Type: weblogic.management.configuration.ClusterMBean reference
Constraints: Restart Required
Returns the (user restricted) list of servers that may host the migratable target. The target will not be allowed to migrate to a server that is not in the returned list of servers. This feature is used to e.g. configure the two server that have access to a dual ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.
Type: array of weblogic.management.configuration.ServerMBean references
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Returns the name of the server that currently hosts the singleton service.
Type: weblogic.management.configuration.ServerMBean reference
Constraints: Read Only
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Controls how long of a pause there should be between the migration attempts described in getAdditionalMigrationAttempts(). Note that this delay only happens when the service has failed to come up on every server. It does not cause any sort of delay between attempts to migrate otherwise.
Type: int
Constraints: Restart Required, Has Default Value: 300000
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Returns the server that the user prefers the singleton service to be active on.
Type: weblogic.management.configuration.ServerMBean reference
Provides methods that configure startup classes. A startup class is a Java program that is automatically loaded and executed when a WebLogic Server instance is started or restarted. By default, startup classes are loaded and executed after all other server subsystems have initialized and after the server deploys modules. For any startup class, you can override the default and specify that the server loads and executes it and before it deploys JDBC connection pools and before it deploys Web applications and EJBs.
The properties of the weblogic.management.configuration.StartupClassMBean entity are as follows:
Arguments that a server uses to initialize a class.
Separate multiple arguments with a comma. For example:
first=MyFirstName,last=MyLastName
Type: string
Constraints: Restart Required
The fully qualified name of a class to load and run. The class must be on the server's classpath.
For example, mycompany.mypackage.myclass
Type: string
Constraints: Restart Required, Legal Null: true
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies whether a failure in this startup class prevents the targeted server(s) from starting.
If you specify that failure is not fatal, if the startup class fails, the server continues its startup process.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies whether the targeted servers load and run this startup class after applications and EJBs are running.
If you enable this feature for a startup class, a server loads and runs the startup class after the activate phase. At this point, JMS and JDBC services are available. (Deployment for applications and EJBs consists of three phases: prepare, admin and activate.)
Enable this feature if the startup class needs to be invoked after applications are running and ready to service client requests.
If you do not enable this feature, LoadBeforeAppDeployments or LoadBeforeAppActivation, a server instance loads startup classes when applications go to the admin state.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether the targeted servers load and run this startup class after activating JMS and JDBC services and before activating applications and EJBs.
If you enable this feature for a startup class, a server loads and runs the startup class before the activate phase. At this point, JMS and JDBC services are available. (Deployment for applications and EJBs consists of three phases: prepare, admin and activate.)
Enable this feature if the startup class needs to be invoked after JDBC connection pools are available but before the applications are activated and ready to service client requests.
If you do not enable this feature, LoadBeforeAppDeployments or LoadAfterAppsRunning, a server instance loads startup classes when applications go to the admin state.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether the targeted servers load and run this startup class before activating JMS and JDBC services and before starting deployment for applications and EJBs.
If you enable this feature for a startup class, a server loads and runs the startup class before the deployment prepare phase. At this point, JMS and JDBC services are not yet available. (Deployment for applications and EJBs consists of three phases: prepare, admin and activate.)
If you do not enable this feature, LoadBeforeAppActivation or LoadAfterAppsRunning, a server instance loads startup classes when applications go to the admin state.
Type: boolean
Constraints: Restart Required, Has Default Value: false
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean represents an individually targetable entity within a deployment package, which is deployable on WLS. This includes :
Modules in an EAR
JMS resources within a app scoped JMS module in an EAR
The properties of the weblogic.management.configuration.SubDeploymentMBean entity are as follows:
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.
Type: string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The values match those defined by jsr88. This attribute may move to another MBean.
Type: string
Constraints: Restart Required
Unique identifier for this bean instance. It is used by the application container to match the module in the application package to the targeting information in the configuration.
For modules within an EAR, the name should be the URI of the module as defined in the META-INF/application.xml deployment descriptor. There is an exception to this for web applications. See below.
For web modules in an EAR, the name should always equal the context root of that webapp, because the URI is not always unique
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Only relevant for deployments in resource group templates. Sub-deployments cannot have arbitrary targets if they are part of a deployment from resource group template. The sub-deployments, in such cases, may only be targeted to the virtual host of referring partition or stay untargeted. This flag, when specified with true, indicates that the sub-deployment must not be deployed in the referring partition
Type: boolean
Constraints: Has Default Value: false
A System Component Configuration MBean allows configuration to be shared between one or more System Components.
The properties of the weblogic.management.configuration.SystemComponentConfigurationMBean entity are as follows:
Get the system component type Examples of types may include "OHS", "Coherence". New System Components may be added in the future so the list of types is not static.
Type: string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Get the source path for configuration files Note: if you use a SystemComponentConfiguration, then the files for the SystemComponents directory are not used so there is no chance of conflict.
Type: string
Constraints: Restart Required
System Component Configurations are targeted to System Component instances.
Type: array of weblogic.management.configuration.SystemComponentMBean references
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The properties of the weblogic.management.configuration.SystemComponentMBean entity are as follows:
Returns the timeout value to be used by NodeManagerRuntime when creating a socket connection to the agent. Default set high as SSH agent may require a high connection establishment time.
Type: int
Constraints: Restart Required, Has Default Value: 180000, Minimum Value: 0
Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.
Type: boolean
Constraints: Has Default Value: true
Get the system component type Examples of types may include "OHS", "Coherence". New System Components may be added in the future so the list of types is not static.
Type: string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The WebLogic Server host computer (machine) on which this server is meant to run.
If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager.
You cannot change this value if a server instance is already running.
Type: weblogic.management.configuration.MachineMBean reference
Constraints: Restart Required
An alphanumeric name for this server instance. (Spaces are not valid.)
The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.
The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.
After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.
Type: string
Constraints: Read Only, Restart Required
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.
Type: string
The number of seconds the Node Manager should wait before restarting this server.
After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails.
If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.
Type: int
Constraints: Has Default Value: 3600, Minimum Value: 300, Maximum Value: 2147483647
The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.
Type: int
Constraints: Has Default Value: 2, Minimum Value: 0, Maximum Value: 2147483647
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The NodeManager does not directly create the command to start a SystemComponent. This is done through a plugin architecture. So the following properties are not used when starting a SystemComponent from the NodeManager: #getJavaVendor #getJavaHome #getClassPath #getMWHome #getArguments
The properties of the weblogic.management.configuration.SystemComponentStartMBean entity are as follows:
The MWHome directory (path on the machine running Node Manager) to use when starting this server.
Specify the directory on the Node Manager machine under which all of Oracle's MW products were installed. For example, c:\Oracle\Middleware\
Type: string
The arguments to use when starting this server.
These are the first arguments appended immediately after java portion of the startup command. For example, you can set Java heap memory or specify any weblogic.nodemanager.server.provider.WeblogicCacheServer option.
Separate arguments with a space.
Type: string
The classpath (path on the machine running Node Manager) to use when starting this server.
If you need to add user classes to the classpath, in addition you will need to add the following: FEATURES_HOME/weblogic.server.modules.coherence.server_10.3.4.0.jar:COHERENCE_HOME/lib/coherence.jar
where FEATURES_HOME is the features directory (typically $MW_HOME/modules/features) and COHERENCE_HOME the coherence directory (typically $MW_HOME/coherence_3.6) on the Node Manager machine. If you do not specify a classpath the above will be used automatically.
The operating system determines which character separates path elements. On Windows, use a semicolon (;). On UNIX a colon (:).
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The Java home directory (path on the machine running Node Manager) to use when starting this server.
Specify the parent directory of the JDK's bin directory. For example, c:\bea\jdk141
Type: string
The Java Vendor value to use when starting this server.
If the server is part of a cluster and configured for automatic migration across possibly different platforms with different vendors providing the JDKs, then, both JavaVendor and JavaHome should be set in the generated configuration file instead.
Type: string
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
Type: string
Constraints: Read Only, Legal Null: true
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.
Type: string
The directory that this server uses as its root directory. This directory must be on the computer that hosts the Node Manager. If you do not specify a Root Directory value, the domain directory is used by default.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class represents a Transaction Log JDBC Store configuration.
The properties of the weblogic.management.configuration.TransactionLogJDBCStoreMBean entity are as follows:
Overrides the name of the XAResource that this store registers with JTA.
You should not normally set this attribute. Its purpose is to allow the name of the XAResource to be overridden when a store has been upgraded from an older release and the store contained prepared transactions. The generated name should be used in all other cases.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: null, Legal Null: true
Advanced use only: gets the connection caching policy for the JDBC store.
The return values will be one of:
JMSConstants.JDBCSTORE_CONNECTION_CACHING_POLICY_DEFAULT ("DEFAULT")
JMSConstants.JDBCSTORE_CONNECTION_CACHING_POLICY_MINIMAL ("MINIMAL")
JMSConstants.JDBCSTORE_CONNECTION_CACHING_POLICY_NONE ("NONE")
IMPORTANT: See the below for additional usage information, particularly regarding NONE
DEFAULT
The default mode of operation for the JDBC store. The JDBC store will open two connections to the database and it will keep these connections open for the life of the store. In addition, if the worker count for the store is two or more, then it will open one connection for each of the workers and those connections will also stay open for the life of the JDBC store. If the worker count is 3 then the JDBC store will use 5 database connections. If the worker count is the default of 1 then the JDBC store will use just 2 connections.The DEFAULT setting is the recommended setting to be used when the database backing the JDBC store is not constrained with respect to the number of open connections.
MINIMAL
The JDBC store will open one connection to the database and it will keep that connection open for the life of the store. In addition, if the worker count for the store is two or more, then it will open one connection for each of the workers and those connections will also stay open for the life of the JDBC store. If the worker count is 3 then the JDBC store will use 4 database connections. If the worker count is the default of 1 then the JDBC store will use just 1 connection. The MINIMAL setting may result in a slight reduction of through-put for low concurrency messaging scenarios in comparison to DEFAULT.
NONE
The NONE connection caching policy is for 'advanced usage only'. The JDBC store will open one connection to the database on an as-needed basis to perform I/O and it will release that connection when the operation is complete. The NONE value is not compatible with a configured worker count of 2 or more and will result in a configuration validation exception. The NONE setting may result in a slight reduction of through-put for low concurrency messaging scenarios in comparison to DEFAULT or MINIMAL.
NOTE: It is strongly recommended that a JDBC store be configured with a dedicated data source when the store is configured with the NONE connection caching policy. A store that shares a data source with other non-store components or applications runs the risk of failing due to dead-locks. Please note that a JDBC store will require more than one connection when first started. As such, a data source should be configured to grow and shrink so that the JDBC store can initialize.
Type: string
Constraints: Restart Required, Has Default Value: DEFAULT, Legal Values: DEFAULT, MINIMAL, NONE
Specifies the DDL (Data Definition Language) file to use for creating the JDBC store's backing table.
This field is ignored when the JDBC store's backing table, WLStore, already exists.
If a DDL file is not specified and the JDBC store detects that a backing table doesn't already exist, the JDBC store automatically creates the table by executing a preconfigured DDL file that is specific to the database vendor. These preconfigured files are located in the weblogic\store\io\jdbc\ddl directory of the MIDDLEWARE_HOME\modules\com.bea.core.store.jdbc_x.x.x.x.jar file.
If a DDL file is specified and the JDBC store detects that a backing table doesn't already exist, then the JDBC store searches for the DDL file in the file path first, and then if the file is not found, it searches for it in the CLASSPATH. Once found, the SQL within the DDL file is executed to create the JDBC store's database table. If the DDL file is not found and the backing table doesn't already exist, the JDBC store will fail to boot.
Type: string
Constraints: Restart Required, Has Default Value: null
The JDBC data source used by this JDBC store to access its backing table.
The specified data source must use a non-XA JDBC driver since connection pools for XA JDBC drivers are not supported.
Type: weblogic.management.configuration.JDBCSystemResourceMBean reference
Constraints: Restart Required
The maximum number of table rows that are deleted per database call.
When possible, a JDBC store uses JDBC 3.0 batching to batch concurrent client requests.
Both the maximum batch size for concurrent inserts and for concurrent writes are configurable.
To disable JDBC 3.0 batching, set the maximum batch size to 1.
The maximum batch size has no effect on the maximum number of concurrent client requests.
Type: int
Constraints: Restart Required, Has Default Value: 20, Minimum Value: 1, Maximum Value: 100
The maximum number of table rows that are deleted per database call.
Applies only when a JDBC store does not use JDBC 3.0 batching to batch concurrent client requests.
The maximum deletes per statement has no effect on the maximum number of concurrent client requests.
For some databases, the JDBC store may choose a lower value than the one configured.
Type: int
Constraints: Restart Required, Has Default Value: 20, Minimum Value: 1, Maximum Value: 100
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Specifies how the instances of a configured JMS artifact are named and distributed when deployed to a cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Distributed creates an artifact instance on each cluster member in a cluster. Required for all SAF Agents and for cluster targeted or resource group scoped JMS Servers that host distributed destinations.
Singleton creates one artifact instance on a single cluster member of a cluster. Required for cluster targeted or resource group scoped JMS Servers that host standalone (non-distributed) destinations and for cluster targeted or resource group scoped Path Services. The Migration Policy must be On-Failure or Always when using this option with a JMS Server, On-Failure when using this option with a Messaging Bridge, and Always when using this option with a Path Service.
The DistributionPolicy determines the instance name suffix for cluster targeted JMS artifacts. The suffix for a cluster targeted Singleton is -01 and for a cluster targeted Distributed is @ClusterMemberName.
Type: string
Constraints: Restart Required, Has Default Value: Distributed, Legal Values: Distributed, Singleton
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
When true, TLOGs are logged to a TLOG JDBC Store; otherwise, TLOGs are logged to the server's default store.
When using the Administration Console, select JDBC to enable logging of TLOGs to a JDBC store; select Default Store to enable logging of TLOGs to the server's default store.
Type: boolean
Constraints: Restart Required
Specifies the amount of time, in seconds, to delay before failing a cluster targeted JMS artifact instance back to its preferred server after the preferred server failed and was restarted.
This delay allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > specifies the time, in seconds, to delay before failing a JMS artifact back to its user preferred server.
A value of indicates that the instance would never failback.
A value of -1 indicates that there is no delay and the instance would failback immediately.
Note: This setting only applies when the JMS artifact is cluster targeted and the Migration Policy is set to On-Failure or Always>
Type: long
Constraints: Restart Required, Has Default Value: -1
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies the amount of time, in seconds, to delay before starting a cluster targeted JMS instance on a newly booted WebLogic server. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
This allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > is the time, in seconds, to delay before before loading resources after a failure and restart.
A value of specifies no delay.
Note: This setting only applies when the JMS artifact is cluster targeted and the Migration Policy is set to On-Failure or Always>
Type: long
Constraints: Restart Required, Has Default Value: 60
The maximum number of table rows that are inserted per database call.
When possible, a JDBC store uses JDBC 3.0 batching to batch concurrent client requests.
Both the maximum batch size for concurrent inserts and for concurrent writes are configurable.
To disable JDBC 3.0 batching, set the maximum batch size to 1.
The maximum batch size has no effect on the maximum number of concurrent client requests.
Type: int
Constraints: Restart Required, Has Default Value: 20, Minimum Value: 1, Maximum Value: 100
The name used by subsystems to refer to different stores on different servers using the same name.
For example, an EJB that uses the timer service may refer to its store using the logical name, and this name may be valid on multiple servers in the same cluster, even if each server has a store with a different physical name.
Multiple stores in the same domain or the same cluster may share the same logical name. However, a given logical name may not be assigned to more than one store on the same server.
Type: string
Constraints: Has Default Value: null, Legal Null: true
The maximum amount of time, in seconds, WebLogic Server tries to recover from a JDBC TLog store failure. If store remains unusable after this period, WebLogic Server set the health state to HEALTH_FAILED. A value of 0 indicates WebLogic Server does not conduct a retry and and immediately sets the health state as HEALTH_FAILED.
Type: int
Constraints: Has Default Value: 300, Minimum Value: 0, Maximum Value: 2147483647
The maximum amount of time, in seconds, WebLogic Server waits before trying to recover from a JDBC TLog store failure while processing a transaction. If store remains unusable after this amount of time, WebLogic Server throws an exception the affected transaction. A value of 0 indicates WebLogic Server does not conduct a retry and an exception will thrown immediately. The practical maximum value is a value less than the current value of MaxRetrySecondsBeforeTLogFail
Type: int
Constraints: Has Default Value: 60, Minimum Value: 0, Maximum Value: 300
Controls migration and restart behavior of cluster targeted JMS service artifact instances. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Off disables migration and restart support for cluster targeted JMS service objects, including the ability to restart a failed persistent store instance and its associated services. This policy can not be combined with the Singleton Migration Policy.
On-Failure enables automatic migration and restart of instances on the failure of a subsystem Service or WebLogic Server instance, including automatic fail-back and load balancing of instances.
Always provides the same behavior as On-Failure and automatically migrates instances even in the event of a graceful shutdown or a partial cluster start.
Note: Cluster leasing must be configured for On-Failure and Always
Type: string
Constraints: Restart Required, Has Default Value: Off, Legal Values: Off, On-Failure, Always
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies the number of restart attempts before migrating a failed JMS artifact instance to another server in the WebLogic cluster.
A value > specifies the number of restart attempts before migrating a failed service instance.
A value of specifies the same behavior as setting getRestartInPlace to false
A value of -1 specifies the service is never migrated. Instead, it continues to attempt to restart until it either starts or the server instance shuts down.
Type: int
Constraints: Restart Required, Has Default Value: 6
Enables committing a batch of INSERT or DELETE operations with the last operation of the transaction instead of issuing a separate commit call to database server which saves a server round trip. This feature benefits applications that have many transactions of a small number of operations or small messages. This feature should be used only when configuring a JDBC store in Oracle Exalogic environments.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies the amount of time, in seconds, to delay before a partially started cluster starts all cluster targeted JMS artifact instances that are configured with a Migration Policy of Always or On-Failure.
Before this timeout expires or all servers are running, a cluster starts a subset of such instances based on the total number of servers running and the configured cluster size. Once the timeout expires or all servers have started, the system considers the cluster stable and starts any remaining services.
This delay ensures that services are balanced across a cluster even if the servers are started sequentially. It is ignored once a cluster is fully started (stable) or when individual servers are started.
A value > specifies the time, in seconds, to delay before a partially started cluster starts dynamically configured services.
A value of specifies no delay.
Type: long
Constraints: Restart Required, Has Default Value: 240
When using multiple TLOG JDBC stores, use this attribute to create a label ending in "_" that is prepended to the name of the server hosting the JDBC TLOG store and ends in "_" to form a unique JDBC TLOG store name for each configured JDBC TLOG store.
The default prefix name is "TLOG_" . For example, a valid JDBC TLOG store name using the default Prefix Name is TLOG_MyServer_ where TLOG_ is the Prefix Name and MyServer is the name of the server hosting the JDBC TLOG store.
Type: string
The length of time in milliseconds between reconnection attempts during the reconnection retry period.
The reconnection interval applies to JDBC connections regardless of the database that is used for the JDBC store.
The default value is 200 milliseconds
Type: int
Constraints: Restart Required, Has Default Value: 200, Minimum Value: 100, Maximum Value: 10000
Returns the length of time in milliseconds during which the persistent store will attempt to re-establish a connection to the database. Successive reconnection attempts will be attempted after a fixed delay that is specified by the reconnection retry interval.
The reconnection period applies to JDBC connections regardless of the database that is used for the JDBC store.
The default value is 1000
Type: int
Constraints: Restart Required, Has Default Value: 1000, Minimum Value: 200, Maximum Value: 300000
Enables periodic automatic restart of failed cluster targeted JMS artifact instance(s) running on healthy WebLogic Server instances. Restart attempts occur before attempts to migrate an instance to a different server in the cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
Restarts occur when Restart In Place is set to true, the JMS artifact is cluster targeted, and the Migration Policy is set to On-Failure or Always>
This attribute is not used by WebLogic Messaging Bridges which automatically restart internal connections as needed.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The amount of time, in seconds, WebLogic Server waits before attempting to verify the health of the TLOG store after a store failure has occurred.
Type: int
Constraints: Has Default Value: 5, Minimum Value: 1, Maximum Value: 60
Specifies the amount of time, in seconds, to wait in between attempts to restart a failed service instance.
Type: int
Constraints: Restart Required, Has Default Value: 30
Return all tags on this Configuration MBean
Type: array of string
The server instances, clusters, or migratable targets defined in the current domain that are candidates for hosting a file store, JDBC store, or replicated store. If scoped to a Resource Group or Resource Group Template, the target is inherited from the Virtual Target.
When selecting a cluster, the store must be targeted to the same cluster as the JMS server. When selecting a migratable target, the store must be targeted it to the same migratable target as the migratable JMS server or SAF agent. As a best practice, a path service should use its own custom store and share the same target as the store.
Type: array of weblogic.management.configuration.TargetMBean references
Specifies the threshold, in bytes, when the JDBC store uses 3 steps (insert, select, populate) instead of 1 step (insert) to populate an Oracle Blob data type.
Applies only to Oracle databases where a Blob data type is used instead of the default Long Raw data type for record data.
The default value is 200000.
Type: int
Constraints: Restart Required, Has Default Value: 200000, Minimum Value: 4000, Maximum Value: 2147483647
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The number of JDBC store worker threads to process the workerload.
A value of 1 indicates a single thread is used (the default).
A value greater than 1 indicates that multiple threads are used.
For Oracle databases, Oracle recommends users rebuild the primary key index into a reverse index for the JDBC Store table when the worker count is greater than 1.
For non-Oracle databases, refer to the database provider's documentation for help with indexing.
Type: int
Constraints: Restart Required, Has Default Value: 1, Minimum Value: 1, Maximum Value: 1000
Specifies the batch size when the Worker Count attribute is configured to a value greater than 1.
Used to configure the workload the JDBC store incrementally puts on each worker thread. The workload consists of IO requests which are grouped and pushed to each JDBC worker thread for processing. If the IO request is very large (for example 1M), then tune this attribute to a smaller value.
Type: int
Constraints: Restart Required, Has Default Value: 10, Minimum Value: 1, Maximum Value: 2147483647
This mbean is used to configure a Trigger (Usage limit) based policy for a resource type.
The properties of the weblogic.management.configuration.TriggerMBean entity are as follows:
Gets the configured recourse action that needs to be taken when the usage of resource crosses the value specified in getValue().
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Gets the upper-limit value of the resource assigned to the Trigger configuration.
Type: long
Constraints: Minimum Value: 1
This bean represents the configuration of virtual web server within a WebLogic Server instance. Note that a server may define multiple web servers to support virtual hosts.
This MBean represents a virtual host.
The properties of the weblogic.management.configuration.VirtualHostMBean entity are as follows:
Indicates whether the session ID should include JVM information. (Checking this box may be necessary when using URL rewriting with WAP devices that limit the size of the URL to 128 characters, and may also affect the use of replicated sessions in a cluster.) When this box is selected, the default size of the URL will be set at 52 characters, and it will not contain any special characters.
Gets the WAPEnabled attribute of the WebServerMBean object
Type: boolean
Constraints: Has Default Value: false
Indicates whether this server allows the inclusion of the context path in the virtual path to context.getRealPath(). (If checked, you cannot use sub directories with the same name as contextPath). This is a compatibility switch that will be deprecated 9.0.0.0 in future releases.
Gets the acceptContextPathInGetRealPath attribute of the WebServerMBean object
Type: boolean
Constraints: Restart Required, Has Default Value: false
Whether authcookie feature is enabled or not.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: true
Indicates whether the use of Chunk Transfer-Encoding in HTTP/1.1 is enabled.
Type: boolean
Constraints: Has Default Value: false
Get the Client IP Header from WebSerevrMBean.
Type: string
Returns the original context-root for the default Web application for this Web server. Alternatively, you can use the context-root attributes in application.xml or weblogic.xml to set a default Web application. The context-root for a default Web application is /. If "" (empty string) is specified, the Web server defaults to /.
Type: string
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The name of the HTTP port to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.
Sets the frontendHTTPPort Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.
Type: int
Constraints: Has Default Value: 0
The name of the secure HTTP port to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.
Sets the frontendHTTPSPort Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.
Type: int
Constraints: Has Default Value: 0
The name of the host to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.
Sets the HTTP frontendHost Provides a method to ensure that the webapp will always have the correct HOST information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.
Type: string
Constraints: Has Default Value: null
The amount of time this server waits before closing an inactive HTTPS connection.
Number of seconds to maintain HTTPS keep-alive before timing out the request.
Type: int
Constraints: Has Secure Value: 60, Has Default Value: 60, Minimum Value: 30, Maximum Value: 360
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Indicates whether there should be a persistent connection to this server. (This may improve the performance of your Web applications.)
Gets the keepAliveEnabled attribute of the WebServerMBean object
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: true
The amount of time this server waits before closing an inactive HTTP connection.
Number of seconds to maintain HTTP keep-alive before timing out the request.
Type: int
Constraints: Has Secure Value: 30, Has Default Value: 30, Minimum Value: 5, Maximum Value: 3600
The maximum post size this server allows for reading HTTP POST data in a servlet request.
A value less than 0 indicates an unlimited size.
Gets the maxPostSize attribute of the WebServerMBean object
Type: int
Constraints: Has Default Value: -1
Max Post Time (in seconds) for reading HTTP POST data in a servlet request. MaxPostTime < 0 means unlimited
Gets the maxPostTimeSecs attribute of the WebServerMBean object
Type: int
Constraints: Has Default Value: -1
Max Request Parameter Count this server allows for reading maximum HTTP POST Parameters count in a servlet request.
Gets the maxRequestParameterCount attribute of the WebServerMBean object
Type: int
Constraints: Has Default Value: 10000
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
The dedicated server channel name (NetworkAccessPoint) for which this virtual host will serve http request. If the NetworkAccessPoint for a given http request doesn't match any virtual host's NetworkAccessPoint, incoming HOST header will be matched with the VirtualHostNames in order to resolve the right virtual host.
Type: string
Constraints: Restart Required
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.
Type: string
Get the response code to be used when an application is overloaded. An application can get overloaded when the number of pending requests has reached the max capacity specified in the WorkManager or when the server is low on memory. The low memory condition is determined using OverloadProtectionMBean#getFreeMemoryPercentLowThreshold().
Type: int
Constraints: Has Default Value: 503, Minimum Value: 100, Maximum Value: 599
Timeout (in seconds) for reading HTTP POST data in a servlet request. If the POST data is chunked, the amount of time the server waits between the end of receiving the last chunk of data and the end of receiving the next chunk of data in an HTTP POST before it times out. (This is used to prevent denial-of-service attacks that attempt to overload the server with POST data.)
Gets the postTimeoutSecs attribute of the WebServerMBean object
Type: int
Constraints: Has Secure Value: 30, Has Default Value: 30, Minimum Value: 0, Maximum Value: 120
Indicates whether this server name is sent with the HTTP response. (This is useful for wireless applications where there is limited space for headers.)
Indicates whether this server instance includes its name and WebLogic Server version number in HTTP response headers.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Indicates whether the singleSignonDisabled attribute is enabled
Type: boolean
Constraints: Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Enables use of the highest compatible HTTP protocol version-string in the response. E.g. HTTP spec suggests that HTTP/1.1 version-string should be used in response to a request using HTTP/1.0. This does not necessarily affect the response format.
Type: boolean
Constraints: Has Default Value: true
The list of host names, separated by line breaks, for which this virtual host will serve requests.
Type: array of string
Constraints: Restart Required
The default size of the blocks to be written to the network layer.
Gets the writeChunkBytes attribute of the WebServerMBean object
Type: int
Constraints: Read Only, Has Default Value: 512
This bean represents a target for a resource group in a partition. It defines access point to resources, i.e. hostname, port, partition uri path. Moreover, it provide configurations for each protocol, for example, http, t3, ssl, iiop etc.
The properties of the weblogic.management.configuration.VirtualTargetMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Get the explicit port for this virtual target.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 65535
Host names, separated by line breaks, for which this virtual target will serve requests.
Type: array of string
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The channel name to be used as a reference for creating a partition specific channel.
Type: string
Constraints: Has Default Value: PartitionChannel
The port offset for this virtual target. If set to the minimum value, the port offset is not set.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 65535
Return all tags on this Configuration MBean
Type: array of string
You must select a target from this list of the targets in the current domain. Targets must be either servers or clusters. The deployment will only occur once if the targets overlap. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on server S only once.
Type: array of weblogic.management.configuration.TargetMBean references
Constraints: Restart Required
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The URI prefix for this virtual target.
Type: string
Constraints: Has Default Value: /
This MBean specifies how data retirement for a WLDF archive will be performed based on the age of records in WLDF archives.
The properties of the weblogic.management.configuration.WLDFDataRetirementByAgeMBean entity are as follows:
Name of the archive for which data retirement is configured
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Enable data retirement
Type: boolean
Constraints: Has Default Value: true
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Retirement age for records in hours. Older records will be eligible for deletion.
Type: int
Constraints: Has Default Value: 72, Minimum Value: 1
This attribute specifies the period in hours at which the data retirement task will be periodically performed for the archive during the day after it is first executed. The value of this attribute must be positive
Type: int
Constraints: Has Default Value: 24, Minimum Value: 1
This attribute specifies the hour of day at which the data retirement task will first run during the day.
Type: int
Constraints: Has Default Value: 0
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Use this interface to configure the WebLogic Diagnostic Framework (WLDF) components that are defined for each WebLogic Server instance.
The properties of the weblogic.management.configuration.WLDFServerDiagnosticMBean entity are as follows:
This attribute specifies the WLDF built-in system resource type in use for this server.
This attribute has the following settings:
None No WLDF built-in system resource in use.
Low The Low WLDF built-in system resource. This is the default.
Medium The Medium built-in system resource.
High The High built-in system resource.
Type: string
Constraints: Has Default Value: None, Has Production Mode Default Value: Low, Legal Values: None, Low, Medium, High
Return the WLDFDataRetirementMBeans parented by this WLDFServerDiagnosticMBean.
Type: array of weblogic.management.configuration.WLDFDataRetirementMBean references
Constraints: Read Only, Restart Required
Specifies the volume of diagnostic data that is automatically produced by WebLogic Server at run time. Note that the WLDF diagnostic volume setting does not affect explicitly configured diagnostic modules. For example, this controls the volume of events generated for Flight Recorder.
This attribute has the following settings:
Off No diagnostic data is produced.
Low Minimal amounts of automatic diagnostic data are produced. This is the default.
Medium Additional diagnostic data is automatically generated beyond the amount generated for Low
High Additional diagnostic data is automatically generated beyond the amount generated for Medium
Type: string
Constraints: Has Default Value: Low, Legal Values: Off, Low, Medium, High
This attribute controls if configuration based data retirement functionality is enabled on the server. If disabled, all retirement policies will be disabled.
Type: boolean
Constraints: Has Default Value: true
Determines whether the current server persists its harvested metrics and event data in a diagnostic store (file-based store) or a JDBC based archive. The default store is file-based.
Type: string
Constraints: Restart Required, Has Default Value: FileStoreArchive, Legal Values: FileStoreArchive, JDBCArchive
Directory where heap and thread dumps will be generated by actions. This directory is a relative path with respect to the server directory
Type: string
Constraints: Has Default Value: logs/diagnostic_dumps
The JDBC data source that the server uses to archive its harvested metrics and event data.
Type: weblogic.management.configuration.JDBCSystemResourceMBean reference
Constraints: Restart Required
The schema name to use for accessing JDBC-based archive tables.
If multiple WLDF JDBC archive schemas exist in the same database, this value specifies the correct schema to use for accessing JDBC-based archive tables in that database.
There is no default value. If a schema name is not specified, no schema name is applied when WLDF validates the run-time table or is used for the SQL statements.
Type: string
Constraints: Restart Required
The smallest addressable block, in bytes, of a file. When a native wlfileio driver is available and the block size has not been configured by the user, the store selects the minimum OS specific value for unbuffered (direct) I/O, if it is within the range [512, 8192].
A file store's block size does not change once the file store creates its files. Changes to block size only take effect for new file stores or after the current files have been deleted. See "Tuning the Persistent Store" in Performance and Tuning for Oracle WebLogic Server
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 8192
The directory in which the current server maintains its diagnostic store.
Type: string
Constraints: Restart Required, Has Default Value: data/store/diagnostics
Determines whether OS file locking is used.
When file locking protection is enabled, a store boot fails if another store instance already has opened the store files. Do not disable this setting unless you have procedures in place to prevent multiple store instances from opening the same file. File locking is not required but helps prevent corruption in the event that two same-named file store instances attempt to operate in the same directories. This setting applies to both primary and cache files.
Type: boolean
Constraints: Restart Required, Has Default Value: true
The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2, controls the largest write size.
When a native wlfileio driver is available, the setting applies to off-heap (native) memory.
When a native wlfileio driver is not available, the setting applies to JAVA heap memory.
For the best runtime performance, Oracle recommends setting DiagnosticStoreIOBufferSize so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).
See AllocatedIOBufferBytes to find out the actual allocated off-heap (native) memory amount. It is a multiple of IOBufferSize
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 67108864
The maximum file size, in bytes.
The DiagnosticStoreMaxFileSize value affects the number of files needed to accommodate a diagnostic store of a particular size (number of files = diagnostic store size/MaxFileSize rounded up).
A diagnostic store automatically reuses space freed by deleted records and automatically expands individual files up to DiagnosticStoreMaxFileSize if there is not enough space for a new record. If there is no space left in exiting files for a new record, a diagnostic store creates an additional file.
A small number of larger files is normally preferred over a large number of smaller files as each file allocates Window Buffer and file handles.
If DiagnosticStoreMaxFileSize is larger than 2^24 * DiagnosticStoreBlockSize, then DiagnosticStoreMaxFileSize is ignored, and the value becomes 2^24 * DiagnosticStoreBlockSize. The default DiagnosticStoreBlockSize is 512, and 2^24 * 512 is 8 GB.
Oracle recommends not setting the Diagnostic Store Max File Size above the default value of 1,342,177,280.
Type: long
Constraints: Restart Required, Has Default Value: 1342177280, Minimum Value: 10485760
The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per diagnostic store file. Applies only when a native wlfileio library is loaded.
A window buffer does not consume Java heap memory, but does consume off-heap (native) memory. If the store is unable to allocate the requested buffer size, it allocates smaller and smaller buffers until it reaches DiagnosticStoreMinWindowBufferSize, and then fails if it cannot honor DiagnosticStoreMinWindowBufferSize
Oracle recommends setting the max window buffer size to more than double the size of the largest write (multiple concurrently updated records may be combined into a single write), and greater than or equal to the file size, unless there are other constraints. 32-bit JVMs may impose a total limit of between 2 and 4GB for combined Java heap plus off-heap (native) memory usage.
Type: int
Constraints: Restart Required, Has Default Value: 4194304, Minimum Value: -1, Maximum Value: 1073741824
The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per diagnostic store file. Applies only when a native wlfileio library is loaded. See Diagnostic Store Maximum Window Buffer Size
Type: int
Constraints: Restart Required, Has Default Value: -1, Minimum Value: -1, Maximum Value: 1073741824
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The interval, in milliseconds, at which queued up instrumentation events will be periodically dispatched to the archive.
Type: long
Constraints: Has Default Value: 5000
The time span, in milliseconds, for which recently archived events will be captured in the diagnostic image. All events archived on or after ( System.currentTimeMillis() - interval ) will be captured.
Type: long
Constraints: Has Default Value: 60000
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The default directory where the server stores captured diagnostic images.
If you specify a relative pathname, the root of that path is the server's root directory.
If the directory does not exist, it will be created when the WebLogic Diagnostic Framework is initialized on the server. Note that each image capture request can override this default directory location.
Type: string
The default timeout period, in minutes, that the server uses to delay future diagnostic image-capture requests.
Type: int
Constraints: Has Default Value: 1, Minimum Value: 0, Maximum Value: 1440
Returns the maximum number of heap dump files to be retained which are generated by heap dump actions. If this limit is reached, oldest heap dumps will be deleted while creating new heap dump so that this limit is not exceeded.
Type: int
Constraints: Has Default Value: 8, Minimum Value: 1, Maximum Value: 50
Returns the maximum number of thread dump files to be retained which are generated by thread dump actions. If this limit is reached, oldest thread dump files will be deleted while creating new thread dump file so that this limit is not exceeded.
Type: int
Constraints: Has Default Value: 100, Minimum Value: 1, Maximum Value: 1000
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return the preferred limit on the size of diagnostic store file in MB.
Type: int
Constraints: Has Default Value: 100, Minimum Value: 10
Return the period in hours at which diagnostic store file size check will be performed
Type: int
Constraints: Has Default Value: 1, Minimum Value: 1
Specifies the instrumentation events persistence policy. If true, events will be persisted synchronously within the same thread. If false, events will be queued up to be persisted in a separate thread.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean defines a system-level WebLogic Diagnostic Framework (WLDF) resource. It links a separate descriptor that specifies the definition.
The properties of the weblogic.management.configuration.WLDFSystemResourceMBean entity are as follows:
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.
Type: string
Constraints: Restart Required
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.
Type: int
Constraints: Restart Required, Has Default Value: 100
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.
Type: string
Constraints: Restart Required
Optional short description of this WLDFSystemResource. If provided, the WebLogic Server Administration Console will display the resource description.
Type: string
Constraints: Has Default Value: null
The name of the descriptor file that contains the XML configuration information for this system-level resource. The location of this file is a relative path rooted at DOMAIN_DIR/config. By default the file resides in the DOMAIN_DIR/config/diagnostics directory, and derives its name from the bean name using the following pattern:
<beanName>.xml
Note that the filename is a read-only property, which is set when the WLDF resource is created.
Type: string
Constraints: Read Only, Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The values match those defined by jsr88. This attribute may move to another MBean.
Type: string
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return the Descriptor for the system resource. This should be overridden by the derived system resources.
Type: weblogic.descriptor.DescriptorBean reference
Constraints: Read Only, Restart Required
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This class represents the reliable messaging delivery policy for the current WebLogic Server as both a sender and a receiver of a reliable SOAP message to and from a Web service running on a different WebLogic Server.
Reliable messaging is a framework for applications running in WebLogic Server to asynchronously and reliably invoke a Web service running in a different WebLogic Server. Reliable messaging works only between WebLogic Servers. This class encapsulates the default reliable messaging parameters for an application running in this WebLogic Server instance that both sends and receives a SOAP message reliably. These parameters include the number of times to retry sending the message, the time to wait between retries, the persistent store for the reliable message, and so on.
The properties of the weblogic.management.configuration.WSReliableDeliveryPolicyMBean entity are as follows:
The JMS server used by WebLogic Server, in its role as a sender, to persist the reliable messages that it sends, or the JMS server used by the receiver WebLogic Server to persist the history of a reliable message sent by a sender.
Type: weblogic.management.configuration.JMSServerMBean reference
Constraints: Restart Required
The default maximum number of times that the sender runtime should attempt to redeliver a message that the receiver WebLogic Server has not yet acknowledged.
The default maximum number of times that the sender should attempt to redeliver a message that the receiver WebLogic Web service has not yet acknowledged.
Type: int
Constraints: Restart Required, Has Default Value: 10
The default minimum number of seconds that the sender runtime should wait between retries if the receiver does not send an acknowledgement of receiving the message, or if the sender runtime detects a communications error while attempting to send a message.
The default minimum number of seconds that the sender should wait between retries if the receiver does not send an acknowledgement of receiving the message, or if the sender detects a communications error while attempting to send a message.
Type: int
Constraints: Restart Required, Has Default Value: 6
The default number of seconds that the receiver of the reliable message should persist the history of the reliable message in its store.
The default minimum number of seconds that the receiver of the reliably sent message should persist the message in its storage.
If the DefaultTimeToLive number of message have passed since the message was first sent, the sender should not resent a message with the same message id.
If a sender cannot send a message successfully before the DefaultTimeToLive has passed, the sender should report a delivery failure. The receiver, after recovering from a crash, will not dispatch saved messages that have expired.
Type: int
Constraints: Restart Required, Has Default Value: 360
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This interface provides access to the WTC export configuration attributes. The methods defined herein are applicable for WTC configuration at the WLS domain level.
The properties of the weblogic.management.configuration.WTCExportMBean entity are as follows:
The complete name of the EJB home interface to use when invoking a service.
If not specified, the default interface used is tuxedo.services.servicenameHome. For example: If the service being invoked is TOUPPER and EJBName attribute is not specified, the home interface looked up in JNDI would be tuxedo.services.TOUPPERHome
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The name of the local access point that exports this service.
Type: string
Constraints: Has Default Value: myLAP, Legal Null: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The remote name of this service.
If this value is not specified, the ResourceName value is used.
Type: string
The name used to identify an exported service.
The combination of ResourceName and LocalAccessPoint must be unique within defined Exports. This allows you to define unique configurations having the same ResourceName.
Type: string
Constraints: Has Default Value: myExport, Legal Null: true
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This interface provides access to the WTC import configuration attributes. The methods defined herein are applicable for WTC configuration at the WLS domain level.
The properties of the weblogic.management.configuration.WTCImportMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The name of the local access point that offers this service.
Type: string
Constraints: Has Default Value: myLAP, Legal Null: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The comma-separated failover list that identifies the remote domain access points through which resources are imported.
For example: TDOM1,TDOM2,TDOM3
Type: string
Constraints: Has Default Value: myRAP, Legal Null: true
The remote name of this service.
Note: If not specified, the ResourceName value is used.
Type: string
The name used to identify this imported service.
Note: This name must be unique within defined Imports. This allows you to define unique configurations having the same Remote Name.
Type: string
Constraints: Has Default Value: myImport, Legal Null: true
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This interface provides access to the WTC local Tuxedo Domain configuration attributes. The methods defined herein are applicable for WTC configuration at the WLS domain level.
The properties of the weblogic.management.configuration.WTCLocalTuxDomMBean entity are as follows:
The network address and port number of this local Tuxedo access point.
Specify the address in one of the following formats:
TCP/IP address in the format //hostname:port_number or //#.#.#.#:port_number
SDP address in the format sdp://hostname:port_number or sdp://#.#.#.#:port_number
Notes:
If the hostname is used, the access point finds an address for hostname using the local name resolution facilities (usually DNS). If dotted decimal format is used, each # should be a number from 0 to 255. This dotted decimal number represents the IP address of the local machine. The port_number is the TCP/SDP port number at which the access point listens for incoming requests.
If SDP format address is specified, the transport protocol for this access point is SDP instead of TCP. This feature is only available when WTC and Tuxedo domain gateway are both deployed on Oracle Exalogic platform. Requires Tuxedo 11gR1PS2 and higher.
Type: string
Constraints: Has Default Value: //localhost:8901
The unique name used to identify this local Tuxedo access point. This name should be unique for all local and remote Tuxedo access points defined within a WTC Service. This allows you to define unique configurations having the same Access Point ID.
Type: string
Constraints: Has Default Value: myLAP, Legal Null: true
The connection principal name used to identify this local Tuxedo access point when attempting to establish a session connection with remote Tuxedo access points.
Note: The AccessPointId must match the corresponding DOMAINID in the *DM_REMOTE_DOMAINS section of your Tuxedo DMCONFIG file.
Type: string
Constraints: Has Default Value: myLAPId, Legal Null: true
The maximum number of seconds this local Tuxedo access point allows for a blocking call.
Range of Values: Between and a positive 32 bit integer.
Type: long
Constraints: Has Default Value: 60, Minimum Value: 0, Maximum Value: 2147483647
The compression threshold this local Tuxedo access point uses when sending data to a remote Tuxedo access point. Application buffers larger than this size are compressed.
Range of Values: Between and a positive 32-bit integer.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
The principal name used to verify the identity of this domain when establishing a connection to another domain.
Note: This parameter only applies to domains of type TDOMAIN that are running Oracle Tuxedo 7.1 or later software. If not specified, the connection principal name defaults to the AccessPointID for this domain.ConnPrincipalName
Note: ConnPrincipalName is not supported in this release.
Type: string
The conditions under which this local Tuxedo access point establishes a session connection with a remote Tuxedo access point.
The connection policies are:
ON_DEMAND: A connection is attempted only when requested by either a client request to a remote service or an administrative connect command.
ON_STARTUP: A domain gateway attempts to establish a connection with its remote Tuxedo access points at gateway server initialization time. Remote services (services advertised in JNDI by the domain gateway for this local access point) are advertised only if a connection is successfully established to that remote Tuxedo access point. If there is no active connection to a remote Tuxedo access point, then the remote services are suspended. By default, this connection policy retries failed connections every 60 seconds. Use the MaxRetry and RetryInterval values to specify application specific values.
INCOMING_ONLY: A domain gateway does not attempt an initial connection to remote Tuxedo access points at startup and remote services are initially suspended. The domain gateway is available for incoming connections from remote Tuxedo access points and remote services are advertised when the domain gateway for this local Tuxedo access point receives an incoming connection. Connection retry processing is not allowed.
Type: string
Constraints: Has Default Value: ON_DEMAND, Legal Values: ON_DEMAND, ON_STARTUP, INCOMING_ONLY
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The path and file name of the identity keystore.
The path name must either be absolute or relative to where the server was booted. The identity key store file name is only used if KeystoreLocation is "Custom Stores".
Type: string
Constraints: Has Default Value: null
The custom identity keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is "Custom Stores".
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the IdentityKeyStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the CustomIdentityKeyStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (CustomIdentityKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use CustomIdentityKeyStorePassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
Specifies whether this local Tuxedo access point interoperates with remote Tuxedo access points that are based upon Tuxedo release 6.5. If this value is set to Yes, the local Tuxedo access point interoperates with a Tuxedo 6.5 domain.
Type: string
Constraints: Has Default Value: No, Legal Values: Yes, No
Return value tells whether this local Tuxedo access point is configured with Application Level Keep Alive, and it maximum idle time value before wait timer start ticking.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
Return value that tells whether this local Tuxedo access point requires the acknowledgement of Application Level Keep Alive, and how long it will wait without receiving acknowledgement before declare the connection is inaccessible.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
Provides the configuration rule to be used for finding Local Access Point's identity key store and trust key store. In plain text, it contains information on where the identity key store and trust key store are configured. When KeyStoreLocation is configured with WLS Store, WTC uses configuration information from the WLS Key Stores configuration. Otherwise, it uses the key stores information configured in the Local Access Point.
Type: string
Constraints: Has Default Value: Custom Stores, Legal Values: WLS Stores, Custom Stores
The maximum encryption key length (in bits) this local Tuxedo access point uses when establishing a session connection. A value of indicates no encryption is used.
Value Restrictions:
The MaxEncryptBits value must be greater than or equal to the MinEncrypBits value.
A MaxEncryptBits of 40 can be used only with domains running Tuxedo 7.1 or higher.
Type: string
Constraints: Has Secure Value: 128, Has Default Value: 128, Legal Values: 0, 40, 56, 128, 256
The maximum number of times that this local Tuxedo access point tries to establish a session connection to remote Tuxedo access points. Use this value only when Connection Policy is set to ON_STARTUP
Range of Values: Between and a positive 64 bit integer.
Note: Use the minimum value to disable the retry mechanism. Use the maximum value to try until a connection is established.
Type: long
Constraints: Has Default Value: 9223372036854775807, Minimum Value: 0, Maximum Value: 9223372036854775807
The minimum encryption key length (in bits) this local Tuxedo access point uses when establishing a session connection. A value of indicates no encryption is used.
Value Restrictions:
The MinEncrypBits value must be less than or equal to the MaxEncrypBits value.
A MinEncrypBits value of 40 can be used only with domains running Tuxedo 7.1 or higher.
Type: string
Constraints: Has Secure Value: 40, Has Default Value: 0, Legal Values: 0, 40, 56, 128, 256
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The string alias used to store and retrieve the Local Tuxedo access point's private key in the keystore. This private key is associated with the Local Tuxedo access point's digital certificate.
Type: string
Constraints: Has Default Value: null
The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the PrivateKeyPassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted passphrase as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the PrivateKeyPassPhraseEncrypted attribute to the encrypted value.
Using this attribute (PrivateKeyPassPhrase) is a potential security risk because the String object (which contains the unencrypted passphrase) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use getPrivateKeyPassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
The number of seconds that this local Tuxedo access point waits between automatic connection attempts to remote Tuxedo access points. Use this value only when Connection Policy is set to ON_STARTUP
Range of Values: Between 0 and a positive 32-bit integer.
Type: long
Constraints: Has Default Value: 60, Minimum Value: 0, Maximum Value: 2147483647
The type of application security enforced.
The types of security are:
NONE: No security is used.
APP_PW: Password security is enforced when a connection is established from a remote domain. The application password is defined in the WTCResourcesMBean.
DM_PW: Domain password security is enforced when a connection is established from a remote domain. The domain password is defined in the WTCPasswordsMBean.
Type: string
Constraints: Has Secure Value: DM_PW, Has Default Value: NONE, Legal Values: NONE, APP_PW, DM_PW
Return all tags on this Configuration MBean
Type: array of string
The path and file name of the trust keystore.
The path name must either be absolute or relative to where the server was booted. This file name is only used if KeyStores is "Custom Stores".
Type: string
Constraints: Has Default Value: null
The trust keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is "Custom Stores".
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the TrustKeyStorePassPhraseEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the TrustKeyStorePassPhraseEncrypted attribute to the encrypted value.
Using this attribute (TrustKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use TrustKeyStorePassPhraseEncrypted
Type: string
Constraints: Restart Required, Encrypted
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies if the connection initiated or accepted by this Local Tuxedo access point uses SSL on top of its transport layer. Values are:
Off: SSL not used.
TwoWay: Mutual Authentication with SSL required.
OneWay: Server Authentication with SSL required.
Note: If SDP transport is configured for this access point, the configured value of this attribute is ignored and off is used.
Type: string
Constraints: Has Default Value: Off, Legal Values: Off, TwoWay, OneWay
This interface provides access to the WTC password configuration attributes. The methods defined herein are applicable for WTC configuration at the WLS domain level.
The properties of the weblogic.management.configuration.WTCPasswordMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The name of the local access point to which this password applies.
Type: string
Constraints: Has Default Value: myLAP, Legal Null: true
The local password used to authenticate connections between the local access point and the remote access point.
Note: This password is used to authenticate connections between the local Tuxedo access point identified by LocalAccessPoint and the remote Tuxedo access point identified by RemoteAccessPoint.
Type: string
Constraints: Has Default Value: myLPWD, Legal Null: true
The initialization vector used to encrypt the local password.
Type: string
Constraints: Has Default Value: myLPWDIV, Legal Null: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The name of the remote access point to which this password applies.
Type: string
Constraints: Has Default Value: myRAP, Legal Null: true
The remote password used to authenticate connections between the local access point and remote access point.
Note: This password is used to authenticate connections between the local Tuxedo access point identified by LocalAccessPoint and the remote Tuxedo access point identified by RemoteAccessPoint.
Type: string
Constraints: Has Default Value: myRPWD, Legal Null: true
The initialization vector used to encrypt the remote password.
Type: string
Constraints: Has Default Value: myRPWDIV, Legal Null: true
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This interface provides access to the WTC remote Tuxedo Domain configuration attributes. The methods defined herein are applicable for WTC configuration at the WLS domain level.
The properties of the weblogic.management.configuration.WTCRemoteTuxDomMBean entity are as follows:
The network address and port number of this remote Tuxedo access point.
Specify the address in one of the following formats:
TCP/IP address in the format //hostname:port_number or //#.#.#.#:port_number
SDP address in the format sdp://hostname:port_number or sdp://#.#.#.#:port_number
Notes:
If the hostname is used, the access point finds an address for hostname using the local name resolution facilities (usually DNS). If dotted decimal format is used, each # should be a number from 0 to 255. This dotted decimal number represents the IP address of the local machine. The port_number is the TCP/SDP port number at which the access point listens for incoming requests.
If SDP format address is specified, the transport protocol for this access point is SDP instead of TCP. This feature is only available when WTC and Tuxedo domain gateway are both deployed on Oracle Exalogic platform. Requires Tuxedo 11gR1PS2 and higher.
Type: string
Constraints: Has Default Value: //localhost:8902
The unique name used to identify this remote Tuxedo access point. This name should be unique for all local and remote Tuxedo access points defined within a WTC Service. This allows you to define unique configurations having the same Access Point ID.
Type: string
Constraints: Has Default Value: myRAP, Legal Null: true
The connection principal name used to identify this remote domain access point when attempting to establish a session connection to local Tuxedo access points. This value must be globally unique among all interconnected Tuxedo and WTC Domains.
Type: string
Constraints: Has Default Value: myRAPId, Legal Null: true
The inbound access control list (ACL) policy toward requests from a remote Tuxedo access point.
The allowed values are:
LOCAL: The local Tuxedo access point modifies the identity of service requests received from a given remote Tuxedo access point to the principal name specified in the local principal name for a given remote Tuxedo access point.
GLOBAL: The local Tuxedo access point passes the service request with no change in identity.
Note: If Interoperate is set to Yes, AclPolicy is ignored.
Type: string
Constraints: Has Default Value: LOCAL, Legal Values: GLOBAL, LOCAL
Specifies whether the anonymous user is allowed to access remote Tuxedo services.
Note: If the anonymous user is allowed to access Tuxedo, the default AppKey will be used for TpUsrFile and LDAP AppKey plug-ins. Interaction with the Custom AppKey plug-in depends on the design of the Custom AppKey generator.
Type: boolean
Constraints: Has Default Value: false
Specifies the type of AppKey plug-in used.
The allowed values are:
TpUsrFile: TpUsrFile is the default plug-in. It uses an imported Tuxedo TPUSR file to provide user security information. Previous releases of WebLogic Tuxedo Connector support this option.
LDAP: The LDAP plug-in utilizes an embedded LDAP server to provide user security information. The user record must define the Tuxedo UID and GID information in the description field. This functionality is not supported in previous releases of WebLogic Tuxedo Connector.
Custom: The Custom plug-in provides the ability to write your own AppKey generator class to provide the security information required by Tuxedo. This functionality is not supported in previous releases of WebLogic Tuxedo Connector.
Type: string
Constraints: Has Default Value: TpUsrFile, Legal Values: TpUsrFile, LDAP, Custom
The compression threshold this remote Tuxedo access point uses when sending data to a local Tuxedo access point. Application buffers larger than this size are compressed.
Range of Values: Between and a positive 32-bit integer.
Type: int
Constraints: Has Default Value: 2147483647, Minimum Value: 0, Maximum Value: 2147483647
The principal name used to verify the identity of this remote Tuxedo access point when it establishes a session connection with a local Tuxedo access point. If not specified, the connection principal name defaults to the AccessPointID for this access point.
Note: This parameter only applies to domains of type TDOMAIN that are running Oracle Tuxedo 7.1 or later software.
Note: ConnPrincipalName is not supported in this release.
Type: string
The conditions under which this remote Tuxedo access point establishes a session connection with a local Tuxedo access point.
The allowed values are:
ON_DEMAND: A connection is attempted only when requested by either a client request to a remote service or an administrative connect command.
ON_STARTUP: A domain gateway attempts to establish a connection with its remote Tuxedo access points at gateway server initialization time. Remote services (services advertised in JNDI by the domain gateway for this local Tuxedo access point) are advertised only if a connection is successfully established to that remote Tuxedo access point. If there is no active connection to a remote Tuxedo access point, then the remote services are suspended. By default, this connection policy retries failed connections every 60 seconds. Use the MaxRetry and RetryInterval attributes to specify application specific values.
INCOMING_ONLY: A domain gateway does not attempt an initial connection to remote Tuxedo access points at startup and remote services are initially suspended. The domain gateway is available for incoming connections from remote Tuxedo access points and remote services are advertised when the domain gateway for this local Tuxedo access point receives an incoming connection. Connection retry processing is not allowed.
LOCAL: Specifies that the remote domain connection policy is explicitly defaulted to the local domain ConnectionPolicy attribute value.
Type: string
Constraints: Has Default Value: LOCAL, Legal Values: ON_DEMAND, ON_STARTUP, INCOMING_ONLY, LOCAL
The outbound access control list (ACL) policy toward requests to a remote Tuxedo access point.
The allowed values are:
LOCAL: The remote Tuxedo access point controls the identity of service requests received from the local Tuxedo access point to the principal name specified in the local principal name for this remote Tuxedo access point.
GLOBAL: The remote Tuxedo access point passes the service request with no change.
Note:If Interoperate is set to Yes, CredentialPolicy is ignored.
Type: string
Constraints: Has Default Value: LOCAL, Legal Values: GLOBAL, LOCAL
The full pathname to the custom AppKey generator class. (This class is only relevant if you specify Custom as the AppKey Generator.)
Note: This class is loaded at runtime if the Custom AppKey generator plug-in is selected.
Type: string
The optional parameters to be used by the custom AppKey class at the class initialization time. This class is only relevant if you specify Custom as the AppKey Generator.)
Type: string
The default AppKey value to be used by the anonymous user and other users who are not defined in the user database if the plug-in allows them to access Tuxedo.
Note: The TpUsrFile and LDAP plug-ins do not allow users that are not defined in user database to access Tuxedo unless Allow Anonymous is enabled.
Type: int
Constraints: Has Default Value: -1
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The context at which this remote Tuxedo access point federates to a foreign name service. If omitted, the default federation point is tuxedo.domains
Type: string
The URL for a foreign name service that is federated into JNDI.
Note: The Weblogic Tuxedo Connector can federate to non-CORBA service providers.
Note: If this value is not specified, the WebLogic Tuxedo Connector:
Assumes there is a CosNaming server in the foreign domain.
Federates to the CosNaming server using TGIOP.
Type: string
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Indicates whether this remote Tuxedo access point is configured with Application Level Keep Alive.
Greater than 0: Application Level Keep Alive is enabled and the value indicates the amount of idle time, in milliseconds rounded to the nearest second, allowed before starting the wait timer.
0: Application Level Keep Alive is not enabled for the access point.
-1: Application Level Keep Alive is enabled and indicates that the value from the local Tuxedo access point is used to indicate the amount of idle time, in milliseconds rounded to the nearest second, allowed before starting the wait timer.
Type: int
Constraints: Has Default Value: 0, Minimum Value: -1, Maximum Value: 2147483647
Indicates whether this remote Tuxedo access point requires the acknowledgement of Application Level Keep Alive. If the value is:
Greater than 0: Application Level Keep Alive is enabled and the value indicates the amount of idle time, in milliseconds rounded to the nearest second, allowed before WebLogic Tuxedo Connector marks the connection as failed if the heartbeat is not acknowledged.
0: Application Level Keep Alive is not enabled for the access point but the access point acknowledges if a heartbeat is received.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
The local domain name from which this remote Tuxedo domain is reached.
Type: string
Constraints: Has Default Value: myLAP, Legal Null: true
The maximum encryption key length (in bits) this remote Tuxedo access point uses when establishing a session connection. A value of indicates no encryption is used.
Value Restrictions:
The value of the MaxEncryptBits attribute must be greater than or equal to the value of the MinEncrypBits attribute.
A MaxEncryptBits of 40 can be used only with domains running Tuxedo 7.1 or higher.
Type: string
Constraints: Has Default Value: 128, Legal Values: 0, 40, 56, 128
The maximum number of times that this remote Tuxedo access point tries to establish a session connections to local Tuxedo access points. Use only when the ConnectionPolicy value is set to ON_STARTUP
Note: When the ConnectionPolicy value is LOCAL, the MaxRetries value from the local Tuxedo access point is used. When the ConnectionPolicy value is ON_STARTUP, a value of -1 indicates 9223372036854775807.
Range of Values: Between -1 and a positive 64-bit integer.
Use to disable the retry mechanism.
Use the maximum value to try until a connection is established.
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 9223372036854775807
The minimum encryption key length (in bits) this remote Tuxedo access point uses when establishing a session connection. A value of indicates no encryption is used.
Value Restrictions:
The MinEncrypBits value must be less than or equal to the MaxEncrypBits value.
A MinEncrypBits value of 40 can be used only with domains running Tuxedo 7.1 or higher.
Type: string
Constraints: Has Secure Value: 40, Has Default Value: 0, Legal Values: 0, 40, 56, 128
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The number of seconds that this remote Tuxedo access point waits between automatic connection attempts to local Tuxedo access points. Use this only when the ConnectionPolicy value is set to ON_STARTUP
Range of Values: Between -1 and a positive 32-bit integer.
Note: When the ConnectionPolicy value is LOCAL, the RetryInterval value from the local Tuxedo access point is used. When the ConnectionPolicy value is ON_STARTUP, a value of -1 indicates 60.
Type: long
Constraints: Has Default Value: -1, Minimum Value: -1, Maximum Value: 2147483647
Return all tags on this Configuration MBean
Type: array of string
The full path to the user password file containing UID/GID information. (This field is only relevant if you specify TpUsrFile as the AppKey Generator.)
Note: This file is generated by the Tuxedo tpusradd utility on the remote Tuxedo domain specified by the remote Tuxedo access point. A copy of this file must be available in your WebLogic Tuxedo Connector environment to provide correct authorization, authentication, and auditing.
Type: string
The keyword for Tuxedo GID (Group ID) used in the WlsUser when using the Tuxedo migration utility tpmigldap. This field is only relevant if you specify LDAP as the AppKey Generator.)
Note: The keyword is used to find Tuxedo GID in the user record in the embedded LDAP database.
Type: string
Constraints: Has Default Value: TUXEDO_GID
The keyword for Tuxedo UID (User ID) used in the WlsUser when using the Tuxedo migration utility tpmigldap. This keyword is only relevant if you specify LDAP as the AppKey Generator.)
Note: The keyword is used to find Tuxedo UID in the user record in the embedded LDAP database.
Type: string
Constraints: Has Default Value: TUXEDO_UID
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This interface provides access to the WTC resources configuration attributes. The methods defined herein are applicable for WTC configuration at the WLS domain level.
The properties of the weblogic.management.configuration.WTCResourcesMBean entity are as follows:
The encoding name map file between Java and Tuxedo MBSTRING.
Type: string
The application password as returned from the genpasswd utility.
Note: This Tuxedo application password is the encrypted password used to authenticate connections.
Type: string
The initialization vector used to encrypt the AppPassword
Note: This value is returned from the genpasswd utility with the AppPassword.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The names of FldTbl16Classes that are loaded via a class loader and added to a FldTbl array.
Value Requirements:
Used fully qualified names of the desired classes.
Use a comma-separated list to enter multiple classes.
Type: array of string
The names of FldTbl32Classes that are loaded via a class loader and added to a FldTbl array.
Value Requirements:
Used fully qualified names of the desired classes.
Use a comma-separated list to enter multiple classes
Type: array of string
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The default encoding name of sending MBSTRING data.
Type: string
Return all tags on this Configuration MBean
Type: array of string
The full path to the TPUSR file, which contains Tuxedo UID/GID information.
Note: This file is generated by the Tuxedo tpusradd utility on the remote Tuxedo domain.
Type: string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The names of ViewTbl16Classes that are loaded via a class loader and added to a ViewTbl array.
Value Requirements:
Used fully qualified names of the desired classes.
Use a comma-separated list to enter multiple classes.
Type: array of string
The names of ViewTbl32Classes that are loaded via a class loader and added to a ViewTbl array.
Value Requirements:
Used fully qualified names of the desired classes.
Use a comma-separated list to enter multiple classes.
Type: array of string
This MBean defines a WTC Server.
The properties of the weblogic.management.configuration.WTCServerMBean entity are as follows:
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This interface provides access to the WTC tBridge Global configuration attributes. The methods defined herein are applicable for tBridge configuration at the WLS domain level.
The properties of the weblogic.management.configuration.WTCtBridgeGlobalMBean entity are as follows:
Specifies whether non-standard data types are allowed to pass through this Tuxedo queuing bridge.
A value of NO means that non standard types are rejected and placed onto a specified error location; a value of YES means that non-standard types are placed on the target location as BLOBs with a tag indicating the original type.
Note: Standard types are: ASCII text (TextMessage, STRING), or BLOB (BytesMessage, CARRAY).
Type: string
Constraints: Has Default Value: NO, Legal Values: Yes, No
The reply delivery mode to associate with a message when placing messages onto the target location.
Usage Notes:
Use when messages are being redirected to Tuxedo/Q from JMS and the JMS_BEA_TuxGtway_Tuxedo_ReplyDeliveryMode property is not set for a message.
If the defaultReplyDeliveryMode and JMS_BEA_TuxGtway_Tuxedo_ReplyDeliveryMode are not set, the default semantics defined for Tuxedo are enforced by the Tuxedo/Q subsystem.
Type: string
Constraints: Has Default Value: DEFAULT, Legal Values: PERSIST, NONPERSIST, DEFAULT
The delivery mode to use when placing messages onto the target location.
If this value is not specified, the message is placed on the target location with the same delivery mode specified from the source location.
Note: This value overrides any delivery mode associated with a message.
Type: string
Constraints: Has Default Value: NONPERSIST, Legal Values: PERSIST, NONPERSIST
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The name of the JMS connection factory.
Example:weblogic.jms.ConnectionFactory
Type: string
Constraints: Has Default Value: weblogic.jms.XAConnectionFactory, Legal Null: true
The mapping of priorities from JMS to Tuxedo. The default JMS To Tux Priority Map is: 0:1 | 1:12 | 2:23 | 3:34 | 4:45 |5:56 | 6:67 | 7:78 | 8:89 | 9:100
Examples:0:1 | 1:12 | 2:23 | 3:34 | 4:45 | 5:56 | 6:67 | 7:78 | 8:89 | 9:100 or 0:1-10|1:11-20|2:21-30|3:31-40|4:41-50|5:51-60|6:61-70|7:71-80|8:81-90|9:91-100
Note: The are 10 possible JMS priorities(0=>9) which can be paired to 100 possible Tuxedo priorities(1=>100). A mapping consists of a "|" separated list of value-to-range pairs (jmsvalue:tuxrange) where pairs are separated by ":" and ranges are separated by "-".
Type: string
The name of the JNDI lookup factory.
Example:weblogic.jndi.WLInitialContextFactory
Type: string
Constraints: Has Default Value: weblogic.jndi.WLInitialContextFactory, Legal Null: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The number of attempts to redirect a message before this Tuxedo queuing bridge places the message in the specified error location and logs an error.
Range of Values: Between 0 and a positive 32-bit integer.
Type: int
Constraints: Has Default Value: 0, Minimum Value: 0, Maximum Value: 2147483647
The minimum number of milliseconds this Tuxedo queuing bridge waits before redirecting a message after a failure.
Note: During this waiting period, no other messages are redirected from the thread. Other threads may continue to redirect messages.
Range of Values: Between and a positive 32-bit integer.
Type: int
Constraints: Has Default Value: 10, Minimum Value: 0, Maximum Value: 2147483647
Return all tags on this Configuration MBean
Type: array of string
The number of timeout seconds for an entire redirection when this Tuxedo queuing bridge places a message on the target location. A value of specifies an infinite wait.
Range of Values: Between and a positive 32-bit integer.
Type: int
Constraints: Has Secure Value: 60, Has Default Value: 60, Minimum Value: 0, Maximum Value: 2147483647
Specifies whether this Tuxedo queuing bridge should use transactions when retrieving messages from a source location and when placing messages on a target location.
A value of YES means that transactions are used for both operations; a value of NO means that transactions are not used for either operation.
Note: Transactional is not supported in this release.
Type: string
Constraints: Has Default Value: NO, Legal Values: Yes, No
The name of the Tuxedo queue used to store a message that cannot be redirected to a Tuxedo/Q source queue.
If not specified, all messages not redirected are lost. If the message cannot be placed into the TuxErrorQueue, an error is logged and the message is lost.
Note: This queue is in the same queue space as the source queue.
Type: string
The name of the Tuxedo connection factory.
Example:tuxedo.services.TuxedoConnection
Type: string
Constraints: Has Default Value: tuxedo.services.TuxedoConnection, Legal Null: true
The mapping of priorities to map from Tuxedo to JMS. The default JMS To Tux Priority Map is: 1-10:0 | 11-20:1 | 21-30:2 | 31-40:3| 41-50:4| 51-60:5 | 61-70:6 | 71-80:7 | 81-90:8 | 91-100:9
Examples:1:0 | 12:1 | 23:2 | 34:3 | 45:4 | 56:5 | 67:6 | 78:7 | 89:8 | 100:9 or 20:0-1 | 40:2-3 | 60:4-5 | 80:6-7 | 100:8-9
Note: The are 100 possible Tuxedo priorities(1=>100) which can be paired to 10 possible JMS priorities(0=>9). A mapping consists of a "|" separated list of value-to-range pairs (tuxvalue:jmsrange) where pairs are separated by ":" and ranges are separated by "-".
Type: string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
The user identity for all messages handled by this Tuxedo queuing bridge for ACL checks when security is configured.
All messages assume this identity until the security/authentication contexts are passed between the subsystems. Until the security contexts are passed, there is no secure method to identify who generated a message received from the source location.
Note: The user argument may be specified as either a user name or a user identification number (uid).
Type: string
The name of the location used to store WebLogic Server JMS messages when a message cannot be redirected.
If not specified, all messages not redirected are lost. If the message cannot be placed into WlsErrorDestination for any reason, an error is logged and the message is lost.
Type: string
This interface provides access to the WTC tBridge Redirect configuration attributes. The methods defined herein are applicable for tBridge configuration at the WLS domain level.
The properties of the weblogic.management.configuration.WTCtBridgeRedirectMBean entity are as follows:
The direction of data flow. At least one redirection must be specified or the Tuxedo queuing bridge will fail to start and an error will be logged.
Each defined direction is handled by starting a new thread.
Redirection keywords:
JmsQ2TuxQ
- From JMS to TUXEDO /Q
TuxQ2JmsQ
- From TUXEDO /Q to JMS
JmsQ2TuxS
- From JMS to TUXEDO Service reply to JMS
JmsQ2JmsQ
- From JMS to JMS
Type: string
Constraints: Has Default Value: JmsQ2TuxQ, Legal Values: JmsQ2TuxQ, TuxQ2JmsQ, JmsQ2TuxS, JmsQ2JmsQ, Legal Null: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The name of the metadata file URL used to pass the call to the XML-to-non-XML WebLogic XML Translator (WLXT).
Note: Not supported for this release.
Type: string
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The name of the JMS queue used specifically for synchronous calls to a Tuxedo service. The response is returned to the JMS ReplyQ.
Type: string
The name of the local or remote access point where the source is located.
Type: string
The name of a source queue or service. Specifies a JMS queue name, a Tuxedo queue name, or the name of a Tuxedo service.
Type: string
Constraints: Has Default Value: mySource, Legal Null: true
The name of the Qspace for a source location.
Type: string
Return all tags on this Configuration MBean
Type: array of string
The name of the local or remote access point where the target is located.
Type: string
The name of the target queue or service. Specifies a JMS queue name, a Tuxedo queue name, or the name of a Tuxedo service.
Type: string
Constraints: Has Default Value: myTarget, Legal Null: true
The name of the Qspace for a target location.
Type: string
The type of XML/FML translation.
NO indicates that no data translation is performed. FLAT indicates that the message payload is transformed using the WebLogic Tuxedo Connector translator. WLXT indicates that translation is performed by the XML-to-non-XML WebLogic XML Translator (WLXT).
Note: WLXT is not supported for this release.
Type: string
Constraints: Has Default Value: NO, Legal Values: NO, FLAT, WLXT
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean is used to specify domain-wide defaults for the WebApp container. In general, these properties can be overridden at the cluster level (in ClusterMBean, if the same property is present there), the server level (in ServerMBean, if the same property is present there) or for a specific Web application (in weblogic.xml).
The properties of the weblogic.management.configuration.WebAppContainerMBean entity are as follows:
Global property to determine the behavior of the JSP compiler. When this property set to "true", the JSP compiler throws a translation error for JSPs that do not conform to the JSP2.0 specification. This property exists for backward compatibility.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Indicates whether the session ID should include JVM information. (Checking this box may be necessary when using URL rewriting with WAP devices that limit the size of the URL to 128 characters, and may also affect the use of replicated sessions in a cluster.) When this box is selected, the default size of the URL will be set at 52 characters, and it will not contain any special characters.
Type: boolean
Constraints: Has Default Value: false
WebLogic Server uses the X-Powered-By HTTP header, as recommended by the Servlet 2.4 specification, to publish its implementation information.
Following are the options:
"NONE": X-Powered-By header will not be sent
"SHORT" (default): "Servlet/2.4 JSP/2.0"
"MEDIUM": "Servlet/2.4 JSP/2.0 (WebLogic/9.1)"
"FULL": "Servlet/2.4 JSP/1.2 (WebLogic/9.1 JDK/1.4.1_05)"
Type: string
Constraints: Has Default Value: NONE, Legal Values: NONE, SHORT, MEDIUM, FULL
In the security-constraints elements defined in a web application's web.xml deployment descriptor, the auth-constraint element indicates the user roles that should be permitted access to this resource collection. Here role-name = "*" is a compact syntax for indicating all roles in the Web application. In previous releases, role-name = "*" was treated as all users/roles defined in the realm.
This parameter is a backward-compatibility switch to restore old behavior. Default behavior is one required by the specification, meaning all roles defined in the web application.
If set, the value defined in weblogic.xml (container-descriptor -> allow-all-roles) takes precedence (if set) over this value.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Specifies whether the AuthCookie feature is enabled or not.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: true
Global property to determine if we need to generate a new SessionID after authentication. When this property is set to "false", the previous sessionID will be retained even after authorization.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Specifies whether or not to honor the WL-Proxy-Client-Cert header coming with the request.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Indicates whether or not to apply filters to dispatched requests. This is a backward compatibility flag. Until version 8.1, WebLogic Server applied ServletFilters (if configured for the web application) on request dispatches (and includes/forwards). Servlet 2.4 has introduced the "Dispatcher" element to make this behavior explicit. The default value is Dispatcher=REQUEST. In order to be compliant with the Java EE specification, the default value for FilterDispatchedRequestsEnabled is false beginning with WebLogic Server 9.0. Note that if you are using old descriptors (meaning web.xml does not have version=2.4), then WebLogic Server automatically uses FilterDispatchedRequestsEnabled = true for the web applications, unless filter-dispatched-requests-enabled is explicitly set to false in weblogic.xml. This means that old applications will work fine without any modification. Additionally, during migration of old domains to the 9.0 domain, the migration plug-in automatically sets this flag to true.
Type: boolean
Constraints: Restart Required, Has Secure Value: false, Has Default Value: false
Returns the value of HttpTraceSupportEnabled.
Type: boolean
Constraints: Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Global property to determine the behavior of monitoring in JAX-RS applications. When the property is set to {@code true} (or not set) the monitoring is turned on (if not overridden by properties set directly in application). If the property is set to {@code false} the monitoring for all JAX-RS applications is disabled.
Type: boolean
Constraints: Has Default Value: true
The maximum post size this server allows for reading HTTP POST data in a servlet request. A value less than 0 indicates an unlimited size.
Type: int
Constraints: Has Default Value: -1
Maximum post time (in seconds) for reading HTTP POST data in a servlet request. MaxPostTime < 0 means unlimited
Type: int
Constraints: Has Default Value: -1
The maximum request parameter count this server allows for reading maximum HTTP POST parameters count in a servlet request.
Gets the maxRequestParameterCount attribute of the WebServerMBean object.
Type: int
Constraints: Has Default Value: 10000
Returns the name of the file containing mime-mappings for the domain.
The Format of the file should be: extension=mime-type
For Example:
htm=text/html
gif=image/gif
jpg=image/jpeg
If this file does not exist, WebLogic Server uses an implicit mime-mapping set of mappings defined in weblogic.utils.http.HttpConstants (DEFAULT_MIME_MAPPINGS). To remove a mapping defined in implicit map, set it to blank.
Type: string
Constraints: Restart Required, Has Default Value: ./config/mimemappings.properties
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
When OptimisticSerialization is turned on, WebLogic Server does not serialize-deserialize context and request attributes upon getAttribute(name) when a request gets dispatched across servlet contexts. This means you will need to make sure that the attributes common to web applications are scoped to a common parent classloader (they are application-scoped) or placed in the system classpath if the two web applications do not belong to the same application. When OptimisticSerialization is turned off (which is the default), WebLogic Server does serialize-deserialize context and request attributes upon getAttribute(name) to avoid the possibility of ClassCastExceptions. The value of OptimisticSerialization can also be overridden for specific web applications by setting the optimistic-serialization value in weblogic.xml.
Type: boolean
Constraints: Restart Required, Has Default Value: false
This parameter is used to enable overload protection in the web application container against low memory conditions. When a low memory situation occurs, new session creation attempts will result in weblogic.servlet.SessionCreationException. The application code needs to catch this exception and take proper action. Alternatively appropriate error-pages can be configured in web.xml against weblogic.servlet.SessionCreationException. This check is performed only on memory and replicated sessions.
Type: boolean
Constraints: Has Default Value: false
Returns the P3P header value that will be sent with all responses for HTTP requests (if non-null). The value of this header points to the location of the policy reference file for the website.
Alternatively, a servlet filter can be used to set the P3P header.
Type: string
Constraints: Restart Required
The amount of time this server waits between receiving chunks of data in an HTTP POST data before it times out. (This is used to prevent denial-of-service attacks that attempt to overload the server with POST data.)
Type: int
Constraints: Has Secure Value: 30, Has Default Value: 30, Minimum Value: 0, Maximum Value: 120
Beginning with the 9.0 release, the FORM/BASIC authentication behavior has been modified to conform strictly to the Java EE Specification. If a user has logged-in but does not have privileges to access a resource, the 403 (FORBIDDEN) page will be returned. Turn this flag on to enable the old behavior, which was to return the user to the login form.
Type: boolean
Constraints: Restart Required, Has Default Value: false
The retain-original-url property is used in FORM based authentication scenarios. When this property is set to true, after a successful authentication, WebLogic Server will redirect back to the web resource (page/servlet) retaining the protocol (http/https) used to access the protected resource in the original request. If set to false (which is the default value), WebLogic Server will redirect back to the protected resource using the current protocol. The retain-original-url value can also be specified at per web application level in weblogic.xml. The value in weblogic.xml, if specified, overrides the domain level value.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Global property which determines the behavior of the JSP compiler when a jsp:param attribute "name" has a request time value. Without this property set to "true", the JSP compiler throws an error for a JSP using a request time value for the "name" attribute as mandated by the JSP 2.0 specification. This property exists for backward compatibility.
Type: boolean
Constraints: Restart Required, Has Default Value: false
ServletAuthenticationFormURL is used for backward compatibility with previous releases of Weblogic Server. If ServletAuthenticationFormURL is set to true (default), then ServletAuthentication.getTargetURLForFormAuthentication() and HttpSession.getAttribute(AuthFilter.TARGET_URL) will return the URL of the protected target resource. If set to false, the above APIs will return the URI of the protected target resource. By default, the value is set to true.(new method added in 9.0.0.1)
Type: boolean
Constraints: Restart Required, Has Default Value: true
Type: int
Constraints: Has Default Value: 1, Has Production Mode Default Value: -1
Global property to determine the behavior of getRealPath() for archived web applications. When this property is set to "true", getRealPath() will return the canonical path of the resource files.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies whether or not the proprietary WL-Proxy-Client-IP header should be honored. (This is needed only when WebLogic Server plug-ins are configured.)
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Indicates whether or not WorkContextPropagation is enabled. By default, it is turned on. There is a little overhead involved in propagating WorkContexts. Therefore, if you don't want WorkContext propagation, turn this value off in production environments.
Type: boolean
Constraints: Has Default Value: true
Aggregates the logging attributes for the WebServerMBean.
The properties of the weblogic.management.configuration.WebServerLogMBean entity are as follows:
Returns the list of fields specified for the extended logging format for access.log.
Type: string
Constraints: Has Default Value: date time cs-method cs-uri sc-status
Gets the underlying log buffer size in kilobytes
Type: int
Constraints: Has Default Value: 8
The date format pattern used for rendering dates in the log. The DateFormatPattern string conforms to the specification of the java.text.SimpleDateFormat class.
Type: string
Constraints: Legal Null: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)
Type: int
Constraints: Has Default Value: 7, Has Production Mode Default Value: 100, Minimum Value: 1, Maximum Value: 99999
The size (1 - 2097150 kilobytes) that triggers the server to move log messages to a separate file. The default is 500 kilobytes. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as SERVER_NAME.lognnnnn and create a new one to store subsequent messages. (Requires that you specify a file rotation type of Size.)
Type: int
Constraints: Has Default Value: 500, Has Production Mode Default Value: 5000, Minimum Value: 1, Maximum Value: 2097150
The name of the log file.
Type: string
Constraints: Restart Required
The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of TIME.)
Type: int
Constraints: Has Default Value: 24, Minimum Value: 1
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
The format of the HTTP log file. Both formats are defined by the W3C. With the extended log format, you use server directives in the log file to customize the information that the server records.
Type: string
Constraints: Restart Required, Has Default Value: common, Legal Values: common, extended
The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.
Type: string
Specifies whether the time stamps for HTTP log messages are in Greenwich Mean Time (GMT) regardless of the local time zone that the host computer specifies.
Use this method to comply with the W3C specification for Extended Format log files. The specification states that all time stamps for Extended Format log entries be in GMT.
This method applies only if you have specified the extended message format.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Indicates whether this server logs HTTP requests. (The remaining fields on this page are relevant only if you select this check box.)
Gets the loggingEnabled attribute of the WebServerMBean object.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: true
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of SIZE or TIME.)
After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.
If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.
Type: boolean
Constraints: Has Default Value: true, Has Production Mode Default Value: true
Specifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.
Type: boolean
Constraints: Has Default Value: true, Has Production Mode Default Value: false
Determines the start time (hour and minute) for a time-based rotation sequence.
At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.
Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.
Use the following format: H:mm, where
is Hour in day (0-23)
mm is the minute in hour
Type: string
Constraints: Has Default Value: 00:00
Criteria for moving old log messages to a separate file.
NONE Messages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.
SIZE When the log file reaches the size that you specify in FileMinSize, the server renames the file as SERVER_NAME.lognnnnn
TIME At each time interval that you specify in TimeSpan, the server renames the file as SERVER_NAME.lognnnnn
After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.
Type: string
Constraints: Has Default Value: bySize, Legal Values: bySize, byTime, none
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This bean represents the configuration of virtual web server within a weblogic server. Note that a server may define multiple web servers to support virtual hosts.
This MBean represents a virtual host.
The properties of the weblogic.management.configuration.WebServerMBean entity are as follows:
Indicates whether the session ID should include JVM information. (Checking this box may be necessary when using URL rewriting with WAP devices that limit the size of the URL to 128 characters, and may also affect the use of replicated sessions in a cluster.) When this box is selected, the default size of the URL will be set at 52 characters, and it will not contain any special characters.
Gets the WAPEnabled attribute of the WebServerMBean object
Type: boolean
Constraints: Has Default Value: false
Indicates whether this server allows the inclusion of the context path in the virtual path to context.getRealPath(). (If checked, you cannot use sub directories with the same name as contextPath). This is a compatibility switch that will be deprecated 9.0.0.0 in future releases.
Gets the acceptContextPathInGetRealPath attribute of the WebServerMBean object
Type: boolean
Constraints: Restart Required, Has Default Value: false
Whether authcookie feature is enabled or not.
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: true
Indicates whether the use of Chunk Transfer-Encoding in HTTP/1.1 is enabled.
Type: boolean
Constraints: Has Default Value: false
Get the Client IP Header from WebSerevrMBean.
Type: string
Returns the original context-root for the default Web application for this Web server. Alternatively, you can use the context-root attributes in application.xml or weblogic.xml to set a default Web application. The context-root for a default Web application is /. If "" (empty string) is specified, the Web server defaults to /.
Type: string
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The name of the HTTP port to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.
Sets the frontendHTTPPort Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.
Type: int
Constraints: Has Default Value: 0
The name of the secure HTTP port to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.
Sets the frontendHTTPSPort Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.
Type: int
Constraints: Has Default Value: 0
The name of the host to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.
Sets the HTTP frontendHost Provides a method to ensure that the webapp will always have the correct HOST information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.
Type: string
Constraints: Has Default Value: null
The amount of time this server waits before closing an inactive HTTPS connection.
Number of seconds to maintain HTTPS keep-alive before timing out the request.
Type: int
Constraints: Has Secure Value: 60, Has Default Value: 60, Minimum Value: 30, Maximum Value: 360
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Indicates whether there should be a persistent connection to this server. (This may improve the performance of your Web applications.)
Gets the keepAliveEnabled attribute of the WebServerMBean object
Type: boolean
Constraints: Has Secure Value: true, Has Default Value: true
The amount of time this server waits before closing an inactive HTTP connection.
Number of seconds to maintain HTTP keep-alive before timing out the request.
Type: int
Constraints: Has Secure Value: 30, Has Default Value: 30, Minimum Value: 5, Maximum Value: 3600
The maximum post size this server allows for reading HTTP POST data in a servlet request.
A value less than 0 indicates an unlimited size.
Gets the maxPostSize attribute of the WebServerMBean object
Type: int
Constraints: Has Default Value: -1
Max Post Time (in seconds) for reading HTTP POST data in a servlet request. MaxPostTime < 0 means unlimited
Gets the maxPostTimeSecs attribute of the WebServerMBean object
Type: int
Constraints: Has Default Value: -1
Max Request Parameter Count this server allows for reading maximum HTTP POST Parameters count in a servlet request.
Gets the maxRequestParameterCount attribute of the WebServerMBean object
Type: int
Constraints: Has Default Value: 10000
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Get the response code to be used when an application is overloaded. An application can get overloaded when the number of pending requests has reached the max capacity specified in the WorkManager or when the server is low on memory. The low memory condition is determined using OverloadProtectionMBean#getFreeMemoryPercentLowThreshold().
Type: int
Constraints: Has Default Value: 503, Minimum Value: 100, Maximum Value: 599
Timeout (in seconds) for reading HTTP POST data in a servlet request. If the POST data is chunked, the amount of time the server waits between the end of receiving the last chunk of data and the end of receiving the next chunk of data in an HTTP POST before it times out. (This is used to prevent denial-of-service attacks that attempt to overload the server with POST data.)
Gets the postTimeoutSecs attribute of the WebServerMBean object
Type: int
Constraints: Has Secure Value: 30, Has Default Value: 30, Minimum Value: 0, Maximum Value: 120
Indicates whether this server name is sent with the HTTP response. (This is useful for wireless applications where there is limited space for headers.)
Indicates whether this server instance includes its name and WebLogic Server version number in HTTP response headers.
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Indicates whether the singleSignonDisabled attribute is enabled
Type: boolean
Constraints: Has Default Value: false
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Type: boolean
Constraints: Has Secure Value: false, Has Default Value: false
Enables use of the highest compatible HTTP protocol version-string in the response. E.g. HTTP spec suggests that HTTP/1.1 version-string should be used in response to a request using HTTP/1.0. This does not necessarily affect the response format.
Type: boolean
Constraints: Has Default Value: true
The default size of the blocks to be written to the network layer.
Gets the writeChunkBytes attribute of the WebServerMBean object
Type: int
Constraints: Read Only, Has Default Value: 512
Represents buffering configuration for web services.
The properties of the weblogic.management.configuration.WebServiceBufferingMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The number of times a buffered request or response can be retried before it is abandoned (and moved to any error queue defined for the buffer queue)
Type: int
Constraints: Has Default Value: 3, Minimum Value: 0
The amount time between retries of a buffered request and response. Note, this value is only applicable when RetryCount > 0. String value in "Duration" format. Defaults to "P0DT30S" (30 seconds).
Type: string
Constraints: Has Default Value: P0DT30S
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Represents a logical store for web services.
The properties of the weblogic.management.configuration.WebServiceLogicalStoreMBean entity are as follows:
Get the interval at which the persistent store will be cleaned
Type: string
Constraints: Restart Required, Has Default Value: PT10M
Get the default max time an object can remain in the store. This can be overridden on individual objects placed in the store (internally, but not via this API).
Type: string
Constraints: Has Default Value: P1D
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Get the name of this logical store.
Type: string
Constraints: Restart Required
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.
Type: string
Get the persistence strategy in use by this logical store. Any physical store configured for use with this logical store should support this strategy.
Type: string
Constraints: Restart Required, Has Default Value: LOCAL_ACCESS_ONLY, Legal Values: LOCAL_ACCESS_ONLY, IN_MEMORY
Get the name of the physical store to be used by this logical store. This property is recommended for use only when running off server or in other cases where a buffering queue JNDI name cannot be set via setBufferingQueueJndiName. If a buffering queue JNDI name is set to a non-null/non-empty value, this property is ignored. Defaults to "" to indicate the default WLS file store should be used.
This property is ignored if persistence strategy is IN_MEMORY.
Type: string
Constraints: Has Default Value:
Get the JNDI name of the buffering queue that web services should use. (Both for buffering and to find the physical store for this logical store). Defaults to "" to indicate the PhysicalStoreName property should be used.
This property is ignored if persistence strategy is IN_MEMORY.
Type: string
Constraints: Restart Required, Has Default Value:
Get the JNDI name of the response buffering queue that web services should use. If this is null, the request buffering queue is used.
Type: string
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Encapsulates information about a Web Service configuration.
The properties of the weblogic.management.configuration.WebServiceMBean entity are as follows:
For use only with the JAX-RPC stack. For JAX-WS, use WebServiceBufferingMBean instead.
Type: string
Constraints: Has Default Value: weblogic.wsee.DefaultCallbackQueue
For use only with the JAX-RPC stack. For JAX-WS, use WebServiceBufferingMBean instead.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
For use only with the JAX-RPC stack. For JAX-WS, use WebServiceBufferingMBean instead.
Type: string
Constraints: Has Default Value: weblogic.jms.XAConnectionFactory
For use only with the JAX-RPC stack. For JAX-WS, use WebServiceBufferingMBean instead.
Type: string
Constraints: Has Default Value: weblogic.wsee.DefaultQueue
For use only with the JAX-RPC stack. For JAX-WS, use WebServiceBufferingMBean instead.
Type: string
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Represents persistence configuration for web services.
The properties of the weblogic.management.configuration.WebServicePersistenceMBean entity are as follows:
Get the name of the logical store to use, by default, for all web services persistent state in this server.
Type: string
Constraints: Has Default Value: WseeStore
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Represents a physical store for web services. Used only for non-WLS containers (e.g. other app-server or standalone client).
The properties of the weblogic.management.configuration.WebServicePhysicalStoreMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
For file stores, specifies the directory that will hold all files related to the store. The actual file names are controlled internally by the file store implementation. For other types of stores, this location may be a URL or URI, or other description string.
Type: string
Get the name of this physical store.
Type: string
Constraints: Restart Required
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.
Type: string
Get the type of this physical store.
Type: string
Constraints: Has Default Value: FILE, Legal Values: FILE, JDBC
Specifies the algorithm used when performing synchronous writes to the physical store.
Type: string
Constraints: Has Default Value: CACHE_FLUSH, Legal Values: DISABLED, CACHE_FLUSH, DIRECT_WRITE
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Represents reliability configuration for web services.
The properties of the weblogic.management.configuration.WebServiceReliabilityMBean entity are as follows:
The maximum time a pending acknowledgement (set after the destination accepts a message) can wait before being delivered back to the RM source. String value in "Duration" format. Defaults to "P0DT0.2S" (200 milliseconds). Set at sequence creation time, and cannot be reset.
Type: string
Constraints: Has Default Value: P0DT0.2S
The interval of time that must pass before a message will be retransmitted to the RM destination (in the event a prior transmission failed). String value in "Duration" format. Defaults to "P0DT3S" (3 seconds). Set at sequence creation time, and cannot be reset.
Type: string
Constraints: Has Default Value: P0DT3S
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
If during this duration, an endpoint (RM source or RM destination) has received no application or control messages, the endpoint MAY consider the RM Sequence to have been terminated due to inactivity. String value in "Duration" format. Defaults to "P0DT600S" (600 seconds). Implementations of RM source and RM destination are free to manage resources associated with the sequence as they please, but in general, there are no guarantees that the sequence will be useable by either party after the inactivity timeout expires. Set at sequence creation time, and cannot be reset.
Type: string
Constraints: Has Default Value: P0DT600S
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
A boolean flag indicating that RM destinations, by default, will receive non-buffered. Defaults to false. Note, changes to this default will only be picked up by new reliable sequences. Existing reliable sequences have their persistence handling set at creation time and these values will not change.
Type: boolean
Constraints: Has Default Value: false
A boolean flag indicating that RM sources, by default, will send non-buffered. Defaults to false. Note, changes to this default will only be picked up by new reliable sequences. Existing reliable sequences have their persistence handling set at creation time and these values will not change.
Type: boolean
Constraints: Has Default Value: false
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.
Type: string
A boolean flag indicating that the retransmission interval will be adjusted using the exponential backoff algorithm ([Tanenbaum]). Defaults to false. Set at sequence creation time, and cannot be reset.
Type: boolean
Constraints: Has Default Value: false
This is the maximum lifetime of a sequence. If this limit is reached before the sequence naturally completes, it will be forcibly terminated. String value in "Duration" format. Defaults to "P1D" (1 day). Set at sequence creation time, and cannot be reset.
Type: string
Constraints: Has Default Value: P1D
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Represents request buffering queue configuration for web services.
The properties of the weblogic.management.configuration.WebServiceRequestBufferingQueueMBean entity are as follows:
The JNDI name of the connection factory to use when buffering messages onto this queue. Defaults to the 'default' JMS connection factory.
Type: string
Constraints: Has Default Value: null
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
A boolean flag indicating whether buffering is enabled (request buffering if this is the request queue, or response buffering if this is the response queue). Defaults to false.
Type: boolean
Constraints: Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Get the name of this buffering queue. This name is the JNDI name of the queue to be used for buffering.
Type: string
Constraints: Restart Required
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
A boolean flag indicating whether transactions should be used when buffering a message onto or consuming a message off of this queue. Defaults to false.
Type: boolean
Constraints: Has Default Value: false
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Represents response buffering queue configuration for web services.
The properties of the weblogic.management.configuration.WebServiceResponseBufferingQueueMBean entity are as follows:
The JNDI name of the connection factory to use when buffering messages onto this queue. Defaults to the 'default' JMS connection factory.
Type: string
Constraints: Has Default Value: null
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
A boolean flag indicating whether buffering is enabled (request buffering if this is the request queue, or response buffering if this is the response queue). Defaults to false.
Type: boolean
Constraints: Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Get the name of this buffering queue. This name is the JNDI name of the queue to be used for buffering.
Type: string
Constraints: Restart Required
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
A boolean flag indicating whether transactions should be used when buffering a message onto or consuming a message off of this queue. Defaults to false.
Type: boolean
Constraints: Has Default Value: false
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Encapsulates information about a particular credential provider that has been configured for a Web Service security configuration.
The properties of the weblogic.management.configuration.WebserviceCredentialProviderMBean entity are as follows:
The fully qualified name of the class that implements a particular credential provider or token handler.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Specifies the type of token used for the particular credential provider or token handler.
WebLogic Server supports, by default, three types of tokens: X.509, UsernameToken, and SAML, as specified by the following WS-Security specifications:
Web Services Security: Username Token Profile
Web Services Security: X.509 Token Profile
Web Services Security: SAML Token Profile
To specify one of these out-of-the-box types, use these values respectively: "ut", "x509", or "saml".
Type: string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Encapsulates information about a Web Service security configuration.
The properties of the weblogic.management.configuration.WebserviceSecurityMBean entity are as follows:
Gets the value of the compatiblityOrderingPreference attribute.
Type: string
Constraints: Restart Required
Gets the value of the compatiblityPreference attribute.
Type: string
Constraints: Restart Required
Gets the default STS endpoint URL for all WS-Trust enabled credential providers of this Web Service security configuration.
Type: string
Constraints: Restart Required
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Gets the value of the PolicySelectionPreference attribute.
The preference value can be one of the following:
NONE
SCP
SPC
CSP
CPS
PCS
PSC
Where: S: Security or functionality; C: Compatibility or Interoperability; P: Performance
If NONE is specified, no preference is applied - the first policy alternative is always chosen, and optional policy assertions are ignored.
Type: string
Constraints: Has Default Value: NONE, Legal Values: NONE, SCP, SPC, CSP, CPS, PCS, PSC
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Encapsulates information about a particular token that has been configured for a Web Service security configuration.
The properties of the weblogic.management.configuration.WebserviceSecurityTokenMBean entity are as follows:
The fully qualified name of the class that implements a particular credential provider or token handler.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Specifies the type of token used for the particular credential provider or token handler.
WebLogic Server supports, by default, three types of tokens: X.509, UsernameToken, and SAML, as specified by the following WS-Security specifications:
Web Services Security: Username Token Profile
Web Services Security: X.509 Token Profile
Web Services Security: SAML Token Profile
To specify one of these out-of-the-box types, use these values respectively: "ut", "x509", or "saml".
Type: string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Controls the configuration of the Web Service Test Page.
The properties of the weblogic.management.configuration.WebserviceTestpageMBean entity are as follows:
Specifies whether the basic authentication is automatically used by Web Service Test Page in the current domain.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies whether the WebLogic Server automatically deploys Web Service Test Page in the current domain.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Encapsulates the timestamp information that is associated with a Web Service security configuration.
The properties of the weblogic.management.configuration.WebserviceTimestampMBean entity are as follows:
If clocks are synchronized, this attribute describes the accuracy of the synchronization between two clocks: the client and the server.
ClockSkew is expressed in milliseconds. Clock skew is enforced by rendering all times into milliseconds since a common time 0 and using these times for comparisons. For example, if your clocks are accurate to within 1 minute of each other, you would set your skew to 1 minute * 60 seconds * 1000 milliseconds or 60000.
Type: long
Constraints: Has Default Value: 60000, Minimum Value: 0
Specifies whether the Web Service assumes synchronized clocks.
If the clockSynchronized attribute is false, the Web Service rejects all inbound messages with that contain expirations, because this is the only safe way to ensure that the message hasn't already expired. In this case, the Web Service also does not enforce a freshness policy.
If this attribute is set to true, then the Web Service enforces expirations on inbound messages to the best of its ability and enforces an optional freshness policy (via maxProcessingDelay).
The default value of this attribute is true.
Type: boolean
Constraints: Has Default Value: true
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies the freshness policy for received messages: the Web Service observes the processing delay by subtracting the Created time in the Timestamp from the current time.
If the observed processing delay is greater than maxProcessingDelay plus clockSkew, then the message is rejected as stale.
This attribute is specified in milliseconds.
Setting maxProcessingDelay to NO_MAX_PROCESSING_DELAY disables to enforcement of the freshness policy.
Type: long
Constraints: Has Default Value: -1
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Represents the length of time the sender wants the outbound message to be valid.
When the validityPeriod is positive, the TimestampHandler inserts an Expires element into the Timestamp header. The validityPeriod is expressed in seconds: the Expires time will be that many seconds ahead of the Timestamp's Created time.
Type: int
Constraints: Has Default Value: 60, Minimum Value: 1
Encapsulates information about a particular token handler that has been configured for a Web Service security configuration.
The properties of the weblogic.management.configuration.WebserviceTokenHandlerMBean entity are as follows:
The fully qualified name of the class that implements a particular credential provider or token handler.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Specifies the order in which the token handlers execute on a given token.
If you do not specify an order, it is determined by the order in which you added the token handlers.
Type: int
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Specifies the type of token used for the particular credential provider or token handler.
WebLogic Server supports, by default, three types of tokens: X.509, UsernameToken, and SAML, as specified by the following WS-Security specifications:
Web Services Security: Username Token Profile
Web Services Security: X.509 Token Profile
Web Services Security: SAML Token Profile
To specify one of these out-of-the-box types, use these values respectively: "ut", "x509", or "saml".
Type: string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configuration MBean representing WorkManager parameters. A WorkManager configuration can have a RequestClass(FairShare, ResponseTime, ContextBased), MinThreadsConstraint, MaxThreadsConstraint, Capacity and ShutdownTrigger. All these are optional and need to be configured as needed. An empty WorkManager without configuration gets its own default fair share. The default fair share value is 50.
The properties of the weblogic.management.configuration.WorkManagerMBean entity are as follows:
Specifies whether this work manager should be scoped to an application. By default, work managers are scoped to an application. Set this value to false if the work manager is to be scoped to a domain
Type: boolean
Constraints: Restart Required, Has Default Value: true
The total number of requests that can be queued or executing before WebLogic Server begins rejecting requests.
Type: weblogic.management.configuration.CapacityMBean reference
Constraints: Restart Required
The mapping of Request Classes to security names and groups.
Type: weblogic.management.configuration.ContextRequestClassMBean reference
Constraints: Restart Required
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.
Type: int
Constraints: Has Default Value: 1000, Minimum Value: 0, Maximum Value: 2147483647
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Get the FairShareRequestClass for this WorkManager
Type: weblogic.management.configuration.FairShareRequestClassMBean reference
Constraints: Restart Required
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Specifies whether this Work Manager ignores "stuck" threads. Typically, stuck threads will cause the associated Work Manager to take some action: either switching the application to Admin mode, shutting down the server, or shutting down the Work Manager. If this flag is set, then no thread in this Work Manager is ever considered stuck.
If you do not explicitly specify IGNORE_STUCK_THREADS=TRUE, the default behavior is that upon encountering stuck threads, the server will take one of the aforementioned actions.
Type: boolean
Constraints: Restart Required
The maximum number of concurrent threads that can be allocated to execute requests.
Type: weblogic.management.configuration.MaxThreadsConstraintMBean reference
Constraints: Restart Required
The minimum number of threads allocated to resolve deadlocks.
Type: weblogic.management.configuration.MinThreadsConstraintMBean reference
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The response time goal (in milliseconds).
Type: weblogic.management.configuration.ResponseTimeRequestClassMBean reference
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
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.
Type: array of weblogic.management.configuration.TargetMBean references
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
This MBean is used to configure the trigger that shuts down the WorkManager. The trigger specifies the number of threads that need to be stuck for a certain amount of time for the trigger to shutdown the WorkManager automatically. A shutdown WorkManager refuses new work and completes pending work.
The properties of the weblogic.management.configuration.WorkManagerShutdownTriggerMBean entity are as follows:
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Time after which a executing thread is declared as stuck.
Type: int
Constraints: Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Whether to resume work manager once the stuck threads were cleared
Type: boolean
Constraints: Restart Required, Has Default Value: true
Number of stuck threads after which the WorkManager is shutdown
Type: int
Constraints: Restart Required
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configure the behavior of JAXP (Java API for XML Parsing) in the server.
The properties of the weblogic.management.configuration.XMLEntityCacheMBean entity are as follows:
The disk size, in MB, of the persistent disk cache. The default value is 5 MB.
Return the disk size in MBytes of the cache.
Type: int
Constraints: Has Default Value: 5, Minimum Value: 0
Provides the path name for the persistent cache files.
Type: string
Constraints: Has Default Value: xmlcache
The memory size, in KB, of the cache. The default value is 500 KB.
Return the memory size in KBytes of the cache.
Type: int
Constraints: Has Default Value: 500, Minimum Value: 0
The default timeout interval, in seconds, for the cache. The default value is 120 seconds.
Return the default timeout interval in seconds for the cache.
Type: int
Constraints: Has Default Value: 120, Minimum Value: 0
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
Provides the maximum number of entries that can be stored in the cache at any given time.
Type: int
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
An Entity Spec Entry specifies how to resolve an external entity based its public and system IDs.
When WebLogic Server is parsing an XML document and it encounters the specified external entity, WebLogic Server resolves the entity according to the values entered for this entry. You can specify that the external entity resolve to a particular resource whose location is either a pathname reachable by the Administration Server or a URI to a local repository.
An Entity Spec entry is part of an XML Registry.
For this type of registry entry the document type is identified by either or both of:
a public ID (e.g, "-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN"
a system ID (e.g, "http://java.sun.com/j2ee/dtds/ejb-jar_2_0.dtd")
This configuration information is used by the WebLogic JAXP implementation to set up SAX EntityResolvers.
The properties of the weblogic.management.configuration.XMLEntitySpecRegistryEntryMBean entity are as follows:
Specifies the default timeout interval (in seconds) of the external entity cache.
A value of -1 means that the entity cache timeout interval defers to the one specified for the XML registry of which this Entity Spec entry is a part.
Type: int
Constraints: Has Default Value: -1, Minimum Value: -1
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
The location of the external entity, either a pathname or URI.
The location of the external entity can be either a pathname relative to the XML Registry directories, reachable by the Administration Server, or a URI of the entity location in some local repository.
Type: string
Whether cached DTD/schema is invalidated when parsing error is encountered.
Type: string
Constraints: Has Default Value: defer-to-registry-setting, Legal Values: true, false, defer-to-registry-setting
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The public ID of the external entity.
When WebLogic Server is parsing an XML document and it encounters an external entity with this public ID, WebLogic Server resolves the entity (to either a local file or a URL resource) according to the values set for this Entity spec entry.
Type: string
The system ID of the external entity.
When WebLogic Server is parsing an XML document and it encounters an external entity with this system ID, WebLogic Server resolves the entity (to either a local file or a URL resource) according to the values set for this Entity spec entry.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies when WebLogic Server should cache the external entities it retrieves from the Web.
WebLogic Server can cache the entities when they are referenced, as soon as possible (that is, on initialization) or never. Additionally, WebLogic Server can defer to the XML registry's cache setting.
Type: string
Constraints: Has Default Value: defer-to-registry-setting, Legal Values: cache-on-reference, cache-at-initialization, cache-never, defer-to-registry-setting
A Parser Select Entry specifies the SAX/DOM parser factory implementation classes for a particular document type.
By default, WebLogic server uses either the built-in (out-of-the-box) or default SAX/DOM parser factory implementation classes when it parses an XML document. However, you can specify that particular XML documents, based on their public IDs, system IDs, or root elements, use different parser factory implementation classes than the default. You do this by first creating an XML Registry and then creating a Parser Select entry and specifying how to identify the document and then the desired implementation classes.
The XML document type is identified by one or more of the following:
a public ID (e.g, "-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN"
a system ID (e.g, "http://java.sun.com/j2ee/dtds/ejb-jar_2_0.dtd")
a document root tag name (e.g., "ejb-jar")
This configuration information is used by the WebLogic JAXP implementation to choose the appropriate parser factories (SAX and DOM).
The properties of the weblogic.management.configuration.XMLParserSelectRegistryEntryMBean entity are as follows:
Specifies the fully qualified name of the class that implements the SAXParserFactory API.
When WebLogic Server begins to parse an XML document identified by either the public ID, system ID, or root element specified in this entry, and the applications specifies it wants a SAX parser, then WebLogic Server uses this implementation class when using the javax.xml.parsers.SAXParserFactory to obtain the SAX parser.
Type: string
Specifies the fully qualified name of the class that implements the DocumentBuilderFactory API
When WebLogic Server begins to parse an XML document identified by either the public ID, system ID, or root element specified in this entry, and the applications specifies it wants a DOM parser, then WebLogic Server uses this implementation class when using the javax.xml.parsers.DocumentBuilderFactory to obtain the DOM parser.
Type: string
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
Specifies the public ID of the XML document type for which this XML registry entry is being configured.
When WebLogic Server starts to parse an XML document that is identified with this public ID, it uses the SAX or DOM parser factory implementation class specified by this registry entry, rather than the built-in or default, when obtaining a SAX or DOM parser.
Type: string
Specifies the root element of the XML document type for which this XML registry entry is being configured.
When WebLogic Server starts to parse an XML document that is identified with this root element, it uses the SAX or DOM parser factory implementation class specified by this registry entry, rather than the built-in or default, when obtaining a SAX or DOM parser.
Type: string
Specifies the system ID of the XML document type for which this XML registry entry is being configured.
When WebLogic Server starts to parse an XML document that is identified with this system ID, it uses the SAX or DOM parser factory implementation class specified by this registry entry, rather than the built-in or default, when obtaining a SAX or DOM parser.
Type: string
Return all tags on this Configuration MBean
Type: array of string
Specifies the fully qualified name of the class that implements the TransformerFactory API.
When WebLogic Server begins to transform an XML document identified by either the public ID, system ID, or root element specified in this entry, then WebLogic Server uses this implementation class when using the javax.xml.transform.TranformerFactory factory to obtain a Transformer object.
Type: string
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Configure the behavior of JAXP (Java API for XML Parsing) in the server.
You configure this behavior by creating XML Registries that specify the default DOM and Sax factory implementation class, transformer factory implementation class, external entity resolution and caching.
The properties of the weblogic.management.configuration.XMLRegistryMBean entity are as follows:
The fully qualified name of the class that implements the SAXParserFactory interface.
The javax.xml.parsers.SAXParserFactory factory API enables applications deployed to WebLogic Server to configure and obtain a SAX-based XML parser to parse XML documents.
The built-in WebLogic Server SAX factory implementation class is com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl. This is the factory class applications deployed to WebLogic Server get by default when they request a SAX parser. You can change this default by updating this value.
Return the class name of the default SAXParserFactory
Type: string
Constraints: Has Default Value: weblogic.xml.jaxp.WebLogicSAXParserFactory
The fully qualified name of the class that implements the XMLEventFactory interface.
The javax.xml.stream.XMLEventFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XMLEvent object used to parse or build XML streams.
The built-in WebLogic Server XMLEvent factory implementation class is com.ctc.wstx.stax.WstxEventFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEvent object. You can change this default by updating this value.
Return the class name of the default XMLEventFactory
Type: string
Constraints: Has Default Value: weblogic.xml.jaxp.WebLogicXMLEventFactory
The fully qualified name of the class that implements the XMLInputFactory interface.
The javax.xml.stream.XMLInputFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XMLEventReader/XMLStreamReader object used to read XML streams.
The built-in WebLogic Server XML Input factory implementation class is com.ctc.wstx.stax.WstxInputFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEventReader/XMLStreamReader object. You can change this default by updating this value.
Return the class name of the default XMLInputFactory
Type: string
Constraints: Has Default Value: weblogic.xml.jaxp.WebLogicXMLInputFactory
The fully qualified name of the class that implements the XMLOutputFactory interface.
The javax.xml.stream.XMLOutputFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XMLEventWriter/XMLStreamWriter object used to write XML streams.
The built-in WebLogic Server XML Output factory implementation class is com.ctc.wstx.stax.WstxOutputFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEventWriter/XMLStreamWriter object. You can change this default by updating this value.
Return the class name of the default XMLOutputFactory
Type: string
Constraints: Has Default Value: weblogic.xml.jaxp.WebLogicXMLOutputFactory
The fully qualified name of the class that implements the DocumentBuilderFactory interface.
The javax.xml.parsers.DocumentBuilderFactory factory API enables applications deployed to WebLogic Server to obtain an XML parser that produces DOM object trees from XML documents.
The built-in WebLogic Server DOM factory implementation class is com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl. This is the factory class applications deployed to WebLogic Server get by default when they request a DOM parser. You can change this default by updating this value.
Return the class name of the default DocumentBuilderFactory
Type: string
Constraints: Has Default Value: weblogic.xml.jaxp.WebLogicDocumentBuilderFactory
Return whether the MBean was created dynamically or is persisted to config.xml
Type: boolean
Constraints: Read Only, Restart Required, Has Default Value: false
Whether cached DTD/schema is invalidated when parsing error is encountered.
Type: boolean
Constraints: Has Default Value: false
Return the unique id of this MBean instance
Type: long
Constraints: Read Only, Restart Required
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
Type: string
Constraints: Read Only, Restart Required, Legal Null: true
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.
Type: string
The fully qualified name of the class that implements the SchemaFactory interface.
The javax.xml.validation.SchemaFactory factory API enables applications deployed to WebLogic Server to configure and obtain a Schema object used to validate XML document using schema.
The built-in WebLogic Server Schema factory implementation class is com.sun.org.apache.xerces.internal.jaxp.validation.XMLSchemaFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a Schema object. You can change this default by updating this value.
Return the class name of the default SchemaFactory
Type: string
Constraints: Has Default Value: weblogic.xml.jaxp.WebLogicSchemaFactory
Return all tags on this Configuration MBean
Type: array of string
The fully qualified name of the class that implements the TransformerFactory interface.
The javax.xml.transform.TransformerFactory factory API enables applications deployed to WebLogic Server to configure and obtain a Transformer object used to transform XML data into another format.
The built-in WebLogic Server Transformer factory implementation class is com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryIml. This is the factory class applications deployed to WebLogic Server get by default when they request a Transformer object. You can change this default by updating this value.
Return the class name of the default TransformerFactory
Type: string
Constraints: Has Default Value: weblogic.xml.jaxp.WebLogicTransformerFactory
Returns the type of the MBean.
Type: string
Constraints: Read Only, Restart Required
Specifies when WebLogic Server should cache external entities that it retrieves from the Web.
When WebLogic Server resolves an external entity within an XML file and retrieves the entity from the Web, you can specify that WebLogic Server cache this entity only when the entity is first referenced, when WebLogic Server first starts up, or not at all.
Type: string
Constraints: Has Default Value: cache-on-reference, Legal Values: cache-on-reference, cache-at-initialization, cache-never
The fully qualified name of the class that implements the XPathFactory interface.
The javax.xml.xpath.XPathFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XPath object used to search XML elements.
The built-in WebLogic Server XPath factory implementation class is com.sun.org.apache.xpath.internal.jaxp.XPathFactoryImpl. This is the factory class applications deployed to WebLogic Server get by default when they request a XPath object. You can change this default by updating this value.
Return the class name of the default XPathFactory
Type: string
Constraints: Has Default Value: weblogic.xml.jaxp.WebLogicXPathFactory
The authenticated user that is making the request.
The properties of the weblogic.management.rest.bean.model.CurrentUser entity are as follows:
The ID of the partition where the component that is being invoked resides.
Type: string
The human readable name of the partition ID.
Type: string
The login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
Type: string
A Version entity describes a version of the WebLogic Server resources.
The properties of the weblogic.management.rest.bean.model.Version entity are as follows:
True if this is the default version.
Type: boolean
The lifecycle of this version: active or deprecated
Type: string
The name of this version.
Type: string
The MBean that represents configuration attributes for a RDBMS security store. It is used to specify the required and optional properties for connecting to a RDBMS back-end store.
The properties of the weblogic.management.security.RDBMSSecurityStoreMBean entity are as follows:
The number of times to attempt to reconnect if the JMS system notifies Kodo of a serious connection error.
The default is 0, and by default the error is logged but ignored. The value cannot be less than 0.
Type: int
Constraints: Restart Required, Has Default Value: 0, Minimum Value: 0
The JMS topic to which the Kodo remote commit provider should publish notifications and subscribe for notifications sent from other JVMs. This setting varies depending on the application server in use.
Type: string
Constraints: Restart Required
The JNDI name of a javax.jms.TopicConnectionFactory instance to use for finding JMS topics.
This setting varies depending on the application server in use. Consult the JMS documentation for details about how this parameter should be specified.
Type: string
Constraints: Restart Required
The password to authenticate the user defined in the JNDIUsername attribute for Kodo notification.
When getting the value of this attribute, WebLogic Server does the following:
Retrieves the value of the JNDIPasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the JNDIPasswordEncrypted attribute to the encrypted value.
Using this attribute (JNDIPassword) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use JNDIPasswordEncrypted
Type: string
Constraints: Restart Required, Encrypted
The JNDI user name used for Kodo notification.
Type: string
Constraints: Restart Required
The JDBC driver specific connection parameters. This attribute is a comma-delimited list of key-value properties to pass to the driver for configuration of JDBC connection pool, in the form of xxKey=xxValue, xxKey=xxValue
The syntax of the attribute will be validated and an InvalidAttributeValueException is thrown if the check failed.
Type: string
Constraints: Restart Required
The URL of the database to which to connect. The format of the URL varies by JDBC driver.
The URL is passed to the JDBC driver to create the physical database connections.
Type: string
Constraints: Restart Required, Legal Null: true
The full package name of the JDBC driver class used to create the physical database connections in the connection pool. Note that this driver class must be in the classpath of any server to which it is deployed.
For example:
oracle.jdbc.OracleDriver
com.microsoft.sqlserver.jdbc.SQLServerDriver
It must be the name of a class that implements the java.sql.Driver interface. The full pathname of the JDBC driver is available in the documentation.
Type: string
Constraints: Restart Required, Legal Null: true
The name of this configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: RDBMSSecurityStore
The comma-delimited list of key-value properties to pass to the JNDI InitialContext on construction, in the form of xxKey=xxValue, xxKey=xxValue
The following are examples of keys:
java.naming.provider.url: property for specifying configuration information for the service provider to use. The value of the property should contain a URL string (For example: iiops://localhost:7002).
java.naming.factory.initial: property for specifying the initial context factory to use. The value of the property should be the fully qualified class name of the factory class that will create an initial context (For example: weblogic.jndi.WLInitialContextFactory).
When setting the attribute, the syntax of its value is validated, and an InvalidAttributeValueException is thrown if the check fails.
Type: string
Constraints: Restart Required
The password for the user specified in the Username attribute for connecting to the datastore.
When getting the value of this attribute, WebLogic Server does the following:
Retrieves the value of the PasswordEncrypted attribute.
Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
Sets the value of the PasswordEncrypted attribute to the encrypted value.
Note that use of the Password attribute is a potential security risk because the String object that contains the unencrypted password remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use PasswordEncrypted
Type: string
Constraints: Restart Required, Encrypted
Returns the realm that contains this RDBMS security store. Returns null if this RDBMS security store is not contained by a realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Read Only, Restart Required
The username to use when connecting to the datastore.
Type: string
Constraints: Restart Required, Legal Null: true
The MBean that represents configuration attributes for the security realm.
A security realm contains a set of security configuration settings, including the list of security providers to use (for example, for authentication and authorization).
Code using security can either use the default security realm for the domain or refer to a particular security realm by name (by using the JMX display name of the security realm).
One security realm in the WebLogic domain must have the DefaultRealm attribute set to true. The security realm with the DefaultRealm attribute set to true is used as the default security realm for the WebLogic domain. Note that other available security realms must have the DefaultRealm attribute set to false.
When WebLogic Server boots, it locates and uses the default security realm. The security realm is considered active since it is used when WebLogic Server runs. Any security realm that is not used when WebLogic Server runs is considered inactive. All active security realms must be configured before WebLogic Server is boots.
Since security providers are scoped by realm, the Realm attribute on a security provider must be set to the realm that uses the provider.
The properties of the weblogic.management.security.RealmMBean entity are as follows:
Returns the types of Adjudication providers that may be created in this security realm, for example, weblogic.security.providers.authorization.DefaultAdjudicator. Use this method to find the available types to pass to createAdjudicator
Type: array of string
Constraints: Read Only, Restart Required
Returns the types of Auditing providers that may be created in this security realm, for example, weblogic.security.providers.audit.DefaultAuditor. Use this method to find the available types to pass to createAuditor
Type: array of string
Constraints: Read Only, Restart Required
Returns a comma separated string of authentication methods that should be used when the Web application specifies "REALM" as its auth-method. The authentication methods will be applied in order in which they appear in the list.
Type: string
Constraints: Restart Required
Returns the types of Authentication providers that may be created in this security realm, for example, weblogic.security.providers.authentication.DefaultAuthenticator. Use this method to find the available types to pass to createAuthenticationProvider
Type: array of string
Constraints: Read Only, Restart Required
Returns the types of Authorization providers that may be created in this security realm, for example, weblogic.security.providers.authorization.DefaultAuthorizer. Use this method to find the available types to pass to createAuthorizer
Type: array of string
Constraints: Read Only, Restart Required
Specifies whether the Realm will be auto-restarted if non-dynamic changes are made to the realm or providers within the realm.
Type: boolean
Returns the CertPath Builder provider in this security realm that will be used by the security system to build certification paths. Returns null if none has been selected. The provider will be one of this security realm's CertPathProviders
Type: weblogic.management.security.pk.CertPathBuilderMBean reference
Constraints: Restart Required
Returns the types of Certification Path providers that may be created in this security realm, for example, weblogic.security.providers.pk.WebLogicCertPathProvider. Use this method to find the available types to pass to createCertPathProvider
Type: array of string
Constraints: Read Only, Restart Required
Determines how the role mappings in the Enterprise Application, Web application, and EJB containers interact. This setting is valid only for Web applications and EJBs that use the Advanced security model and that initialize roles from deployment descriptors.
When enabled:
Application role mappings are combined with EJB and Web application mappings so that all principal mappings are included. The Security Service combines the role mappings with a logical OR operator.
If one or more policies in the web.xml file specify a role for which no mapping exists in the weblogic.xml file, the Web application container creates an empty map for the undefined role (that is, the role is explicitly defined as containing no principal). Therefore, no one can access URL patterns that are secured by such policies.
If one or more policies in the ejb-jar.xml file specify a role for which no mapping exists in the weblogic-ejb-jar.xml file, the EJB container creates an empty map for the undefined role (that is, the role is explicitly defined as containing no principal). Therefore, no one can access methods that are secured by such policies.
When disabled:
Role mappings for each container are exclusive to other containers unless defined by the <externally-defined> descriptor element.
If one or more policies in the web.xml file specify a role for which no role mapping exists in the weblogic.xml file, the Web application container assumes that the undefined role is the name of a principal. It therefore maps the assumed principal to the role name. For example, if the web.xml file contains the following stanza in one of its policies:
<auth-constraint> <role-name>PrivilegedUser</role-name> </auth-constraint>
but, if the weblogic.xml file has no role mapping for PrivilegedUser, then the Web application container creates an in-memory mapping that is equivalent to the following stanza:
<security-role-assignment> <role-name>PrivilegedUser</role-name> <principal-name>PrivilegedUser</principal-name> </security-role-assignment>
Role mappings for EJB methods must be defined in the weblogic-ejb-jar.xml file. Role mappings defined in the other containers are not used unless defined by the <externally-defined> descriptor element.
For all applications previously deployed in version 8.1 and upgraded to version 9.x, the combining role mapping is disabled by default.
Type: boolean
Constraints: Has Default Value: true
Returns the types of Credential Mapping providers that may be created in this security realm, for example, weblogic.security.providers.credentials.DefaultCredentialMapper. Use this method to find the available types to pass to createCredentialMapper
Type: array of string
Constraints: Read Only, Restart Required
Configures the WebLogic Server MBean servers to use the security realm's Authorization providers to determine whether a JMX client has permission to access an MBean attribute or invoke an MBean operation.
You can continue to use WebLogic Server's default security settings or modify the defaults to suit your needs.
If you do not delegate authorization to the realm's Authorization providers, the WebLogic MBean servers allow access only to the four default security roles (Admin, Deployer, Operator, and Monitor) and only as specified by WebLogic Server's default security settings.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Specifies whether synchronization for deployable Authorization and Role Mapping providers is enabled.
The Authorization and Role Mapping providers may or may not support parallel security policy and role modification, respectively, in the security provider database. If the security providers do not support parallel modification, the WebLogic Security Framework enforces a synchronization mechanism that results in each application and module being placed in a queue and deployed sequentially.
Type: boolean
Constraints: Restart Required, Has Default Value: false
Returns the timeout value, in milliseconds, for the deployable security provider synchronization operation. This value is only used if DeployableProviderSynchronizationEnabled is set to true
Type: int
Constraints: Restart Required, Has Default Value: 60000
Returns whether the WebLogic Principal Validator caching is enabled.
The Principal Validator is used by Oracle supplied authentication providers and may be used by custom authentication providers. If enabled, the default principal validator will cache WebLogic Principal signatures.
Type: boolean
Constraints: Restart Required, Has Default Value: true
Sets the Management Identity Domain value for the realm.
Type: string
Constraints: Restart Required
Returns the maximum size of the LRU cache for holding WebLogic Principal signatures. This value is only used if EnableWebLogicPrincipalValidatorCache is set to true
Type: int
Constraints: Restart Required, Has Default Value: 500
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: Realm
Returns the types of Password Validator providers that may be created in this security realm, for example, com.bea.security.providers.authentication.passwordvalidator.SystemPasswordValidator. Use this method to find the available types to pass to createPasswordValidator
Type: array of string
Constraints: Read Only, Restart Required
Specifies the retire timeout for a realm that is restarted. The old realm will be shutdown after the specified timeout period has elapsed.
Type: int
Constraints: Has Default Value: 60, Minimum Value: 1
Returns the types of Role Mapping providers that may be created in this security realm, for example, weblogic.security.providers.authorization.DefaultRoleMapper. Use this method to find the available types to pass to createRoleMapper
Type: array of string
Constraints: Read Only, Restart Required
Specifies the default security model for Web applications or EJBs that are secured by this security realm. You can override this default during deployment.
Note: 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 default value of the AppDeploymentMBean SecurityDDModel attribute (see weblogic.management.configuration.AppDeploymentMBean#getSecurityDDModel() getSecurityDDModel).
Choose one of these security models:
Deployment Descriptors Only (DDOnly)
For EJBs and URL patterns, this model uses only the roles and policies in the J2EE deployment descriptors (DD); the Administration Console allows only read access for this data. With this model, EJBs and URL patterns are not protected by roles and policies of a broader scope (such as a policy scoped to an entire Web application). If an EJB or URL pattern is not protected by a role or policy in the DD, then it is unprotected: anyone can access it.
For application-scoped roles in an EAR, this model uses only the roles defined in the WebLogic Server DD; the Administration Console allows only read access for this data. If the WebLogic Server DD does not define roles, then there will be no such scoped roles defined for this EAR.
For all other types of resources, you can use the Administration Console to create roles or policies. For example, with this model, you can use the Administration Console to create application-scoped policies for an EAR.
Applies for the life of the deployment. If you want to use a different model, you must delete the deployment and reinstall it.
Customize Roles Only (CustomRoles)
For EJBs and URL patterns, this model uses only the policies in the J2EE deployment descriptors (DD). EJBs and URL patterns are not protected by policies of a broader scope (such as a policy scoped to an entire Web application). This model ignores any roles defined in the DDs; an administrator completes the role mappings using the Administration Console.
For all other types of resources, you can use the Administration Console to create roles or policies. For example, with this model, you can use the Administration Console to create application-scoped policies or roles for an EAR.
Applies for the life of the deployment. If you want to use a different model, you must delete the deployment and reinstall it.
Customize Roles and Policies (CustomRolesAndPolicies)
Ignores any roles and policies defined in deployment descriptors. An administrator uses the Administration Console to secure the resources.
Performs security checks for all URLs or EJB methods in the module.
Applies for the life of the deployment. If you want to use a different model, you must delete the deployment and reinstall it.
Advanced (Advanced)
You configure how this model behaves by setting values for the following options:
When Deploying Web Applications or EJBs
Note: When using the WebLogic Scripting Tool or JMX APIs, there is no single MBean attribute for this setting. Instead, you must set the values for the DeployPolicyIgnored and DeployRoleIgnored attributes of RealmMBean
Check Roles and Policies (FullyDelegateAuthorization)
Combined Role Mapping Enabled (CombinedRoleMappingEnabled)
You can change the configuration of this model. Any changes immediately apply to all modules that use the Advanced model. For example, you can specify that all modules using this model will copy roles and policies from their deployment descriptors into the appropriate provider databases upon deployment. After you deploy all of your modules, you can change this behavior to ignore roles and policies in deployment descriptors so that when you redeploy modules they will not re-copy roles and policies.
Note: Prior to WebLogic Server version 9.0 the Advanced model was the only security model available. Use this model if you want to continue to secure EJBs and Web Applications as in releases prior to 9.0.
Type: string
Constraints: Has Default Value: DDOnly, Legal Values: DDOnly, CustomRoles, CustomRolesAndPolicies, Advanced
Not used in this release.
Type: boolean
Constraints: Has Default Value: false
The SSPI MBean that all Audit providers must extend.
The properties of the weblogic.management.security.audit.AuditorMBean entity are as follows:
Returns a description of this security provider.
Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's MBean hard-wires its description. There are no conventions governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: Provider
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Read Only, Restart Required
Returns this security provider's version.
Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.
Type: string
Constraints: Read Only, Restart Required
The base MBean for all MBean implementations that manage Authentication providers. If your Authentication provider uses the WebLogic Security SSPI to provide login services, then your MBean must extend weblogic.management.security.authentication.Authenticator. If your Authentication provider uses the WebLogic Security SSPI to provide identity-assertion services, then your MBean must extend weblogic.management.security.authentication.IdentityAsserter
The properties of the weblogic.management.security.authentication.AuthenticationProviderMBean entity are as follows:
Returns a description of this security provider.
Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's MBean hard-wires its description. There are no conventions governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: Provider
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Read Only, Restart Required
Returns this security provider's version.
Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.
Type: string
Constraints: Read Only, Restart Required
A marker interface to indicate a password validation provider MBean. All password validation provider MBeans must extend this interface.
The properties of the weblogic.management.security.authentication.PasswordValidatorMBean entity are as follows:
Returns a description of this security provider.
Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's MBean hard-wires its description. There are no conventions governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: Provider
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Read Only, Restart Required
Returns this security provider's version.
Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.
Type: string
Constraints: Read Only, Restart Required
Lists and manages lockouts on user accounts.
The properties of the weblogic.management.security.authentication.UserLockoutManagerMBean entity are as follows:
Returns the number of invalid login records that the server places in a cache. The server creates one record for each invalid login.
Type: long
Constraints: Restart Required, Has Default Value: 5, Minimum Value: 0, Maximum Value: 2147483647
Returns the number of minutes that a user account is locked out.
Type: long
Constraints: Restart Required, Has Default Value: 30, Minimum Value: 0, Maximum Value: 2147483647
Returns whether the server locks out users when there are invalid login attempts. A true value for this attribute causes the server to consider the other attributes of this MBean. A false value causes the server to ignore the other attributes of this MBean."
Type: boolean
Constraints: Restart Required, Has Default Value: true
Returns the maximum number of invalid login records that the server keeps in memory.
If the number of invalid login records is equal to or greater than this value, the server's garbage collection purges the records that have expired. A record expires when the user associated with the record has been locked out.
The lower the threshold, the more often the server uses its resources to collect garbage.
Type: long
Constraints: Restart Required, Has Default Value: 400, Minimum Value: 0, Maximum Value: 2147483647
The number of minutes within which consecutive invalid login attempts cause the user account to be locked out.
Type: long
Constraints: Restart Required, Has Default Value: 5, Minimum Value: 1, Maximum Value: 2147483647
Returns the maximum number of consecutive invalid login attempts before account is locked out. When the number of invalid logins within a specified period of time is greater than LockoutThresholdvalue, the user is locked out. For example, with the default setting of , the user is locked out on the second consecutive invalid login. With a setting of , the user is locked out on the third consecutive invalid login.
Type: long
Constraints: Restart Required, Has Default Value: 5, Minimum Value: 1, Maximum Value: 2147483647
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: UserLockoutManager
Returns the realm that contains this user lockout manager. Returns null if this security provider is not contained by a realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Read Only, Restart Required
The SSPI MBean that all Adjudication providers must extend.
The properties of the weblogic.management.security.authorization.AdjudicatorMBean entity are as follows:
Returns a description of this security provider.
Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's MBean hard-wires its description. There are no conventions governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: Provider
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Read Only, Restart Required
Returns this security provider's version.
Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.
Type: string
Constraints: Read Only, Restart Required
The base MBean for Authorization providers. An Authorization provider for a non-deployable module must extend this MBean directly. An Authorization provider for a deployable module must extend the DeployableAuthorizer MBean.
The properties of the weblogic.management.security.authorization.AuthorizerMBean entity are as follows:
Returns a description of this security provider.
Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's MBean hard-wires its description. There are no conventions governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: Provider
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Read Only, Restart Required
Returns this security provider's version.
Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.
Type: string
Constraints: Read Only, Restart Required
The base MBean for Role Mapping providers. A Role Mapping provider for a non-deployable module must extend this MBean directly. A Role Mapping provider for a deployable module must extend the DeployableRoleMapperMBean interface.
The properties of the weblogic.management.security.authorization.RoleMapperMBean entity are as follows:
Returns a description of this security provider.
Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's MBean hard-wires its description. There are no conventions governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: Provider
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Read Only, Restart Required
Returns this security provider's version.
Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.
Type: string
Constraints: Read Only, Restart Required
The SSPI MBean that all Credential Mapping providers must extend. The base MBean for Credential Mapping providers. A Credential Mapping provider for a non-deployable module must extend this MBean directly. An Credential Mapping provider for a deployable module must extend DeployableCredentialMapper
The properties of the weblogic.management.security.credentials.CredentialMapperMBean entity are as follows:
Returns a description of this security provider.
Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's MBean hard-wires its description. There are no conventions governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: Provider
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Read Only, Restart Required
Returns this security provider's version.
Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.
Type: string
Constraints: Read Only, Restart Required
The base MBean for all MBean implementations that manage certification path providers. If your certification path provider provides CertPathBuilder services, then your MBean must extend weblogic.management.security.pk.CertPathBuilder. If your certification path provider provides CertPathValidator services, then your MBean must extend weblogic.management.security.pk.CertPathValidator
The properties of the weblogic.management.security.pk.CertPathProviderMBean entity are as follows:
Returns a description of this security provider.
Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's MBean hard-wires its description. There are no conventions governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.
Type: string
Constraints: Read Only, Restart Required
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Type: string
Constraints: Read Only, Restart Required, Has Default Value: Provider
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
Type: weblogic.management.security.RealmMBean reference
Constraints: Read Only, Restart Required
Returns this security provider's version.
Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.
Type: string
Constraints: Read Only, Restart Required