org.glassfish.gmbal.impl
Class ManagedObjectManagerImpl

java.lang.Object
  extended by org.glassfish.gmbal.impl.ManagedObjectManagerImpl
All Implemented Interfaces:
java.io.Closeable, ManagedObjectManagerInternal, ManagedObjectManager


Nested Class Summary
static interface ManagedObjectManagerImpl.DummyAverageRangeStatistic
           
static interface ManagedObjectManagerImpl.DummyBoundaryStatistic
           
static interface ManagedObjectManagerImpl.DummyBoundedRangeStatistic
           
static interface ManagedObjectManagerImpl.DummyCountStatistic
           
static interface ManagedObjectManagerImpl.DummyRangeStatistic
           
static interface ManagedObjectManagerImpl.DummyStatistic
           
static interface ManagedObjectManagerImpl.DummyStringStatistic
           
static interface ManagedObjectManagerImpl.DummyTimeStatistic
           
 
Nested classes/interfaces inherited from interface org.glassfish.gmbal.impl.ManagedObjectManagerInternal
ManagedObjectManagerInternal.AttributeDescriptorType
 
Nested classes/interfaces inherited from interface org.glassfish.gmbal.ManagedObjectManager
ManagedObjectManager.RegistrationDebugLevel
 
Constructor Summary
ManagedObjectManagerImpl(javax.management.ObjectName rootParentName)
           
ManagedObjectManagerImpl(java.lang.String domain)
           
 
Method Summary
 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()
           
 MBeanImpl constructMBean(MBeanImpl parentEntity, java.lang.Object obj, java.lang.String name)
           
 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
 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.
<T extends EvaluatedDeclaration>
forAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.Class<T> cls)
           
 AMXClient getAMXClient(java.lang.Object obj)
          Get an AMXClient instance for the object obj, if obj is registered as an MBean in this mom.
<T extends java.lang.annotation.Annotation>
T
getAnnotation(java.lang.reflect.AnnotatedElement element, java.lang.Class<T> type)
           
 java.util.Collection<java.lang.annotation.Annotation> getAnnotations(java.lang.reflect.AnnotatedElement elem)
           
  getAttributes(EvaluatedClassAnalyzer ca, ManagedObjectManagerInternal.AttributeDescriptorType adt)
           
  getClassAnalyzer(EvaluatedClassDeclaration cls, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)
          Find the superclass or superinterface of cls (which may be cls itself) that has the given annotationClass as an annotation.
 AMXMetadata getDefaultAMXMetadata()
           
 java.lang.String getDescription(EvaluatedDeclaration element)
           
 java.lang.String getDomain()
          Return the domain name that was used when this ManagedObjectManager was created.
 FacetAccessor getFacetAccessor(java.lang.Object obj)
           
<T extends java.lang.annotation.Annotation>
T
getFirstAnnotationOnClass(EvaluatedClassDeclaration element, java.lang.Class<T> type)
           
 java.util.List<InheritedAttribute> getInheritedAttributes(EvaluatedClassAnalyzer ca)
          Get the inherited attributes from the EvaluatedClassAnalyzer.
 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.
 javax.management.ObjectName getRootParentName()
           
 TypeConverter getTypeConverter(EvaluatedType type)
          Construct or lookup the TypeConverter for the given type.
 java.lang.String getTypeName(java.lang.Class<?> cls, java.lang.String fieldName, java.lang.String nameFromAnnotation)
           
 boolean isAMXAttributeName(java.lang.String name)
           
 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.
 boolean jmxRegistrationDebug()
           
<K,V> void
putIfNotPresent(java.util.Map<K,V> map, K key, V value)
           
 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.
 boolean registrationDebug()
           
 boolean registrationFineDebug()
           
 void resumeJMXRegistration()
          Decrements the suspend counter, if the counter is greater than 0.
 boolean runtimeDebug()
           
 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... args)
          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.
 java.lang.String toString()
           
 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, wait, wait, wait
 

Constructor Detail

ManagedObjectManagerImpl

public ManagedObjectManagerImpl(java.lang.String domain)

ManagedObjectManagerImpl

public ManagedObjectManagerImpl(javax.management.ObjectName rootParentName)
Method Detail

close

Specified by:
close in interface java.io.Closeable
Throws:
java.io.IOException

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

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

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getRootParentName

public javax.management.ObjectName getRootParentName()
Specified by:
getRootParentName in interface ManagedObjectManagerInternal

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

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.

getTypeConverter

Description copied from interface: ManagedObjectManagerInternal
Construct or lookup the TypeConverter for the given type.

Specified by:
getTypeConverter in interface ManagedObjectManagerInternal
Parameters:
type - The type for which we need a TypeConverter.
Returns:
The type converter.

getTypeName

public java.lang.String getTypeName(java.lang.Class<?> cls,
                                    java.lang.String fieldName,
                                    java.lang.String nameFromAnnotation)
Specified by:
getTypeName in interface ManagedObjectManagerInternal

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

constructMBean

Specified by:
constructMBean in interface ManagedObjectManagerInternal

register

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

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

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

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.

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.

getObject

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.

getFacetAccessor

public FacetAccessor getFacetAccessor(java.lang.Object obj)
Specified by:
getFacetAccessor in interface ManagedObjectManagerInternal

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.

getDescription

public java.lang.String getDescription(EvaluatedDeclaration element)
Specified by:
getDescription in interface ManagedObjectManagerInternal

addAnnotation

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.

addInheritedAnnotations

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.

getFirstAnnotationOnClass

public <T extends java.lang.annotation.Annotation> T getFirstAnnotationOnClass(EvaluatedClassDeclaration element,
                                                                               java.lang.Class<T> type)
Specified by:
getFirstAnnotationOnClass in interface ManagedObjectManagerInternal

getAnnotation

Specified by:
getAnnotation in interface ManagedObjectManagerInternal

getAnnotations

Specified by:
getAnnotations in interface ManagedObjectManagerInternal

getClassAnalyzer

Description copied from interface: ManagedObjectManagerInternal
Find the superclass or superinterface of cls (which may be cls itself) that has the given annotationClass as an annotation. If the annotated Class has an IncludeSubclass annotation, add those classes into the EvaluatedClassAnalyzer for the annotated class.

Specified by:
getClassAnalyzer in interface ManagedObjectManagerInternal
Parameters:
cls - The class for which we need a EvaluatedClassAnalyzer.
annotationClass - The annotation that must be present on cls or a superclass or superinterface.
Returns:
A Pair of the parent class of cls, and the EvaluatedClassAnalyzer.

getInheritedAttributes

Description copied from interface: ManagedObjectManagerInternal
Get the inherited attributes from the EvaluatedClassAnalyzer.

Specified by:
getInheritedAttributes in interface ManagedObjectManagerInternal
Parameters:
ca - The ClassAnalyzer to check for InheritedAttribute(s).
Returns:
The inherited attributes.

putIfNotPresent

Specified by:
putIfNotPresent in interface ManagedObjectManagerInternal

getAttributes

public  getAttributes(EvaluatedClassAnalyzer ca,
                           ManagedObjectManagerInternal.AttributeDescriptorType adt)
Specified by:
getAttributes in interface ManagedObjectManagerInternal

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).

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.

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.

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.

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.

registrationDebug

public boolean registrationDebug()
Specified by:
registrationDebug in interface ManagedObjectManagerInternal

registrationFineDebug

public boolean registrationFineDebug()
Specified by:
registrationFineDebug in interface ManagedObjectManagerInternal

runtimeDebug

public boolean runtimeDebug()
Specified by:
runtimeDebug in interface ManagedObjectManagerInternal

jmxRegistrationDebug

public boolean jmxRegistrationDebug()
Specified by:
jmxRegistrationDebug in interface ManagedObjectManagerInternal

stripPrefix

public void stripPrefix(java.lang.String... args)
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:
args - Class package name to strip from type name.

forAnnotation

public <T extends EvaluatedDeclaration>  forAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                            java.lang.Class<T> cls)
Specified by:
forAnnotation in interface ManagedObjectManagerInternal

getDefaultAMXMetadata

public AMXMetadata getDefaultAMXMetadata()
Specified by:
getDefaultAMXMetadata in interface ManagedObjectManagerInternal

isAMXAttributeName

public boolean isAMXAttributeName(java.lang.String name)
Specified by:
isAMXAttributeName in interface ManagedObjectManagerInternal

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

getObjectRegistrationManager

public ObjectRegistrationManager getObjectRegistrationManager()
Description copied from interface: ManagedObjectManager
Return an ObjectRegistrationManager as required in the pfl timer services.

Can be called at any time.

Specified by:
getObjectRegistrationManager in interface ManagedObjectManager