org.openecomp.policy.common.im.jmx

Class ComponentAdmin

java.lang.Object

org.openecomp.policy.common.im.jmx.ComponentAdmin

All Implemented Interfaces:

ComponentAdminMBean

public class ComponentAdmin
extends Object
implements ComponentAdminMBean

Base class for component MBeans.

Constructor Summary

Constructors

Constructor and Description
ComponentAdmin(String name, IntegrityMonitor integrityMonitor, StateManagement stateManager) Constructor.

Method Summary

Modifier and Type	Method and Description
static MBeanServer	createMBeanServer() Creates the MBeanServer (intended for unit testing only).
static MBeanServer	findMBeanServer() Finds the MBeanServer.
static ObjectName	getObjectName(String componentName) Get the MBean object name for the specified feature name.
boolean	isRegistered() Checks if this MBean is registered with the MBeanServer.
void	lock() Administratively lock component.
void	register() Registers with the MBean server.
void	test() Test health of component.
String	toString()
void	unlock() Administratively unlock component.
void	unregister() Unregisters with the MBean server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ComponentAdmin

public ComponentAdmin(String name,
                      IntegrityMonitor integrityMonitor,
                      StateManagement stateManager)
               throws Exception

Constructor.

Parameters:

name - the MBean name

integrityMonitor -

stateManager -

Throws:

Exception

Method Detail

register

public void register()
              throws MalformedObjectNameException,
                     MBeanRegistrationException,
                     InstanceNotFoundException,
                     InstanceAlreadyExistsException,
                     NotCompliantMBeanException

Registers with the MBean server.

Throws:

MalformedObjectNameException - a JMX exception

InstanceNotFoundException - a JMX exception

MBeanRegistrationException - a JMX exception

NotCompliantMBeanException - a JMX exception

InstanceAlreadyExistsException - a JMX exception

isRegistered

public boolean isRegistered()

Checks if this MBean is registered with the MBeanServer.

Returns:

true if this MBean is registered with the MBeanServer.

unregister

public void unregister()
                throws MBeanRegistrationException,
                       InstanceNotFoundException

Unregisters with the MBean server.

Throws:

InstanceNotFoundException - a JMX exception

MBeanRegistrationException - a JMX exception

toString

public String toString()

Overrides:

toString in class Object

findMBeanServer

public static MBeanServer findMBeanServer()

Finds the MBeanServer.

Returns:

the MBeanServer, or null if it is not found

createMBeanServer

public static MBeanServer createMBeanServer()

Creates the MBeanServer (intended for unit testing only).

Returns:

the MBeanServer

getObjectName

public static ObjectName getObjectName(String componentName)
                                throws MalformedObjectNameException

Get the MBean object name for the specified feature name.

Parameters:

componentName - component name

Returns:

the object name

Throws:

MalformedObjectNameException - a JMX exception

test

public void test()
          throws Exception

Description copied from interface: ComponentAdminMBean

Test health of component.

Specified by:

test in interface ComponentAdminMBean

Throws:

Exception - if the component fails the health check

lock

public void lock()
          throws Exception

Description copied from interface: ComponentAdminMBean

Administratively lock component.

Specified by:

lock in interface ComponentAdminMBean

Throws:

Exception - if the component lock fails

unlock

public void unlock()
            throws Exception

Description copied from interface: ComponentAdminMBean

Administratively unlock component.

Specified by:

unlock in interface ComponentAdminMBean

Throws:

Exception - if the component unlock fails