org.springframework.jmx.export.naming.ObjectNamingStrategy Maven / Gradle / Ivy
/*
* Copyright 2002-2005 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.jmx.export.naming;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
/**
* Strategy interface that encapsulates the creation of ObjectName instances.
*
* Used by the MBeanExporter to obtain ObjectNames
* when registering beans.
*
* @author Rob Harrop
* @since 1.2
* @see org.springframework.jmx.export.MBeanExporter
* @see javax.management.ObjectName
*/
public interface ObjectNamingStrategy {
/**
* Obtain an ObjectName for the supplied bean.
* @param managedBean the bean that will be exposed under the
* returned ObjectName
* @param beanKey the key associated with this bean in the beans map
* passed to the MBeanExporter
* @return the ObjectName instance
* @throws MalformedObjectNameException if the resulting ObjectName is invalid
*/
ObjectName getObjectName(Object managedBean, String beanKey) throws MalformedObjectNameException;
}