Class ManagedObjectManagerNOPImpl

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, ManagedObjectManager

    class ManagedObjectManagerNOPImpl
    extends java.lang.Object
    implements ManagedObjectManager
    NOP impl of ManagedObjectManager used when annotations and ManagedObjectManager are needed, but MBeans are not. This allows using gmbal to optionally support MBeans. This is the implementation of the ManagedObjectManager that is used when the full implementation is not available.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAnnotation​(java.lang.reflect.AnnotatedElement element, java.lang.annotation.Annotation annotation)
      Method to add an annotation to an element that cannot be modified.
      void addInheritedAnnotations​(java.lang.Class<?> cls)
      Add all annotations for this class as if they were declared on the inheritance parent(s) of the class (immediate superclass for a class, all immediate superinterfaces for an interface).
      void close()  
      GmbalMBean createRoot()
      Create a default root MBean.
      GmbalMBean createRoot​(java.lang.Object root)
      Create a root MBean from root, which much have a method with the @NameValue annotation.
      GmbalMBean createRoot​(java.lang.Object root, java.lang.String name)
      Create a root MBean from root with the given name.
      java.lang.String dumpSkeleton​(java.lang.Object obj)
      Dump the skeleton used in the implementation of the MBean for obj.
      AMXClient getAMXClient​(java.lang.Object obj)
      Get an AMXClient instance for the object obj, if obj is registered as an MBean in this mom.
      java.lang.String getDomain()
      Return the domain name that was used when this ManagedObjectManager was created.
      javax.management.MBeanServer getMBeanServer()
      Get the current MBeanServer.
      java.lang.Object getObject​(javax.management.ObjectName oname)
      Get the Object that was registered with the given ObjectName.
      javax.management.ObjectName getObjectName​(java.lang.Object obj)
      Get the ObjectName for the given object (which must have been registered via a register call).
      ObjectRegistrationManager getObjectRegistrationManager()
      Return an ObjectRegistrationManager as required in the pfl timer services.
      java.util.ResourceBundle getResourceBundle()
      Get the resource bundle (if any) set by setResourceBundle.
      java.lang.Object getRoot()
      Return the root of this ManagedObjectManager.
      boolean isManagedObject​(java.lang.Object obj)
      Return true if object is assignment compatible with a class or interface that has an @ManagedObject annotation, otherwise false.
      GmbalMBean register​(java.lang.Object parent, java.lang.Object obj)
      Same as register( parent, obj, name ), but here the name is derived from an @NameValue annotation.
      GmbalMBean register​(java.lang.Object parent, java.lang.Object obj, java.lang.String name)
      Construct an Open Mean for obj according to its annotations, and register it with domain getDomain() and the appropriate ObjectName.
      GmbalMBean registerAtRoot​(java.lang.Object obj)
      Same as registerAtRoot( Object, String ), but here the name is derived from an @ObjectKeyName annotation.
      GmbalMBean registerAtRoot​(java.lang.Object obj, java.lang.String name)
      Registers the MBean for obj at the root MBean for the ObjectManager, using the given name.
      void resumeJMXRegistration()
      Decrements the suspend counter, if the counter is greater than 0.
      void setJMXRegistrationDebug​(boolean flag)
      Set debugging for JMX registrations.
      void setMBeanServer​(javax.management.MBeanServer server)
      Set the MBeanServer to which all MBeans using this interface are published.
      void setRegistrationDebug​(ManagedObjectManager.RegistrationDebugLevel level)
      Print debug output to System.out.
      void setResourceBundle​(java.util.ResourceBundle rb)
      Set the ResourceBundle to use for getting localized descriptions.
      void setRuntimeDebug​(boolean flag)
      Enable generation of debug log at INFO level for runtime MBean operations to the org.glassfish.gmbal.impl logger.
      void setTypelibDebug​(int level)
      Enabled generation of debug log for type evaluator debugging.
      void stripPackagePrefix()
      Change the default type name algorithm so that if nothing else applies, the entire package prefix is stripped form the Class name.
      void stripPrefix​(java.lang.String... str)
      Add a type prefix to strip from type names, to shorten the names for a better presentation to the user.
      void suppressDuplicateRootReport​(boolean suppressReport)
      Suppress reporting of a duplicate root name.
      void suspendJMXRegistration()
      If called, no MBeans created after this call will be registered with the JMX MBeanServer until resumeJMXRegistration is called.
      void unregister​(java.lang.Object obj)
      Unregister the Open MBean corresponding to obj from the mbean server.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ManagedObjectManagerNOPImpl

        private ManagedObjectManagerNOPImpl()
    • Method Detail

      • suspendJMXRegistration

        public void suspendJMXRegistration()
        Description copied from interface: ManagedObjectManager
        If called, no MBeans created after this call will be registered with the JMX MBeanServer until resumeJMXRegistration is called. Each call increments a counter, so that nested and overlapping calls from multiple threads work correctly. May be called at any time.
        Specified by:
        suspendJMXRegistration in interface ManagedObjectManager
      • resumeJMXRegistration

        public void resumeJMXRegistration()
        Description copied from interface: ManagedObjectManager
        Decrements the suspend counter, if the counter is greater than 0. When the counter goes to zero, it causes all MBeans created since a previous call to suspendJMXRegistration incremented the counter from 0 to 1 to be registered with the JMX MBeanServer. After this call, all new MBean registration calls to the JMX MBeanServer happen within the register call. May be called at any time.
        Specified by:
        resumeJMXRegistration in interface ManagedObjectManager
      • isManagedObject

        public boolean isManagedObject​(java.lang.Object obj)
        Description copied from interface: ManagedObjectManager
        Return true if object is assignment compatible with a class or interface that has an @ManagedObject annotation, otherwise false. Only such objects may be registered to create MBeans. May be called at any time.
        Specified by:
        isManagedObject in interface ManagedObjectManager
      • createRoot

        public GmbalMBean createRoot()
        Description copied from interface: ManagedObjectManager
        Create a default root MBean. One of the createRoot methods must be called before any of the registration methods may be called. Only one call to a createRoot method is permitted after an ManagedObjectManager is created.
        Specified by:
        createRoot in interface ManagedObjectManager
        Returns:
        A default root MBean which supports only the AMX attributes.
      • createRoot

        public GmbalMBean createRoot​(java.lang.Object root)
        Description copied from interface: ManagedObjectManager
        Create a root MBean from root, which much have a method with the @NameValue annotation. One of the createRoot methods must be called before any of the registration methods may be called. Only one call to createRoot is permitted after an ManagedObjectManager is created.
        Specified by:
        createRoot in interface ManagedObjectManager
        Parameters:
        root - The Java object to be used to construct the root.
        Returns:
        The newly constructed MBean.
      • createRoot

        public GmbalMBean createRoot​(java.lang.Object root,
                                     java.lang.String name)
        Description copied from interface: ManagedObjectManager
        Create a root MBean from root with the given name. One of the createRoot methods must be called before any of the registration methods may be called. Only one call to createRoot is permitted after an ManagedObjectManager is created.
        Specified by:
        createRoot in interface ManagedObjectManager
        Parameters:
        root - The Java object to be used to construct the root.
        name - The ObjectName name field to be used in the ObjectName of the MBean constructed from root.
        Returns:
        The newly constructed MBean.
      • getRoot

        public java.lang.Object getRoot()
        Description copied from interface: ManagedObjectManager
        Return the root of this ManagedObjectManager. May be called at any time.
        Specified by:
        getRoot in interface ManagedObjectManager
        Returns:
        the root constructed in a createRoot operation, or null if called before a createRoot call.
      • register

        public GmbalMBean register​(java.lang.Object parent,
                                   java.lang.Object obj,
                                   java.lang.String name)
        Description copied from interface: ManagedObjectManager
        Construct an Open Mean for obj according to its annotations, and register it with domain getDomain() and the appropriate ObjectName. The MBeanServer from setMBeanServer (or its default) is used. Here parent is considered to contain obj, and this containment is represented by the construction of the ObjectName following the AMX specification for ObjectNames.

        The MBeanInfo for the result is actually ModelMBeanInfo, and may contain extra metadata as defined using annotations defined with the @DescriptorKey and @DescriptorField meta-annotations.

        Must be called after a successful createRoot call.

        This version of register should not be used to register singletons.

        Specified by:
        register in interface ManagedObjectManager
        Parameters:
        parent - The parent object that contains obj.
        obj - The managed object we are registering.
        name - The name to use for registering this object.
        Returns:
        The MBean constructed from obj.
      • register

        public GmbalMBean register​(java.lang.Object parent,
                                   java.lang.Object obj)
        Description copied from interface: ManagedObjectManager
        Same as register( parent, obj, name ), but here the name is derived from an @NameValue annotation.

        This version of register should also be used to register singletons.

        Specified by:
        register in interface ManagedObjectManager
        Parameters:
        parent - The parent object that contains obj.
        obj - The managed object we are registering.
        Returns:
        The MBean constructed from obj.
      • registerAtRoot

        public GmbalMBean registerAtRoot​(java.lang.Object obj,
                                         java.lang.String name)
        Description copied from interface: ManagedObjectManager
        Registers the MBean for obj at the root MBean for the ObjectManager, using the given name. Exactly the same as mom.register( mom.getRoot(), obj, name ).

        Must be called after a successful createRoot call.

        This version of register should not be used to register singletons.

        Specified by:
        registerAtRoot in interface ManagedObjectManager
        Parameters:
        obj - The object for which we construct and register an MBean.
        name - The name of the MBean.
        Returns:
        The MBean constructed from obj.
      • registerAtRoot

        public GmbalMBean registerAtRoot​(java.lang.Object obj)
        Description copied from interface: ManagedObjectManager
        Same as registerAtRoot( Object, String ), but here the name is derived from an @ObjectKeyName annotation. Exactly the same as mom.register( mom.getRoot(), obj ).

        This version of register should also be used to register singletons.

        Specified by:
        registerAtRoot in interface ManagedObjectManager
        Parameters:
        obj - The managed object we are registering.
        Returns:
        The MBean constructed from obj.
      • unregister

        public void unregister​(java.lang.Object obj)
        Description copied from interface: ManagedObjectManager
        Unregister the Open MBean corresponding to obj from the mbean server.

        Must be called after a successful createRoot call.

        Specified by:
        unregister in interface ManagedObjectManager
        Parameters:
        obj - The object originally passed to a register method.
      • getObjectName

        public javax.management.ObjectName getObjectName​(java.lang.Object obj)
        Description copied from interface: ManagedObjectManager
        Get the ObjectName for the given object (which must have been registered via a register call).

        Must be called after a successful createRoot call.

        Specified by:
        getObjectName in interface ManagedObjectManager
        Parameters:
        obj - The object originally passed to a register call.
        Returns:
        The ObjectName used to register the MBean.
      • getObject

        public java.lang.Object getObject​(javax.management.ObjectName oname)
        Description copied from interface: ManagedObjectManager
        Get the Object that was registered with the given ObjectName. Note that getObject and getObjectName are inverse operations.

        Must be called after a successful createRoot call.

        Specified by:
        getObject in interface ManagedObjectManager
        Parameters:
        oname - The ObjectName used to register the object.
        Returns:
        The Object passed to the register call.
      • stripPrefix

        public void stripPrefix​(java.lang.String... str)
        Description copied from interface: ManagedObjectManager
        Add a type prefix to strip from type names, to shorten the names for a better presentation to the user. This may only be called before a createRot method is called.
        Specified by:
        stripPrefix in interface ManagedObjectManager
        Parameters:
        str - Class package name to strip from type name.
      • getDomain

        public java.lang.String getDomain()
        Description copied from interface: ManagedObjectManager
        Return the domain name that was used when this ManagedObjectManager was created. This is the JMX domain that will be used in all ObjectNames created by this ManagedObjectManager.

        May be called at any time.

        Specified by:
        getDomain in interface ManagedObjectManager
        Returns:
        Get the domain name for this ManagedObjectManager.
      • setMBeanServer

        public void setMBeanServer​(javax.management.MBeanServer server)
        Description copied from interface: ManagedObjectManager
        Set the MBeanServer to which all MBeans using this interface are published. The default value is java.lang.management.ManagementFactory.getPlatformMBeanServer().

        Must be called before a successful createRoot call.

        Specified by:
        setMBeanServer in interface ManagedObjectManager
        Parameters:
        server - The MBeanServer to set as the MBeanServer for this ManagedObjectManager.
      • getMBeanServer

        public javax.management.MBeanServer getMBeanServer()
        Description copied from interface: ManagedObjectManager
        Get the current MBeanServer.

        May be called at any time.

        Specified by:
        getMBeanServer in interface ManagedObjectManager
        Returns:
        The current MBeanServer, either the default, or the value passed to setMBeanServer.
      • setResourceBundle

        public void setResourceBundle​(java.util.ResourceBundle rb)
        Description copied from interface: ManagedObjectManager
        Set the ResourceBundle to use for getting localized descriptions. If not set, the description is the value in the annotation.

        Must be called before a successful call to a createRoot method.

        Specified by:
        setResourceBundle in interface ManagedObjectManager
        Parameters:
        rb - The resource bundle to use. May be null.
      • getResourceBundle

        public java.util.ResourceBundle getResourceBundle()
        Description copied from interface: ManagedObjectManager
        Get the resource bundle (if any) set by setResourceBundle.

        May be called at any time.

        Specified by:
        getResourceBundle in interface ManagedObjectManager
        Returns:
        The resource bundle set by setResourceBundle: may be null.
      • addAnnotation

        public void addAnnotation​(java.lang.reflect.AnnotatedElement element,
                                  java.lang.annotation.Annotation annotation)
        Description copied from interface: ManagedObjectManager
        Method to add an annotation to an element that cannot be modified. This is typically needed when dealing with an implementation of an interface that is part of a standardized API, and so the interface cannot be annotated by modifiying the source code. In some cases the implementation of the interface also cannot be inherited, because the implementation is generated by a standardized code generator. Another possibility is that there are several different implementations of the standardized interface, and it is undesirable to annotate each implementation with @InheritedAttributes.
        Specified by:
        addAnnotation in interface ManagedObjectManager
        Parameters:
        element - The annotated element (class or method for our purposes).
        annotation - The annotation we wish to add to the element.
      • setRegistrationDebug

        public void setRegistrationDebug​(ManagedObjectManager.RegistrationDebugLevel level)
        Description copied from interface: ManagedObjectManager
        Print debug output to System.out.

        May be called at any time.

        Specified by:
        setRegistrationDebug in interface ManagedObjectManager
        Parameters:
        level - NONE is no debugging at all, NORMAL traces high-level construction of skeletons and type converters, and dumps results of new skeletons and type converters, FINE traces everything in great detail. The tracing is done with INFO-level logger calls. The logger name is that package name (org.glassfish.gmbal.impl).
      • setRuntimeDebug

        public void setRuntimeDebug​(boolean flag)
        Description copied from interface: ManagedObjectManager
        Enable generation of debug log at INFO level for runtime MBean operations to the org.glassfish.gmbal.impl logger.

        May be called at any time.

        Specified by:
        setRuntimeDebug in interface ManagedObjectManager
        Parameters:
        flag - true to enable runtime debug, false to disable.
      • dumpSkeleton

        public java.lang.String dumpSkeleton​(java.lang.Object obj)
        Description copied from interface: ManagedObjectManager
        Dump the skeleton used in the implementation of the MBean for obj. Obj must be currently registered.

        Must be called after a successful call to a createRoot method.

        Specified by:
        dumpSkeleton in interface ManagedObjectManager
        Parameters:
        obj - The registered object whose skeleton should be displayed.
        Returns:
        The string representation of the skeleton.
      • close

        public void close()
                   throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException
      • setTypelibDebug

        public void setTypelibDebug​(int level)
        Description copied from interface: ManagedObjectManager
        Enabled generation of debug log for type evaluator debugging. This happens as part of the registration process for the first time a particular class is processed.

        May be called at any time.

        Specified by:
        setTypelibDebug in interface ManagedObjectManager
        Parameters:
        level - set to 1 to just see the results of the TypeEvaluator, >1 to see lots of details. WARNING: values >1 will result in a large amount of output.
      • stripPackagePrefix

        public void stripPackagePrefix()
        Description copied from interface: ManagedObjectManager
        Change the default type name algorithm so that if nothing else applies, the entire package prefix is stripped form the Class name. Otherwise, the full Class name is the type.
        Specified by:
        stripPackagePrefix in interface ManagedObjectManager
      • suppressDuplicateRootReport

        public void suppressDuplicateRootReport​(boolean suppressReport)
        Description copied from interface: ManagedObjectManager
        Suppress reporting of a duplicate root name. If this option is enabled, createRoot( Object ) and createRoot( Object, String ) will return null for a duplicate root name, otherwise a Gmbal error will be reported. Note that this applies ONLY to createRoot: the register methods are unaffected. Also note that any other errors that might occur on createRoot will be reported normally.

        Must be called before a successful call to a createRoot method.

        Specified by:
        suppressDuplicateRootReport in interface ManagedObjectManager
      • getAMXClient

        public AMXClient getAMXClient​(java.lang.Object obj)
        Description copied from interface: ManagedObjectManager
        Get an AMXClient instance for the object obj, if obj is registered as an MBean in this mom.

        Must be called after a successful createRoot call.

        Specified by:
        getAMXClient in interface ManagedObjectManager
        Parameters:
        obj - The object corresponding to an MBean.
        Returns:
        An AMXClient that acts as a proxy for this MBean.
      • setJMXRegistrationDebug

        public void setJMXRegistrationDebug​(boolean flag)
        Description copied from interface: ManagedObjectManager
        Set debugging for JMX registrations. If true, all registrations and deregistrations with the MBeanServer are traced.
        Specified by:
        setJMXRegistrationDebug in interface ManagedObjectManager
        Parameters:
        flag - True to enalbed registration tracing.
      • addInheritedAnnotations

        public void addInheritedAnnotations​(java.lang.Class<?> cls)
        Description copied from interface: ManagedObjectManager
        Add all annotations for this class as if they were declared on the inheritance parent(s) of the class (immediate superclass for a class, all immediate superinterfaces for an interface). Also add all method annotations for methods that override an inherited method. This acts as if all annotations on cls were actually applied to the immediate super class or interface.
        Specified by:
        addInheritedAnnotations in interface ManagedObjectManager
        Parameters:
        cls - Class to analyze for inherited annotations.