Spring Framework 6.1.4 · org.springframework.jmx.export.naming.MetadataNamingStrategy

An implementation of the ObjectNamingStrategy interface that reads the ObjectName from the source-level metadata. Falls back to the bean key (bean name) if no ObjectName can be found in source-level metadata.

Uses the JmxAttributeSource strategy interface, so that metadata can be read using any supported implementation. Out of the box, org.springframework.jmx.export.annotation.AnnotationJmxAttributeSource introspects a well-defined set of annotations that come with Spring.

Field Summary

Modifier and Type	Field and Description
private JmxAttributeSource	attributeSource The `JmxAttributeSource` implementation to use for reading metadata.
private String	defaultDomain
private static final char[]	QUOTABLE_CHARS

Constructor Summary

Access	Constructor and Description
public	MetadataNamingStrategy() Create a new `MetadataNamingStrategy` which needs to be configured through the `setAttributeSource` method.
public	MetadataNamingStrategy(JmxAttributeSource the JmxAttributeSource to use attributeSource) Create a new `MetadataNamingStrategy` for the given `JmxAttributeSource`.

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
public ObjectName	getObjectName(Object the bean that will be exposed under the returned `ObjectName` managedBean, String the key associated with this bean in the beans map passed to the `MBeanExporter` beanKey) Implements org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName. Reads the `ObjectName` from the source-level metadata associated with the managed resource's `Class`.
private static String	quoteIfNecessary(String value)
public void	setAttributeSource(JmxAttributeSource attributeSource) Set the implementation of the `JmxAttributeSource` interface to use when reading the source-level metadata.
public void	setDefaultDomain(String defaultDomain) Specify the default domain to be used for generating ObjectNames when no source-level metadata has been specified.
private static boolean	shouldQuote(String value)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attributeSource	back to summary
private JmxAttributeSource attributeSource The `JmxAttributeSource` implementation to use for reading metadata. Annotations @Nullable

defaultDomain	back to summary
private String defaultDomain Annotations @Nullable

QUOTABLE_CHARS	back to summary
private static final char[] QUOTABLE_CHARS

Constructor Detail

MetadataNamingStrategy	back to summary
public MetadataNamingStrategy() Create a new `MetadataNamingStrategy` which needs to be configured through the `setAttributeSource` method.

MetadataNamingStrategy back to summary

public MetadataNamingStrategy(JmxAttributeSource attributeSource)

Create a new MetadataNamingStrategy for the given JmxAttributeSource.

Parameters

attributeSource:JmxAttributeSource: the JmxAttributeSource to use

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. Annotations @Override

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

getObjectName back to summary

getObjectName	back to summary
public ObjectName getObjectName(Object managedBean, String beanKey) throws MalformedObjectNameException Implements org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName. Reads the `ObjectName` from the source-level metadata associated with the managed resource's `Class`. Parameters managedBean:Object Doc from org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName. the bean that will be exposed under the returned `ObjectName` beanKey:String Doc from org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName. the key associated with this bean in the beans map passed to the `MBeanExporter` Returns:ObjectName Doc from org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName. the `ObjectName` instance Annotations @Override Exceptions MalformedObjectNameException: Doc from org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName. if the resulting `ObjectName` is invalid

public ObjectName getObjectName(Object managedBean, String beanKey) throws MalformedObjectNameException

Implements org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName.

Reads the ObjectName from the source-level metadata associated with the managed resource's Class.

Parameters

managedBean:Object

Doc from org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName.

the bean that will be exposed under the returned ObjectName

beanKey:String

Doc from org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName.

the key associated with this bean in the beans map passed to the MBeanExporter

Returns:ObjectName

Doc from org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName.

the ObjectName instance

Annotations

@Override

Exceptions

MalformedObjectNameException:

Doc from org.springframework.jmx.export.naming.ObjectNamingStrategy.getObjectName.

if the resulting ObjectName is invalid

quoteIfNecessary	back to summary
private static String quoteIfNecessary(String value)

setAttributeSource	back to summary
public void setAttributeSource(JmxAttributeSource attributeSource) Set the implementation of the `JmxAttributeSource` interface to use when reading the source-level metadata.

setDefaultDomain	back to summary
public void setDefaultDomain(String defaultDomain) Specify the default domain to be used for generating ObjectNames when no source-level metadata has been specified. The default is to use the domain specified in the bean name (if the bean name follows the JMX ObjectName syntax); else, the package name of the managed bean class.

setDefaultDomain

back to summary

public void setDefaultDomain(String defaultDomain)

Specify the default domain to be used for generating ObjectNames when no source-level metadata has been specified.

The default is to use the domain specified in the bean name (if the bean name follows the JMX ObjectName syntax); else, the package name of the managed bean class.

shouldQuote	back to summary
private static boolean shouldQuote(String value)

public Class MetadataNamingStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail