javax.management.modelmbean.ModelMBean Java Examples

@Override
public void registerManagedResource(Object managedResource, ObjectName objectName) throws MBeanExportException {
	Assert.notNull(managedResource, "Managed resource must not be null");
	Assert.notNull(objectName, "ObjectName must not be null");
	try {
		if (isMBean(managedResource.getClass())) {
			doRegister(managedResource, objectName);
		}
		else {
			ModelMBean mbean = createAndConfigureMBean(managedResource, managedResource.getClass().getName());
			doRegister(mbean, objectName);
			injectNotificationPublisherIfNecessary(managedResource, mbean, objectName);
		}
	}
	catch (JMException ex) {
		throw new UnableToRegisterMBeanException(
				"Unable to register MBean [" + managedResource + "] with object name [" + objectName + "]", ex);
	}
}
 

@Test
public void testHappyPath() throws MalformedObjectNameException, JMException {
  TestMbean testMbean = new TestMbean();
  ModelMBean mbean = defaultManagementMBeanAssembler.assemble(testMbean, new ObjectName("org.activiti.jmx.Mbeans:type=something"));
  assertNotNull(mbean);
  assertNotNull(mbean.getMBeanInfo());
  assertNotNull(mbean.getMBeanInfo().getAttributes());
  MBeanAttributeInfo[] attributes = mbean.getMBeanInfo().getAttributes();
  assertEquals(2, attributes.length);
  assertTrue((attributes[0].getName().equals("TestAttributeString") && attributes[1].getName().equals("TestAttributeBoolean") || (attributes[1].getName().equals("TestAttributeString") && attributes[0]
      .getName().equals("TestAttributeBoolean"))));
  assertNotNull(mbean.getMBeanInfo().getOperations());
  MBeanOperationInfo[] operations = mbean.getMBeanInfo().getOperations();
  assertNotNull(operations);
  assertEquals(3, operations.length);

}
 

@Override
public void registerManagedResource(Object managedResource, ObjectName objectName) throws MBeanExportException {
	Assert.notNull(managedResource, "Managed resource must not be null");
	Assert.notNull(objectName, "ObjectName must not be null");
	try {
		if (isMBean(managedResource.getClass())) {
			doRegister(managedResource, objectName);
		}
		else {
			ModelMBean mbean = createAndConfigureMBean(managedResource, managedResource.getClass().getName());
			doRegister(mbean, objectName);
			injectNotificationPublisherIfNecessary(managedResource, mbean, objectName);
		}
	}
	catch (JMException ex) {
		throw new UnableToRegisterMBeanException(
				"Unable to register MBean [" + managedResource + "] with object name [" + objectName + "]", ex);
	}
}
 

@Override
public void registerManagedResource(Object managedResource, ObjectName objectName) throws MBeanExportException {
	Assert.notNull(managedResource, "Managed resource must not be null");
	Assert.notNull(objectName, "ObjectName must not be null");
	try {
		if (isMBean(managedResource.getClass())) {
			doRegister(managedResource, objectName);
		}
		else {
			ModelMBean mbean = createAndConfigureMBean(managedResource, managedResource.getClass().getName());
			doRegister(mbean, objectName);
			injectNotificationPublisherIfNecessary(managedResource, mbean, objectName);
		}
	}
	catch (JMException ex) {
		throw new UnableToRegisterMBeanException(
				"Unable to register MBean [" + managedResource + "] with object name [" + objectName + "]", ex);
	}
}
 

@Override
public void registerManagedResource(Object managedResource, ObjectName objectName) throws MBeanExportException {
	Assert.notNull(managedResource, "Managed resource must not be null");
	Assert.notNull(objectName, "ObjectName must not be null");
	try {
		if (isMBean(managedResource.getClass())) {
			doRegister(managedResource, objectName);
		}
		else {
			ModelMBean mbean = createAndConfigureMBean(managedResource, managedResource.getClass().getName());
			doRegister(mbean, objectName);
			injectNotificationPublisherIfNecessary(managedResource, mbean, objectName);
		}
	}
	catch (JMException ex) {
		throw new UnableToRegisterMBeanException(
				"Unable to register MBean [" + managedResource + "] with object name [" + objectName + "]", ex);
	}
}
 

@Test
public void testNotificationAware() throws MalformedObjectNameException, JMException {
    NotificationSenderAware mockedNotificationAwareMbean = mock(NotificationSenderAware.class);
    ModelMBean modelBean = defaultManagementMBeanAssembler.assemble(mockedNotificationAwareMbean, new ObjectName("org.flowable.jmx.Mbeans:type=something"));
    assertNotNull(modelBean);
    ArgumentCaptor<NotificationSender> argument = ArgumentCaptor.forClass(NotificationSender.class);
    verify(mockedNotificationAwareMbean).setNotificationSender(argument.capture());
    assertNotNull(argument);
    assertNotNull(argument.getValue());

}
 

/**
 * If the supplied managed resource implements the {@link NotificationPublisherAware} an instance of
 * {@link org.springframework.jmx.export.notification.NotificationPublisher} is injected.
 */
private void injectNotificationPublisherIfNecessary(
		Object managedResource, @Nullable ModelMBean modelMBean, @Nullable ObjectName objectName) {

	if (managedResource instanceof NotificationPublisherAware && modelMBean != null && objectName != null) {
		((NotificationPublisherAware) managedResource).setNotificationPublisher(
				new ModelMBeanNotificationPublisher(modelMBean, objectName, managedResource));
	}
}
 

/**
 * Registers an existing MBean or an MBean adapter for a plain bean
 * with the {@code MBeanServer}.
 * @param bean the bean to register, either an MBean or a plain bean
 * @param beanKey the key associated with this bean in the beans map
 * @return the {@code ObjectName} under which the bean was registered
 * with the {@code MBeanServer}
 */
private ObjectName registerBeanInstance(Object bean, String beanKey) throws JMException {
	ObjectName objectName = getObjectName(bean, beanKey);
	Object mbeanToExpose = null;
	if (isMBean(bean.getClass())) {
		mbeanToExpose = bean;
	}
	else {
		DynamicMBean adaptedBean = adaptMBeanIfPossible(bean);
		if (adaptedBean != null) {
			mbeanToExpose = adaptedBean;
		}
	}

	if (mbeanToExpose != null) {
		if (logger.isDebugEnabled()) {
			logger.debug("Located MBean '" + beanKey + "': registering with JMX server as MBean [" +
					objectName + "]");
		}
		doRegister(mbeanToExpose, objectName);
	}
	else {
		if (logger.isDebugEnabled()) {
			logger.debug("Located managed bean '" + beanKey + "': registering with JMX server as MBean [" +
					objectName + "]");
		}
		ModelMBean mbean = createAndConfigureMBean(bean, beanKey);
		doRegister(mbean, objectName);
		injectNotificationPublisherIfNecessary(bean, mbean, objectName);
	}

	return objectName;
}
 

/**
 * If the supplied managed resource implements the {@link NotificationPublisherAware} an instance of
 * {@link org.springframework.jmx.export.notification.NotificationPublisher} is injected.
 */
private void injectNotificationPublisherIfNecessary(
		Object managedResource, @Nullable ModelMBean modelMBean, @Nullable ObjectName objectName) {

	if (managedResource instanceof NotificationPublisherAware && modelMBean != null && objectName != null) {
		((NotificationPublisherAware) managedResource).setNotificationPublisher(
				new ModelMBeanNotificationPublisher(modelMBean, objectName, managedResource));
	}
}
 

/**
 * Registers an existing MBean or an MBean adapter for a plain bean
 * with the {@code MBeanServer}.
 * @param bean the bean to register, either an MBean or a plain bean
 * @param beanKey the key associated with this bean in the beans map
 * @return the {@code ObjectName} under which the bean was registered
 * with the {@code MBeanServer}
 */
private ObjectName registerBeanInstance(Object bean, String beanKey) throws JMException {
	ObjectName objectName = getObjectName(bean, beanKey);
	Object mbeanToExpose = null;
	if (isMBean(bean.getClass())) {
		mbeanToExpose = bean;
	}
	else {
		DynamicMBean adaptedBean = adaptMBeanIfPossible(bean);
		if (adaptedBean != null) {
			mbeanToExpose = adaptedBean;
		}
	}

	if (mbeanToExpose != null) {
		if (logger.isDebugEnabled()) {
			logger.debug("Located MBean '" + beanKey + "': registering with JMX server as MBean [" +
					objectName + "]");
		}
		doRegister(mbeanToExpose, objectName);
	}
	else {
		if (logger.isDebugEnabled()) {
			logger.debug("Located managed bean '" + beanKey + "': registering with JMX server as MBean [" +
					objectName + "]");
		}
		ModelMBean mbean = createAndConfigureMBean(bean, beanKey);
		doRegister(mbean, objectName);
		injectNotificationPublisherIfNecessary(bean, mbean, objectName);
	}

	return objectName;
}
 

/**
 * Creates an MBean that is configured with the appropriate management
 * interface for the supplied managed resource.
 * @param managedResource the resource that is to be exported as an MBean
 * @param beanKey the key associated with the managed bean
 * @see #createModelMBean()
 * @see #getMBeanInfo(Object, String)
 */
protected ModelMBean createAndConfigureMBean(Object managedResource, String beanKey)
		throws MBeanExportException {
	try {
		ModelMBean mbean = createModelMBean();
		mbean.setModelMBeanInfo(getMBeanInfo(managedResource, beanKey));
		mbean.setManagedResource(managedResource, MR_TYPE_OBJECT_REFERENCE);
		return mbean;
	}
	catch (Throwable ex) {
		throw new MBeanExportException("Could not create ModelMBean for managed resource [" +
				managedResource + "] with key '" + beanKey + "'", ex);
	}
}
 

public ModelMBean assemble(Object obj, ObjectName name) throws JMException {
  ModelMBeanInfo mbi = null;

  // use the default provided mbean which has been annotated with JMX
  // annotations
  LOG.trace("Assembling MBeanInfo for: {} from @ManagedResource object: {}", name, obj);
  mbi = assembler.getMBeanInfo(obj, null, name.toString());

  if (mbi == null) {
    return null;
  }

  RequiredModelMBean mbean = new RequiredModelMBean(mbi);

  try {
    mbean.setManagedResource(obj, "ObjectReference");
  } catch (InvalidTargetObjectTypeException e) {
    throw new JMException(e.getMessage());
  }

  // Allows the managed object to send notifications
  if (obj instanceof NotificationSenderAware) {
    ((NotificationSenderAware) obj).setNotificationSender(new NotificationSenderAdapter(mbean));
  }

  return mbean;
}
 

@Test
public void testNotificationAware() throws MalformedObjectNameException, JMException {
  NotificationSenderAware mockedNotificationAwareMbean = mock(NotificationSenderAware.class);
  ModelMBean modelBean = defaultManagementMBeanAssembler.assemble(mockedNotificationAwareMbean, new ObjectName("org.activiti.jmx.Mbeans:type=something"));
  assertNotNull(modelBean);
  ArgumentCaptor<NotificationSender> argument = ArgumentCaptor.forClass(NotificationSender.class);
  verify(mockedNotificationAwareMbean).setNotificationSender(argument.capture());
  assertNotNull(argument);
  assertNotNull(argument.getValue());

}
 

/**
 * Registers an existing MBean or an MBean adapter for a plain bean
 * with the {@code MBeanServer}.
 * @param bean the bean to register, either an MBean or a plain bean
 * @param beanKey the key associated with this bean in the beans map
 * @return the {@code ObjectName} under which the bean was registered
 * with the {@code MBeanServer}
 */
private ObjectName registerBeanInstance(Object bean, String beanKey) throws JMException {
	ObjectName objectName = getObjectName(bean, beanKey);
	Object mbeanToExpose = null;
	if (isMBean(bean.getClass())) {
		mbeanToExpose = bean;
	}
	else {
		DynamicMBean adaptedBean = adaptMBeanIfPossible(bean);
		if (adaptedBean != null) {
			mbeanToExpose = adaptedBean;
		}
	}
	if (mbeanToExpose != null) {
		if (logger.isInfoEnabled()) {
			logger.info("Located MBean '" + beanKey + "': registering with JMX server as MBean [" +
					objectName + "]");
		}
		doRegister(mbeanToExpose, objectName);
	}
	else {
		if (logger.isInfoEnabled()) {
			logger.info("Located managed bean '" + beanKey + "': registering with JMX server as MBean [" +
					objectName + "]");
		}
		ModelMBean mbean = createAndConfigureMBean(bean, beanKey);
		doRegister(mbean, objectName);
		injectNotificationPublisherIfNecessary(bean, mbean, objectName);
	}
	return objectName;
}
 

/**
 * If the supplied managed resource implements the {@link NotificationPublisherAware} an instance of
 * {@link org.springframework.jmx.export.notification.NotificationPublisher} is injected.
 */
private void injectNotificationPublisherIfNecessary(
		Object managedResource, ModelMBean modelMBean, ObjectName objectName) {

	if (managedResource instanceof NotificationPublisherAware) {
		((NotificationPublisherAware) managedResource).setNotificationPublisher(
				new ModelMBeanNotificationPublisher(modelMBean, objectName, managedResource));
	}
}
 

/**
 * If the supplied managed resource implements the {@link NotificationPublisherAware} an instance of
 * {@link org.springframework.jmx.export.notification.NotificationPublisher} is injected.
 */
private void injectNotificationPublisherIfNecessary(
		Object managedResource, ModelMBean modelMBean, ObjectName objectName) {

	if (managedResource instanceof NotificationPublisherAware) {
		((NotificationPublisherAware) managedResource).setNotificationPublisher(
				new ModelMBeanNotificationPublisher(modelMBean, objectName, managedResource));
	}
}
 

@Override
public ModelMBean assemble(Object obj, ObjectName name) throws JMException {
    ModelMBeanInfo mbi = null;

    // use the default provided mbean which has been annotated with JMX annotations
    LOGGER.trace("Assembling MBeanInfo for: {} from @ManagedResource object: {}", name, obj);
    mbi = assembler.getMBeanInfo(obj, null, name.toString());

    if (mbi == null) {
        return null;
    }

    RequiredModelMBean mbean = new RequiredModelMBean(mbi);

    try {
        mbean.setManagedResource(obj, "ObjectReference");
    } catch (InvalidTargetObjectTypeException e) {
        throw new JMException(e.getMessage());
    }

    // Allows the managed object to send notifications
    if (obj instanceof NotificationSenderAware) {
        ((NotificationSenderAware) obj).setNotificationSender(new NotificationSenderAdapter(mbean));
    }

    return mbean;
}
 

/**
 * Creates an MBean that is configured with the appropriate management
 * interface for the supplied managed resource.
 * @param managedResource the resource that is to be exported as an MBean
 * @param beanKey the key associated with the managed bean
 * @see #createModelMBean()
 * @see #getMBeanInfo(Object, String)
 */
protected ModelMBean createAndConfigureMBean(Object managedResource, String beanKey)
		throws MBeanExportException {
	try {
		ModelMBean mbean = createModelMBean();
		mbean.setModelMBeanInfo(getMBeanInfo(managedResource, beanKey));
		mbean.setManagedResource(managedResource, MR_TYPE_OBJECT_REFERENCE);
		return mbean;
	}
	catch (Exception ex) {
		throw new MBeanExportException("Could not create ModelMBean for managed resource [" +
				managedResource + "] with key '" + beanKey + "'", ex);
	}
}
 

@Test
public void testAnnotations() throws MalformedObjectNameException, JMException {

    ModelMBean modelBean = assembler.assemble(jobExecutorMbean, new ObjectName("domain", "key", "value"));
    assertNotNull(modelBean);
    MBeanInfo beanInfo = modelBean.getMBeanInfo();
    assertNotNull(beanInfo);
    assertNotNull(beanInfo.getOperations());
    assertEquals(2, beanInfo.getOperations().length);
    int counter = 0;

    for (MBeanOperationInfo op : beanInfo.getOperations()) {
        if (op.getName().equals("setJobExecutorActivate")) {
            counter++;
            assertEquals("set job executor activate", op.getDescription());
            assertEquals("void", op.getReturnType());
            assertEquals(1, op.getSignature().length);
            assertEquals("java.lang.Boolean", op.getSignature()[0].getType());
        }
    }
    assertEquals(1, counter);

    // check attributes
    assertNotNull(beanInfo.getAttributes());
    assertEquals(1, beanInfo.getAttributes().length);

    counter = 0;

    for (MBeanAttributeInfo attr : beanInfo.getAttributes()) {
        if (attr.getName().equals("JobExecutorActivated")) {
            counter++;
            assertEquals("check if the job executor is activated", attr.getDescription());
            assertEquals("boolean", attr.getType());
        }
    }
    assertEquals(1, counter);

}
 

/**
 * Registers an existing MBean or an MBean adapter for a plain bean
 * with the {@code MBeanServer}.
 * @param bean the bean to register, either an MBean or a plain bean
 * @param beanKey the key associated with this bean in the beans map
 * @return the {@code ObjectName} under which the bean was registered
 * with the {@code MBeanServer}
 */
private ObjectName registerBeanInstance(Object bean, String beanKey) throws JMException {
	ObjectName objectName = getObjectName(bean, beanKey);
	Object mbeanToExpose = null;
	if (isMBean(bean.getClass())) {
		mbeanToExpose = bean;
	}
	else {
		DynamicMBean adaptedBean = adaptMBeanIfPossible(bean);
		if (adaptedBean != null) {
			mbeanToExpose = adaptedBean;
		}
	}
	if (mbeanToExpose != null) {
		if (logger.isInfoEnabled()) {
			logger.info("Located MBean '" + beanKey + "': registering with JMX server as MBean [" +
					objectName + "]");
		}
		doRegister(mbeanToExpose, objectName);
	}
	else {
		if (logger.isInfoEnabled()) {
			logger.info("Located managed bean '" + beanKey + "': registering with JMX server as MBean [" +
					objectName + "]");
		}
		ModelMBean mbean = createAndConfigureMBean(bean, beanKey);
		doRegister(mbean, objectName);
		injectNotificationPublisherIfNecessary(bean, mbean, objectName);
	}
	return objectName;
}
 

@Test
public void testAnnotations() throws MalformedObjectNameException, JMException {

  ModelMBean modelBean = assembler.assemble(jobExecutorMbean, new ObjectName("domain", "key", "value"));
  assertNotNull(modelBean);
  MBeanInfo beanInfo = modelBean.getMBeanInfo();
  assertNotNull(beanInfo);
  assertNotNull(beanInfo.getOperations());
  assertEquals(2, beanInfo.getOperations().length);
  int counter = 0;

  for (MBeanOperationInfo op : beanInfo.getOperations()) {
    if (op.getName().equals("setJobExecutorActivate")) {
      counter++;
      assertEquals("set job executor activate", op.getDescription());
      assertEquals("void", op.getReturnType());
      assertEquals(1, op.getSignature().length);
      assertEquals("java.lang.Boolean", op.getSignature()[0].getType());
    }
  }
  assertEquals(1, counter);

  // check attributes
  assertNotNull(beanInfo.getAttributes());
  assertEquals(1, beanInfo.getAttributes().length);

  counter = 0;

  for (MBeanAttributeInfo attr : beanInfo.getAttributes()) {
    if (attr.getName().equals("JobExecutorActivated")) {
      counter++;
      assertEquals("check if the job executor is activated", attr.getDescription());
      assertEquals("boolean", attr.getType());
    }
  }
  assertEquals(1, counter);

}
 

public ModelMBean getModelMBean() {
  return this.modelMBean;
}
 

public ModelMBean getModelMBean() {
	return this.modelMBean;
}
 

public ModelMBean getModelMBean() {
	return this.modelMBean;
}
 

public ModelMBean getModelMBean() {
	return this.modelMBean;
}
 

public void setModelMBean(ModelMBean modelMBean) {
	this.modelMBean = modelMBean;
}
 

public ModelMBean getModelMBean() {
	return this.modelMBean;
}
 

public ModelMBean getModelMBean() {
	return this.modelMBean;
}
 

public void setModelMBean(ModelMBean modelMBean) {
	this.modelMBean = modelMBean;
}
 

public void setModelMBean(ModelMBean modelMBean) {
	this.modelMBean = modelMBean;
}