org.ow2.petals.jmx
Class InstallerComponentClient

java.lang.Object
  org.ow2.petals.jmx.AbstractServiceClient
      org.ow2.petals.jmx.InstallerComponentClient

public final class InstallerComponentClient
extends AbstractServiceClient

Client API of a JMX component associated to a JBI component installer.

Author:

cdeneux - Capgemini Sud

Field Summary

protected static java.lang.String	GET_INSTALL_ROOT Action : getInstallRoot
protected static java.lang.String	GET_INSTALLER_CONFIGURATION_MBEAN Action : getInstallerConfigurationMBean
protected static java.lang.String	INIT Action : init
protected static java.lang.String	INSTALL Action : install
protected static java.lang.String	IS_INSTALLED Action : isInstalled
protected static java.lang.String	UNINSTALL Action : uninstall

Fields inherited from class org.ow2.petals.jmx.AbstractServiceClient

JMX_FIELD_NAME, JMX_FIELD_TYPE, JMX_SERVICE_TYPE, mbeanName, mBeanServerConnection, petalsDomain

Constructor Summary

InstallerComponentClient(java.lang.String petalsDomain, javax.management.ObjectName objectName, javax.management.MBeanServerConnection mBeanServerConnection)
Creates a new instance of InstallerComponentClient from its MBean

InstallerComponentClient(java.lang.String petalsDomain, java.lang.String componentName, javax.management.MBeanServerConnection mBeanServerConnection)
Creates a new instance of InstallerComponentClient finding the MBean associated to the component name

Method Summary

ConfigurationInstallerComponentClient	getConfigurationInstallerClient()
java.lang.String	getInstallRoot() Get the root path to the component installation.
javax.management.ObjectName	getMBeanName() Get the MBean name of this installer.
void	install() Install the component.
boolean	isInstalled() Get the current installation state of the JBI component
void	uninstall() Uninstall the component.

Methods inherited from class org.ow2.petals.jmx.AbstractServiceClient

getAttribute, getAttribute, performAction

Methods inherited from class java.lang.Object

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

Field Detail

INIT

protected static final java.lang.String INIT

Action : init

See Also:

Constant Field Values

INSTALL

protected static final java.lang.String INSTALL

Action : install

See Also:

Constant Field Values

UNINSTALL

protected static final java.lang.String UNINSTALL

Action : uninstall

See Also:

Constant Field Values

IS_INSTALLED

protected static final java.lang.String IS_INSTALLED

Action : isInstalled

See Also:

Constant Field Values

GET_INSTALL_ROOT

protected static final java.lang.String GET_INSTALL_ROOT

Action : getInstallRoot

See Also:

Constant Field Values

GET_INSTALLER_CONFIGURATION_MBEAN

protected static final java.lang.String GET_INSTALLER_CONFIGURATION_MBEAN

Action : getInstallerConfigurationMBean

See Also:

Constant Field Values

Constructor Detail

InstallerComponentClient

public InstallerComponentClient(java.lang.String petalsDomain,
                                java.lang.String componentName,
                                javax.management.MBeanServerConnection mBeanServerConnection)
                         throws InstallerComponentDoesNotExistException,
                                ComponentErrorException

Creates a new instance of InstallerComponentClient finding the MBean associated to the component name

Throws:

InstallerComponentDoesNotExistException

ComponentErrorException

InstallerComponentClient

public InstallerComponentClient(java.lang.String petalsDomain,
                                javax.management.ObjectName objectName,
                                javax.management.MBeanServerConnection mBeanServerConnection)

Creates a new instance of InstallerComponentClient from its MBean

Method Detail

install

public void install()
             throws PerformActionErrorException

Install the component.

Throws:

PerformActionErrorException

See Also:

InstallerMBean.install()

uninstall

public void uninstall()
               throws PerformActionErrorException

Uninstall the component.

Throws:

PerformActionErrorException

See Also:

InstallerMBean.uninstall()

isInstalled

public boolean isInstalled()
                    throws PerformActionErrorException

Get the current installation state of the JBI component

Returns:

the current state of the JBI component

Throws:

PerformActionErrorException

See Also:

InstallerMBean.isInstalled()

getInstallRoot

public java.lang.String getInstallRoot()
                                throws PerformActionErrorException

Get the root path to the component installation.

Returns:

the root path

Throws:

PerformActionErrorException

See Also:

InstallerMBean.getInstallRoot()

getMBeanName

public javax.management.ObjectName getMBeanName()

Get the MBean name of this installer.

Returns:

getConfigurationInstallerClient

public ConfigurationInstallerComponentClient getConfigurationInstallerClient()
                                                                      throws PerformActionErrorException

Throws:

PerformActionErrorException