public class

KeyNamingStrategy

extends Object
implements InitializingBean ObjectNamingStrategy
java.lang.Object
   ↳ org.springframework.jmx.export.naming.KeyNamingStrategy

Class Overview

ObjectNamingStrategy implementation that builds ObjectName instances from the key used in the "beans" map passed to MBeanExporter.

Can also check object name mappings, given as Properties or as mappingLocations of properties files. The key used to look up is the key used in MBeanExporter's "beans" map. If no mapping is found for a given key, the key itself is used to build an ObjectName.

Summary

Fields
protected final Log logger Log instance for this class.
Public Constructors
KeyNamingStrategy()
Public Methods
void afterPropertiesSet()
Merges the Properties configured in the mappings and mappingLocations into the final Properties instance used for ObjectName resolution.
ObjectName getObjectName(Object managedBean, String beanKey)
Attempts to retrieve the ObjectName via the given key, trying to find a mapped value in the mappings first.
void setMappingLocation(Resource location)
Set a location of a properties file to be loaded, containing object name mappings.
void setMappingLocations(Resource[] mappingLocations)
Set location of properties files to be loaded, containing object name mappings.
void setMappings(Properties mappings)
Set local properties, containing object name mappings, e.g.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.jmx.export.naming.ObjectNamingStrategy

Fields

protected final Log logger

Log instance for this class.

Public Constructors

public KeyNamingStrategy ()

Public Methods

public void afterPropertiesSet ()

Merges the Properties configured in the mappings and mappingLocations into the final Properties instance used for ObjectName resolution.

Throws
IOException

public ObjectName getObjectName (Object managedBean, String beanKey)

Attempts to retrieve the ObjectName via the given key, trying to find a mapped value in the mappings first.

Parameters
managedBean the bean that will be exposed under the returned ObjectName
beanKey the key associated with this bean in the beans map passed to the MBeanExporter
Returns
  • the ObjectName instance

public void setMappingLocation (Resource location)

Set a location of a properties file to be loaded, containing object name mappings.

public void setMappingLocations (Resource[] mappingLocations)

Set location of properties files to be loaded, containing object name mappings.

public void setMappings (Properties mappings)

Set local properties, containing object name mappings, e.g. via the "props" tag in XML bean definitions. These can be considered defaults, to be overridden by properties loaded from files.