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.

       
Since9.0.0.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.FileStoreMBean
Factory Methods
Access Points Inherited from DeploymentMBean Because this MBean extends or implements DeploymentMBean, you can also access this MBean by retrieving DeploymentMBeans. The following attributes contain DeploymentMBeans and its subtypes:
    Access Points Inherited from PersistentStoreMBean Because this MBean extends or implements PersistentStoreMBean, you can also access this MBean by retrieving PersistentStoreMBeans. The following attributes contain PersistentStoreMBeans and its subtypes:


    Related MBeans

    This section describes attributes that provide access to other MBeans.


      Targets

      The server instances, dynamic clusters, or migratable targets defined in the current domain that are candidates for hosting a file store or JDBC store.

      When selecting a dynamic cluster, the file store must be targeted to the same dynamic cluster as the JMS server. When selecting a migratable target, the file 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 migratable target.

             
      Privileges Read/Write
      TypeTargetMBean[]
      Relationship type: Reference.


      Attributes

      This section describes the following attributes:


      BlockSize

      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.

             
      Privileges Read/Write
      Typeint
      Default Value-1
      Minimum value-1
      Maximum value8192

      CacheDirectory

      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/DomainName/unique-id/ StoreNameFileNum.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:



             
      Privileges Read/Write
      Typejava.lang.String

      CachingDisabled

      Private property that disables caching in proxies.

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

      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
      Typeint
      Default Value1000
      Minimum value0
      Maximum value2147483647

      Directory

      The path name to the file system directory where the file store maintains its data files.

             
      Privileges Read/Write
      Typejava.lang.String

      DynamicallyCreated

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

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

      FileLockingEnabled

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

      Id

      Return the unique id of this MBean instance

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

      InitialSize

      The initial file size, in bytes.



             
      Privileges Read/Write
      Typelong
      Default Value0
      Minimum value0

      IoBufferSize

      The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.



             
      Privileges Read/Write
      Typeint
      Default Value-1
      Minimum value-1
      Maximum value67108864

      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
      Typejava.lang.String

      MaxFileSize

      The maximum file size, in bytes.



             
      Privileges Read/Write
      Typelong
      Default Value1342177280
      Minimum value1048576

      MaxWindowBufferSize

      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.

             
      Privileges Read/Write
      Typeint
      Default Value-1
      Minimum value-1
      Maximum value1073741824

      MBeanInfo

      Returns the MBean info for this MBean.

      Deprecated.

             
      Privileges Read only
      Typejavax.management.MBeanInfo
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      MinWindowBufferSize

      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.

             
      Privileges Read/Write
      Typeint
      Default Value-1
      Minimum value-1
      Maximum value1073741824

      Name

      The user-specified name of this MBean instance.

      This name is included as one of the key properties in the MBean's javax.management.ObjectName:
      Name=user-specified-name

             
      Privileges Read/Write
      Typejava.lang.String

      Notes

      Optional information that you can include to describe this configuration.

      WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

      Note:

      If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

             
      Privileges Read/Write
      Typejava.lang.String

      ObjectName

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

      Deprecated.

             
      Privileges Read only
      Typeweblogic.management.WebLogicObjectName
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Parent

      Return the immediate parent for this MBean

             
      Privileges Read/Write
      Type

      Registered

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

      Deprecated.

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

      SynchronousWritePolicy

      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:

      Notes:

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueDirect-Write
      Legal Values
      • Disabled
      • Cache-Flush
      • Direct-Write
      • Direct-Write-With-Cache

      Type

      Returns the type of the MBean.

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

      XAResourceName

      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.

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


      Operations

      This section describes the following operations:


      addTarget

      Targets a server instance to a store.

         
      Operation Name"addTarget"
      ParametersObject [] {   }

      where:

        SignatureString [] { "weblogic.management.configuration.TargetMBean" }
        Returns boolean
        Exceptions
        • 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"
        ParametersObject [] {  attributeName }

        where:

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

          attributeName

        SignatureString [] { "java.lang.String" }
        Returns void
        Exceptions
        • javax.management.AttributeNotFoundException
        • javax.management.MBeanException

        getInheritedProperties

        return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

           
        Operation Name"getInheritedProperties"
        ParametersObject [] {  propertyNames }

        where:

        • propertyNames is an object of type [Ljava.lang.String; that specifies:

          properties to check

        SignatureString [] { "[Ljava.lang.String;" }
        Returns class

        isInherited

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

           
        Operation Name"isInherited"
        ParametersObject [] {  propertyName }

        where:

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

          the name of the property

        SignatureString [] { "java.lang.String" }
        Returns boolean

        isSet

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

           
        Operation Name"isSet"
        ParametersObject [] {  propertyName }

        where:

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

          property to check

        SignatureString [] { "java.lang.String" }
        Returns boolean

        removeTarget

        Untargets a server instance from a store.

           
        Operation Name"removeTarget"
        ParametersObject [] {   }

        where:

          SignatureString [] { "weblogic.management.configuration.TargetMBean" }
          Returns boolean
          Exceptions
          • javax.management.InvalidAttributeValueException
          • weblogic.management.DistributedManagementException

          restoreDefaultValue

          If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

          Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

          This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

          Deprecated. 9.0.0.0

             
          Operation Name"restoreDefaultValue"
          ParametersObject [] {  attributeName }

          where:

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

            attributeName

          SignatureString [] { "java.lang.String" }
          Returns void
          Exceptions
          • javax.management.AttributeNotFoundException

          unSet

          Restore the given property to its default value.

             
          Operation Name"unSet"
          ParametersObject [] {  propertyName }

          where:

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

            property to restore

          SignatureString [] { "java.lang.String" }
          Returns void