com.sun.jbi.management.facade

Class InstallationService

java.lang.Object

com.sun.jbi.management.facade.Facade

com.sun.jbi.management.facade.InstallationService

All Implemented Interfaces:

InstallationServiceMBean

public class InstallationService
extends Facade
implements InstallationServiceMBean

The installation service MBean allows administrative tools to manage component and shared library installations. The tasks supported are:

• Installing (and uninstalling) a shared library
• Creating (loading) and destroying (unloading) a component installer MBean.
• Finding an existing component installer MBean.

Installing and uninstalling components is accomplished using InstallerMBeans, loaded by this MBean. An individual installer MBean is needed for each component installation / uninstallation. This is to support the more complex installation process that some components require.

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
InstallationService(EnvironmentContext ctx, String target)

Method Summary

Methods

Modifier and Type	Method and Description
String	installSharedLibrary(String slZipURL) Install a shared library installation package.
String	installSharedLibraryFromRepository(String sharedLibraryName) Install a shared library from the Repository.
ObjectName	loadInstaller(String componentName) Load the InstallerMBean for a previously installed component.
ObjectName	loadInstaller(String componentName, boolean force) Load the InstallerMBean for a previously installed component.
ObjectName	loadInstallerFromRepository(String componentName) Load the installer for a component from the Repository.
ObjectName	loadNewInstaller(String installZipURL) Load the installer for a new component for the given component installation package.
boolean	uninstallSharedLibrary(String slName) Uninstall a previously installed shared library.
boolean	uninstallSharedLibrary(String slName, boolean keep) Uninstall a previously installed shared library.
boolean	unloadInstaller(String componentName, boolean isToBeDeleted) Unload an InstallerMBean previously loaded for a component.
String	upgradeComponent(String componentName, String installZipURL) Upgrade a 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

InstallationService

public InstallationService(EnvironmentContext ctx,
                   String target)
                    throws ManagementException

Throws:

ManagementException

Method Detail

loadNewInstaller

public ObjectName loadNewInstaller(String installZipURL)

Load the installer for a new component for the given component installation package.

Specified by:

loadNewInstaller in interface InstallationServiceMBean

Parameters:

installZipURL - URL locating a ZIP file containing the JBI Installation package to be installed; must be non-null, non-empty, and a legal URL

Returns:

the JMX ObjectName of the InstallerMBean loaded from installZipURL; must be non-null

loadInstaller

public ObjectName loadInstaller(String componentName)

Load the InstallerMBean for a previously installed component.

The "component name" refers to the <identification><name> element value from the component's installation package (see loadNewInstaller(String)).

Specified by:

loadInstaller in interface InstallationServiceMBean

Parameters:

componentName - the component name identifying the installer to load; must be non-null and non-empty

Returns:

the JMX ObjectName of the InstallerMBean loaded from an existing installation context; null if the installer MBean doesn't exist

loadInstaller

public ObjectName loadInstaller(String componentName,
                       boolean force)

Load the InstallerMBean for a previously installed component.

The "component name" refers to the <identification><name> element value from the component's installation package (see loadNewInstaller(String)).

Parameters:

componentName - the component name identifying the installer to load; must be non-null and non-empty

force - set to true for a forced uninstall.

Returns:

the JMX ObjectName of the InstallerMBean loaded from an existing installation context; null if the installer MBean doesn't exist

unloadInstaller

public boolean unloadInstaller(String componentName,
                      boolean isToBeDeleted)

Unload an InstallerMBean previously loaded for a component.

Specified by:

unloadInstaller in interface InstallationServiceMBean

Parameters:

componentName - the component name identifying the installer to unload; must be non-null and non-empty

isToBeDeleted - true if the component is to be deleted as well

Returns:

true if the operation was successful, otherwise false

installSharedLibrary

public String installSharedLibrary(String slZipURL)

Install a shared library installation package.

The return value is the unique name for the shared-library, as found in the the value of the installation descriptor's <identification><name> element.

Specified by:

installSharedLibrary in interface InstallationServiceMBean

Parameters:

slZipURL - URL locating a zip file containing a shared library installation package; must be non-null, non-empty, and a legal URL

Returns:

the unique name of the shared library loaded from slZipURL; must be non-null and non-empty

uninstallSharedLibrary

public boolean uninstallSharedLibrary(String slName)

Uninstall a previously installed shared library.

Specified by:

uninstallSharedLibrary in interface InstallationServiceMBean

Parameters:

slName - the name of the shared name space to uninstall; must be non-null and non-empty

Returns:

true if the uninstall was successful

loadInstallerFromRepository

public ObjectName loadInstallerFromRepository(String componentName)
                                       throws JBIException

Load the installer for a component from the Repository. The component archive from the repository is uploaded to the target instance(s), loadNewInstaller() in invoked on the remote instance(s). The object name of the facade Installer MBean is returned.
If the component is not there in the DAS repository a exception will be thrown.

Parameters:

componentName - - name of the registered component.

Returns:

the ObjectName of facade Installer MBean for the registered component

Throws:

JBIException - if the component is not registered.

installSharedLibraryFromRepository

public String installSharedLibraryFromRepository(String sharedLibraryName)
                                          throws JBIException

Install a shared library from the Repository. The library archive from the repository is uploaded to the target instance(s) and installSharedLibrary() is invoked on the remote instance InstallationService with the uploaded file name.
If the shared library is not there in the DAS repository an exception will be thrown.

Parameters:

sharedLibraryName - - name of the registered shared library.

Returns:

the shared library name

Throws:

JBIException - if the shared library is not registered or uninstall fails.

uninstallSharedLibrary

public boolean uninstallSharedLibrary(String slName,
                             boolean keep)

Uninstall a previously installed shared library.

Parameters:

slName - the name of the shared name space to uninstall; must be non-null and non-empty

keep - if true the shared libray is not deleted from the domain. If false, the shared library is deleted from the repository if after this uninstall it is not installed on any targets.

Returns:

true if the uninstall was successful

upgradeComponent

public String upgradeComponent(String componentName,
                      String installZipURL)
                        throws JBIException

Upgrade a component. This is used to perform an upgrade of the runtime files of a component without requiring undeployment of Service Assemblies with Service Units deployed to the component.

Parameters:

componentName - The name of the component.

installZipURL - The URL to the component archive.

Returns:

a status management message that contains component upgrade result

Throws:

JBIException - if there is a problem with the upgrade.