FileStoreMBean
Overview | Related MBeans | Attributes | Operations
Overview
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.
Since 9.0.0.0 Fully Qualified Interface Name If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.FileStoreMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Related MBeans
This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.
Targets
The server instances or migratable targets defined in the current domain that are candidates for hosting the file store.
In a clustered environment, a recommended best practice is to target a custom file store to the same migratable target as the migratable JMS service, so that a member server will not be a single point of failure. A file store can also be configured to automatically migrate from an unhealthy server instance to a healthy server instance with the help of the server health monitoring services.
Privileges Read/Write Type TargetMBean[] Relationship type: Reference.
Attributes
This section describes the following attributes:
CachingDisabled
Private property that disables caching in proxies.
Privileges Read only Type boolean Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.
DeploymentOrder
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.
Privileges Read/Write Type int Default Value 1000 Minimum value 0 Maximum value 2147483647
LogicalName
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.
Privileges Read/Write Type java.lang.String
MBeanInfo
Returns the MBean info for this MBean.
Deprecated.
Privileges Read only Type javax.management.MBeanInfo Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.
Name of
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 of=user-specified-name
Privileges Read/Write Type java.lang.String
Notes
Optional information that you can include to describe this configuration.
WebLogic Sever saves this note in the domain's configuration file (
config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity<. Carriage returns/line feeds are preserved.
- Note:
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Privileges Read/Write Type java.lang.String
ObjectName
Returns the ObjectName under which this MBean is registered in the MBean server.
Deprecated.
Privileges Read only Type weblogic.management.WebLogicObjectName Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.
Parent
Return the immediate parent for this MBean
Privileges Read/Write Type
Registered
Returns false if the the MBean represented by this object has been unregistered.
Deprecated.
Privileges Read only Type boolean Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.
Type
Returns the type of the MBean.
Privileges Read only Type java.lang.String Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.
XAResourceName
Override 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.
Privileges Read only Type java.lang.String Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.
Operations
This section describes the following operations:
addTarget
Targets a server instance to a store.
Operation Name "addTarget"Parameters Object [] { }where:
Signature String [] { "weblogic.management.configuration.TargetMBean" }Returns booleanExceptions
javax.management.InvalidAttributeValueException
weblogic.management.DistributedManagementException
freezeCurrentValue
If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.
Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.
- Note:
To insure that you are freezing the default value, invoke the
restoreDefaultValue operation before you invoke this.This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.
Deprecated.
9.0.0.0
Operation Name "freezeCurrentValue"Parameters Object [] { attributeName }where:
attributeName is an object of typejava.lang.String that specifies:
attributeName
Signature String [] { "java.lang.String" }Returns voidExceptions
javax.management.AttributeNotFoundException
javax.management.MBeanException
isSet
Returns true if the specified attribute has been set explicitly in this MBean instance.
Operation Name "isSet"Parameters Object [] { propertyName }where:
propertyName is an object of typejava.lang.String that specifies:
property to check
Signature String [] { "java.lang.String" }Returns boolean
removeTarget
Untargets a server instance from a store.
Operation Name "removeTarget"Parameters Object [] { }where:
Signature String [] { "weblogic.management.configuration.TargetMBean" }Returns booleanExceptions
javax.management.InvalidAttributeValueException
weblogic.management.DistributedManagementException
restoreDefaultValue
If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.
Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the
freezeCurrentValue operation.This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.
Deprecated.
9.0.0.0
Operation Name "restoreDefaultValue"Parameters Object [] { attributeName }where:
attributeName is an object of typejava.lang.String that specifies:
attributeName
Signature String [] { "java.lang.String" }Returns voidExceptions
javax.management.AttributeNotFoundException
unSet
Restore the given property to its default value.
Operation Name "unSet"Parameters Object [] { propertyName }where:
propertyName is an object of typejava.lang.String that specifies:
property to restore
Signature String [] { "java.lang.String" }Returns void