com.sun.jbi.management.facade

Class Installer

java.lang.Object

com.sun.jbi.management.facade.Facade

com.sun.jbi.management.facade.Installer

All Implemented Interfaces:

InstallerMBean

public class Installer
extends Facade
implements InstallerMBean

The InstallerMBean defines standard installation and uninstallation controls for components. InstallerMBeans are created by the InstallationServiceMBean. The InstallerMBean offers controls to allow an administrative tool to:

• Install the component from the installation package.
• Uninstall the component.
• Check the installation status of the component.
• Get the file path to the component's installation root directory.

Author:

Sun Microsystems, Inc.

Field Summary

Fields inherited from class com.sun.jbi.management.facade.Facade

CONFIG_SCHEMA_PATH, DOMAIN, MASKED_FIELD_VALUE, mComponentConfigSchema, mEnvCtx, mLog, mMBeanNames, mMBeanSvr, mMgtCtx, mMsgBuilder, mPlatform, mTarget, mTranslator, PASSWORD, SERVER, sTypeMap, WORKSPACE_ROOT

Constructor Summary

Constructors

Constructor and Description
Installer(EnvironmentContext ctx, String target, String compName)
Installer(EnvironmentContext ctx, String target, String compName, Map instanceInstallers)

Method Summary

Methods

Modifier and Type	Method and Description
ObjectName	getInstallerConfigurationMBean() Get the installer configuration MBean name for this component.
String	getInstallRoot() Get the installation root directory path for this component.
ObjectName	install() Install a component.
boolean	isInstalled() Determine whether or not the component is installed.
void	uninstall() Uninstall the component.
void	uninstall(boolean force) Uninstall the component.

Methods inherited from class com.sun.jbi.management.facade.Facade

archiveEqualityCheck, areAllInstancesUp, componentInstallationCheck, convertToString, fromFileURL, getAllTargets, getComponentConfigurationData, getComponentConfigurationNS, getComponentConfigurationSchema, getComponentLifeCycleMBeanName, getComponentQuery, getComponentQuery, getComponentState, getComponentStateOnInstance, getComponentType, getFacadeInstallerMBeanName, getFacadeInstallerMBeanName, getGenericQuery, getMBeanServerConnection, getRegistry, getRemoteAdminServiceObjectName, getRemoteAttribute, getRemoteAttributes, getServiceAssemblyQuery, getUpdater, handleClusteredInstanceFailures, initPrimitiveTypeMap, instanceRunningCheck, invokeLocalOperation, invokeRemoteOperation, invokeRemoteVoidOperation, isComponentInstalled, isInstanceRunning, isMBeanRegisteredOnInstance, isSharedLibraryInstalled, isTargetUp, mbeanRegistrationCheck, setRemoteAttribute, setRemoteAttributes, sharedLibraryInstallationCheck, throwNotSupportedManagementException, toFileURL, unregisterComponentConfigurationMBean, unregisterComponentConfigurationMBean, unregisterComponentExtensionMBean, unregisterComponentExtensionMBean, unregisterComponentLifeCycleMBean, unregisterComponentLifeCycleMBean, uploadFile, validateArchive

Methods inherited from class java.lang.Object

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

Constructor Detail

Installer

public Installer(EnvironmentContext ctx,
         String target,
         String compName,
         Map instanceInstallers)
          throws ManagementException

Parameters:

instanceInstallers - - a map of instance names and their Installer ObjectNames

Throws:

ManagementException

Installer

public Installer(EnvironmentContext ctx,
         String target,
         String compName)
          throws ManagementException

Throws:

ManagementException

Method Detail

getInstallerConfigurationMBean

public ObjectName getInstallerConfigurationMBean()
                                          throws JBIException

Get the installer configuration MBean name for this component. Initialization of the facade configuration MBean is performed on-demand, so this method is synchronized to prevent against duplicate init in the face of concurrent access.

Specified by:

getInstallerConfigurationMBean in interface InstallerMBean

Returns:

the MBean object name of the Installer Configuration MBean; null if none is provided by this component

Throws:

JBIException - if the component is not in the appropriate state (after install() but before life cycle initialization), or if any error occurs during processing

getInstallRoot

public String getInstallRoot()

Get the installation root directory path for this component.

Specified by:

getInstallRoot in interface InstallerMBean

Returns:

the full installation path of this component; this must be in absolute path name form, in platform-specific format; must be non-null and non-empty

install

public ObjectName install()
                   throws JBIException

Install a component.

Note that the implementation must leave the component in its installed, shutdown state. Automatic starting of components during installation by implementations is not allowed.
For the domain target this will only install the component to the domain, the return value would be null, since there is no LifeCycle MBean for the installed component.

Specified by:

install in interface InstallerMBean

Returns:

JMX ObjectName representing the LifeCycleMBean for the installed component, or null if the installation did not complete

Throws:

JBIException - if the installation fails

isInstalled

public boolean isInstalled()

Determine whether or not the component is installed.

Specified by:

isInstalled in interface InstallerMBean

Returns:

true if this component is currently installed, otherwise false

uninstall

public void uninstall()
               throws JBIException

Uninstall the component. This completely removes the component from the JBI schemaorg_apache_xmlbeans.system.

Specified by:

uninstall in interface InstallerMBean

Throws:

JBIException - if the uninstallation fails

uninstall

public void uninstall(boolean force)
               throws JBIException

Uninstall the component. This completely removes the component from the JBI schemaorg_apache_xmlbeans.system. If the force flag is set to true, the uninstall operation succeeds regardless of any exception thrown by the component itself.

Parameters:

force - set to true to ignore any failures and proceed with the uninstall.

Throws:

JBIException - if some other failure occurs.