org.ow2.petals.jmx
Class JMXClient

java.lang.Object
  org.ow2.petals.jmx.JMXClient

public final class JMXClient
extends java.lang.Object

The Petals JMX Client API

Author:

cdeneux - Capgemini Sud, cgirodengo - Capgemini Sud

Constructor Summary

JMXClient(java.lang.String host, java.lang.Integer jndiPort, java.lang.String username, java.lang.String password)
Creates a new instance of JMXClient

Method Summary

void	disconnect() Release the connection to the JMX server
AdminServiceClient	getAdminServiceClient() Retrieve the Admin service client API
ComponentClient	getComponentClient(javax.management.ObjectName componentMBeanName) Retrieve the component client API associated to a JBI component.
ComponentClient	getComponentClient(java.lang.String componentName) Retrieve the component client API associated to a JBI component.
DeploymentServiceClient	getDeploymentServiceClient() Retrieve the deployment service client API
EndpointRegistryClient	getEndpointRegistryClient() Retrieve the EndpointRegistry client API
InstallationServiceClient	getInstallationServiceClient() Retrieve the installation service client API
InstallerComponentClient	getInstallerComponentClient(java.lang.String componentName) Retrieve the component installer client API associated to a JBI component.
LoggerServiceClient	getLoggerServiceClient() Retrieve the Logger service client API
javax.management.MBeanServerConnection	getMBeanServerConnection() Get the instance to the @ MBeanServerConnection} in use.
PetalsAdminServiceClient	getPetalsAdminServiceClient() Retrieve the Petals Admin service client API
RouterMonitorServiceClient	getRouterMonitoringServiceClient() Retrieve the Router Monitor service client API
RuntimeConfigurationComponentClient	getRuntimeConfigurationClient(java.lang.String dynamicComponentName)
SystemMonitoringServiceClient	getSystemMonitoringServiceClient() Retrieve the system monitoring service client API

Methods inherited from class java.lang.Object

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

Constructor Detail

JMXClient

public JMXClient(java.lang.String host,
                 java.lang.Integer jndiPort,
                 java.lang.String username,
                 java.lang.String password)
          throws ConnectionErrorException

Creates a new instance of JMXClient

Parameters:

host -

jndiPort -

username -

password -

Throws:

ConnectionErrorException

Method Detail

getPetalsAdminServiceClient

public PetalsAdminServiceClient getPetalsAdminServiceClient()
                                                     throws PetalsAdminDoesNotExistException,
                                                            PetalsAdminServiceErrorException,
                                                            ConnectionErrorException

Retrieve the Petals Admin service client API

Returns:

the Petals Admin service client API

Throws:

PetalsAdminDoesNotExistException

PetalsAdminServiceErrorException

ConnectionErrorException

getAdminServiceClient

public AdminServiceClient getAdminServiceClient()
                                         throws AdminDoesNotExistException,
                                                AdminServiceErrorException,
                                                ConnectionErrorException

Retrieve the Admin service client API

Returns:

the Admin service client API

Throws:

AdminDoesNotExistException

AdminServiceErrorException

ConnectionErrorException

getInstallationServiceClient

public InstallationServiceClient getInstallationServiceClient()
                                                       throws InstallationServiceDoesNotExistException,
                                                              InstallationServiceErrorException,
                                                              ConnectionErrorException

Retrieve the installation service client API

Returns:

the installation service client API

Throws:

InstallationServiceDoesNotExistException

InstallationServiceErrorException

ConnectionErrorException

getDeploymentServiceClient

public DeploymentServiceClient getDeploymentServiceClient()
                                                   throws DeploymentServiceDoesNotExistException,
                                                          DeploymentServiceErrorException,
                                                          ConnectionErrorException

Retrieve the deployment service client API

Returns:

the deployment service client API

Throws:

DeploymentServiceDoesNotExistException

DeploymentServiceErrorException

ConnectionErrorException

getComponentClient

public ComponentClient getComponentClient(java.lang.String componentName)
                                   throws ComponentDoesNotExistException,
                                          ComponentErrorException,
                                          ConnectionErrorException

Retrieve the component client API associated to a JBI component.

Parameters:

componentName - Component name

Returns:

the component client API

Throws:

ComponentDoesNotExistException

ComponentErrorException

ConnectionErrorException

getComponentClient

public ComponentClient getComponentClient(javax.management.ObjectName componentMBeanName)
                                   throws ComponentDoesNotExistException,
                                          ComponentErrorException,
                                          ConnectionErrorException

Retrieve the component client API associated to a JBI component.

Parameters:

componentName - Component name

Returns:

the component client API

Throws:

ComponentDoesNotExistException

ComponentErrorException

ConnectionErrorException

getInstallerComponentClient

public InstallerComponentClient getInstallerComponentClient(java.lang.String componentName)
                                                     throws InstallerComponentDoesNotExistException,
                                                            ComponentErrorException,
                                                            ConnectionErrorException

Retrieve the component installer client API associated to a JBI component.

Parameters:

componentName - Component name

Returns:

the installer component client API

Throws:

InstallationServiceDoesNotExistException

InstallationServiceErrorException

ConnectionErrorException

InstallerComponentDoesNotExistException

ComponentErrorException

getEndpointRegistryClient

public EndpointRegistryClient getEndpointRegistryClient()
                                                 throws ConnectionErrorException,
                                                        EndpointRegistryServiceDoesNotExistException,
                                                        EndpointRegistryServiceErrorException

Retrieve the EndpointRegistry client API

Returns:

the EndpointRegistry component client API

Throws:

ConnectionErrorException

EndpointRegistryServiceErrorException

EndpointRegistryServiceDoesNotExistException

getSystemMonitoringServiceClient

public SystemMonitoringServiceClient getSystemMonitoringServiceClient()
                                                               throws ConnectionErrorException,
                                                                      SystemMonitoringDoesNotExistException,
                                                                      SystemMonitoringServiceErrorException

Retrieve the system monitoring service client API

Returns:

the SystemMonitoring component client API

Throws:

ConnectionErrorException

SystemMonitoringServiceErrorException

SystemMonitoringDoesNotExistException

getRuntimeConfigurationClient

public RuntimeConfigurationComponentClient getRuntimeConfigurationClient(java.lang.String dynamicComponentName)
                                                                  throws RuntimeConfigurationDoesNotExistException,
                                                                         RuntimeConfigurationErrorException,
                                                                         ConnectionErrorException

Throws:

RuntimeConfigurationDoesNotExistException

RuntimeConfigurationErrorException

ConnectionErrorException

getRouterMonitoringServiceClient

public RouterMonitorServiceClient getRouterMonitoringServiceClient()
                                                            throws RouterMonitorServiceDoesNotExistException,
                                                                   RouterMonitorServiceErrorException,
                                                                   ConnectionErrorException

Retrieve the Router Monitor service client API

Returns:

The Router Monitor service client API

Throws:

Router - MonitorServiceDoesNotExistException

Router - MonitorServiceErrorException

ConnectionErrorException

RouterMonitorServiceDoesNotExistException

RouterMonitorServiceErrorException

getLoggerServiceClient

public LoggerServiceClient getLoggerServiceClient()
                                           throws LoggerServiceErrorException,
                                                  LoggerDoesNotExistException,
                                                  ConnectionErrorException

Retrieve the Logger service client API

Returns:

The Logger service client API

Throws:

LoggerServiceErrorException

LoggerDoesNotExistException

ConnectionErrorException

disconnect

public void disconnect()
                throws ConnectionErrorException

Release the connection to the JMX server

Throws:

ConnectionErrorException

getMBeanServerConnection

public javax.management.MBeanServerConnection getMBeanServerConnection()
                                                                throws ConnectionErrorException

Get the instance to the @ MBeanServerConnection} in use.

Throws:

ConnectionErrorException