Package com.arjuna.ats.arjuna.tools.osb.mbean

Class ObjStoreBrowser

java.lang.Object
com.arjuna.ats.arjuna.tools.osb.mbean.ObjStoreBrowser
All Implemented Interfaces:
ObjStoreBrowserMBean, ObjStoreItemMBean
@Deprecated public class ObjStoreBrowser extends Object implements ObjStoreBrowserMBean
Deprecated.
as of 5.0.5.Final In a subsequent release we will change packages names in order to provide a better separation between public and internal classes.
An MBean implementation for walking an ObjectStore and creating/deleting MBeans that represent completing transactions (ie ones on which the user has called commit)
Author:
Mike Musgrove

  • Field Details

  • Constructor Details

    • ObjStoreBrowser

      public ObjStoreBrowser()
      Deprecated.

      This is the constructor for the default configuration of ObjStoreBrowser.

      This class has been designed with the assumption that only one instance of ObjStoreBrowser should be used. In other words, this class should be considered as a singleton class. In fact, if two ObjStoreBrowser instances are created, they may interfere with each other.

    • ObjStoreBrowser

      public ObjStoreBrowser(String logDir)
      Deprecated.

      This is the constructor to configure ObjStoreBrowser with a path to load the Object Store.

      This class has been designed with the assumption that only one instance of ObjStoreBrowser should be used. In other words, this class should be considered as a singleton class. In fact, if two ObjStoreBrowser instances are created, they may interfere with each other.

  • Method Details

    • getHeaderStateUnpacker

      public static HeaderStateReader getHeaderStateUnpacker(String type)
      Deprecated.

    • start

      public void start()
      Deprecated.
      Initialise the MBean

    • stop

      public void stop()
      Deprecated.
      Unregister all MBeans representing objects in the ObjectStore represented by this MBean

    • unregisterMBeans

      protected void unregisterMBeans()
      Deprecated.

    • getObjStoreBrowserMBeanName

      public String getObjStoreBrowserMBeanName()
      Deprecated.
      Returns the JMX name that the MBean that was registered with. If the MBean was not yet registered then the method returns the name provided by configuration within the ObjectStoreEnvironmentBean.getJmxToolingMBeanName().
      Returns:
      name of the JMX

    • setTypes

      @Deprecated public void setTypes(Map<String,String> types)
      Deprecated.
      This method is deprecated in favour of setType(String, String). The issue with this method is there is no mechanism for determining which class is responsible for a given OS type. This method is a no-action method. Define which object store types will be registered as MBeans
      Parameters:
      types - the list of ObjectStore types that can be represented as MBeans

    • setType

      public boolean setType(String osTypeClassName, String beanTypeClassName)
      Deprecated.
      Tell the object browser which beans to use for particular Object Store Action type
      Parameters:
      osTypeClassName - StateManager type class name
      beanTypeClassName - bean class name which makes tooling available on top of the osTypeClassName
      Returns:
      whether the type was set OK

    • addType

      public boolean addType(String typeName, String osTypeClassName, String beanTypeClassName)
      Deprecated.
      Add the type to be considered by object browser. See setType(String, String).
      Parameters:
      typeName - type name that the bean will operate at
      osTypeClassName - StateManager type class name
      beanTypeClassName - bean class name which makes tooling available on top of the osTypeClassName
      Returns:
      whether the type was set OK

    • registerHandler

      public OSBTypeHandler registerHandler(OSBTypeHandler handler)
      Deprecated.
      Parameters:
      handler - specification for handling object store types
      Returns:
      the previous value associated with type handler, or null if there was no previous handler.

    • dump

      public StringBuilder dump(StringBuilder sb)
      Deprecated.
      Dump info about all registered MBeans
      Parameters:
      sb - a buffer to contain the result
      Returns:
      the passed in buffer

    • findUid

      public UidWrapper findUid(Uid uid)
      Deprecated.
      See if the given uid has previously been registered as an MBean
      Parameters:
      uid - the unique id representing an ObjectStore entry
      Returns:
      the MBean wrapper corresponding to the requested Uid (or null if it hasn't been registered)

    • findUid

      @Deprecated public UidWrapper findUid(String uid)
      Deprecated.
      use findUid(com.arjuna.ats.arjuna.common.Uid) instead.
      Find the registered bean corresponding to a uid.
      Parameters:
      uid - the uid
      Returns:
      the registered bean or null if the Uid is not registered

    • viewSubordinateAtomicActions

      public void viewSubordinateAtomicActions(boolean enable)
      Deprecated.
      Specified by:
      viewSubordinateAtomicActions in interface ObjStoreBrowserMBean

    • setExposeAllRecordsAsMBeans

      public void setExposeAllRecordsAsMBeans(boolean exposeAllLogs)
      Deprecated.
      Specified by:
      setExposeAllRecordsAsMBeans in interface ObjStoreBrowserMBean

    • probe

      public void probe() throws MBeanException
      Deprecated.
      See if any new MBeans need to be registered or if any existing MBeans no longer exist as ObjectStore entries.
      Specified by:
      probe in interface ObjStoreBrowserMBean
      Throws:
      MBeanException - exception is thrown when it's not possible to list Uids from object store

    • probe

      public List<UidWrapper> probe(String type)
      Deprecated.
      Register new MBeans of the requested type (or unregister ones whose corresponding ObjectStore entry has been removed)
      Parameters:
      type - the ObjectStore entry type
      Returns:
      the list of MBeans representing the requested ObjectStore type

    • canonicalType

      public static String canonicalType(String type)
      Deprecated.