/*
 * Copyright 2002-2017 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;

import org.springframework.lang.Nullable;

Strategy interface that encapsulates the creation of ObjectName instances.

Used by the MBeanExporter to obtain ObjectNames when registering beans.

Author:Rob Harrop
See Also:
Since:1.2
/** * Strategy interface that encapsulates the creation of {@code ObjectName} instances. * * <p>Used by the {@code MBeanExporter} to obtain {@code ObjectName}s * when registering beans. * * @author Rob Harrop * @since 1.2 * @see org.springframework.jmx.export.MBeanExporter * @see javax.management.ObjectName */
@FunctionalInterface public interface ObjectNamingStrategy {
Obtain an ObjectName for the supplied bean.
Params:
  • 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
Throws:
Returns:the ObjectName instance
/** * Obtain an {@code ObjectName} for the supplied bean. * @param managedBean the bean that will be exposed under the * returned {@code ObjectName} * @param beanKey the key associated with this bean in the beans map * passed to the {@code MBeanExporter} * @return the {@code ObjectName} instance * @throws MalformedObjectNameException if the resulting {@code ObjectName} is invalid */
ObjectName getObjectName(Object managedBean, @Nullable String beanKey) throws MalformedObjectNameException; }