org.wso2.carbon.analytics.common.jmx.agent

Class JmxAgentWebInterface

java.lang.Object

org.wso2.carbon.core.AbstractAdmin

org.wso2.carbon.analytics.common.jmx.agent.JmxAgentWebInterface

public class JmxAgentWebInterface
extends org.wso2.carbon.core.AbstractAdmin

Field Summary

Fields inherited from class org.wso2.carbon.core.AbstractAdmin

axisConfig, configurationContext

Constructor Summary

Constructors

Constructor and Description
JmxAgentWebInterface()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addProfile(Profile profile) Adds a profile to be monitored
boolean	addToolboxProfile() Adds the profile for the toolbox
boolean	deleteProfile(String profileName) Deletes a monitoring profile
Profile[]	getAllProfiles()
String[][]	getMBeanAttributeInfo(String mBean, String url, String userName, String password)
String[][]	getMBeans(String url, String userName, String password)
Profile	getProfile(String profileName)
void	startMonitoringProfile(String profileName) Start to monitor a profile
void	stopMonitoringProfile(String profileName) Stop monitoring of a profile
boolean	testDataPublisherAvailability(String connectionType, String url, int port) Test the availability of the DataPublisher by trying to connect to it (credentials are not checked)
boolean	updateProfile(Profile profile) Updates a monitoring profile

Methods inherited from class org.wso2.carbon.core.AbstractAdmin

getAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUsername, getUserRealm, setConfigurationContext, setPermissionUpdateTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxAgentWebInterface

public JmxAgentWebInterface()

Method Detail

addProfile

public boolean addProfile(Profile profile)
                   throws ProfileAlreadyExistsException,
                          JmxProfileException

Adds a profile to be monitored

Parameters:

profile - The profile to be monitored

Returns:

Whether adding was successful or not

Throws:

ProfileAlreadyExistsException

JmxProfileException

getProfile

public Profile getProfile(String profileName)
                   throws ProfileDoesNotExistException,
                          JmxProfileException

Parameters:

profileName - : The name of the profile that is needed

Returns:

: A profile object

Throws:

ProfileDoesNotExistException

JmxProfileException

updateProfile

public boolean updateProfile(Profile profile)
                      throws ProfileDoesNotExistException,
                             JmxProfileException

Updates a monitoring profile

Parameters:

profile - The profile to be monitored

Returns:

Whether updating was successful or not

Throws:

ProfileDoesNotExistException

JmxProfileException

deleteProfile

public boolean deleteProfile(String profileName)
                      throws ProfileDoesNotExistException,
                             JmxProfileException

Deletes a monitoring profile

Parameters:

profileName - The name of the profile to be deleted

Returns:

Whether delete operation was successful or not

Throws:

ProfileDoesNotExistException

JmxProfileException

startMonitoringProfile

public void startMonitoringProfile(String profileName)
                            throws ProfileDoesNotExistException,
                                   org.apache.axis2.AxisFault

Start to monitor a profile

Parameters:

profileName - Name of the profile to be monitored

Throws:

ProfileDoesNotExistException

org.apache.axis2.AxisFault

stopMonitoringProfile

public void stopMonitoringProfile(String profileName)
                           throws ProfileDoesNotExistException

Stop monitoring of a profile

Parameters:

profileName - Name of the profile that should be withdrawn from being monitored

Throws:

ProfileDoesNotExistException

getAllProfiles

public Profile[] getAllProfiles()
                         throws JmxProfileException

Returns:

: An aaray of all the profiles

Throws:

JmxProfileException

getMBeans

public String[][] getMBeans(String url,
                   String userName,
                   String password)
                     throws IOException

Parameters:

url - : The URL for the JMX server

userName - : The User name for the JMX server

password - : The password for the JMX server

Returns:

: The name array of the MBeans which the JMX server. The format of the array is [Domain name][MBean Canonical name]

Throws:

IOException

getMBeanAttributeInfo

public String[][] getMBeanAttributeInfo(String mBean,
                               String url,
                               String userName,
                               String password)
                                 throws MalformedObjectNameException,
                                        IntrospectionException,
                                        InstanceNotFoundException,
                                        IOException,
                                        ReflectionException

Parameters:

mBean - : The name of the MBean

url - : The URL for the JMX server

userName - : The User name for the JMX server

password - : The password for the JMX server

Returns:

: The set of attributes in a MBean

Throws:

MalformedObjectNameException

IntrospectionException

InstanceNotFoundException

IOException

ReflectionException

testDataPublisherAvailability

public boolean testDataPublisherAvailability(String connectionType,
                                    String url,
                                    int port)

Test the availability of the DataPublisher by trying to connect to it (credentials are not checked)

Returns:

: whether the test was successful or not

addToolboxProfile

public boolean addToolboxProfile()

Adds the profile for the toolbox

Returns:

- Whether the profile was successfully deployed or not