com.sun.esb.management.impl.installation

Class InstallationServiceMBeanImpl

java.lang.Object

com.sun.esb.management.base.services.AbstractServiceMBeansImpl

com.sun.esb.management.impl.installation.InstallationServiceMBeanImpl

All Implemented Interfaces:

InstallationService, Serializable

public class InstallationServiceMBeanImpl
extends AbstractServiceMBeansImpl
implements InstallationService, Serializable

Defines operations for common installation services.

Author:

graj

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sun.esb.management.base.services.AbstractServiceMBeansImpl

COLON, COMMA, COMPONENT_CONFIG_INSTANCE_ERROR_KEY, componentConfigurationHelper, CUSTOM_ADMINISTRATION_NAME_KEY, CUSTOM_CONFIGURATION_NAME_KEY, CUSTOM_LOGGER_NAME_KEY, CUSTOM_MANAGEMENT_ACTIONS_NAME_KEY, CUSTOM_STATISTICS_NAME_KEY, DOMAIN_TARGET_KEY, EBIJMXDOMAIN, environmentContext, EQUAL, IDENTIFICATION_NAME_KEY, JMX_EBI_DOMAIN, PASSWORD_MASK_CHARACTER, RUNNING_STATE, SERVER_TARGET_KEY, SERVICE_TYPE_KEY, STARTED_STATE

Constructor Summary

Constructors

Constructor and Description
InstallationServiceMBeanImpl(EnvironmentContext anEnvContext) Constructor - Constructs a new instance of InstallationServiceMBeanImpl

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureComponentInstaller(ObjectName installerObjectName, Properties paramProps) set the installer configuration parameters
protected String	getComponentNameFromJmxObjectName(ObjectName jmxObjectName) finds the component id property in the object name
String	installComponent(String zipFilePath, Properties paramProps, String targetName) installs component ( service engine, binding component)
Map<String,String>	installComponent(String zipFilePath, Properties paramProps, String[] targetNames) installs component ( service engine, binding component)
String	installComponent(String zipFilePath, String targetName) installs component ( service engine, binding component)
Map<String,String>	installComponent(String zipFilePath, String[] targetNames) installs component ( service engine, binding component)
String	installComponentFromDomain(String componentName, Properties properties, String targetName) installs component ( service engine, binding component)
Map<String,String>	installComponentFromDomain(String componentName, Properties properties, String[] targetNames) installs component from Domain( service engine, binding component)
String	installComponentFromDomain(String componentName, String targetName) installs component ( service engine, binding component)
Map<String,String>	installComponentFromDomain(String componentName, String[] targetNames) installs component from Domain( service engine, binding component)
String	installSharedLibrary(String zipFilePath, String targetName) installs shared library
Map<String,String>	installSharedLibrary(String zipFilePath, String[] targetNames) installs shared library
String	installSharedLibraryFromDomain(String libraryName, String targetName) installs shared library
Map<String,String>	installSharedLibraryFromDomain(String libraryName, String[] targetNames) installs shared library
String	uninstallComponent(String componentName, boolean forceDelete, boolean retainInDomain, String targetName) uninstalls component ( service engine, binding component)
Map<String,String>	uninstallComponent(String componentName, boolean forceDelete, boolean retainInDomain, String[] targetNames) uninstalls component ( service engine, binding component)
String	uninstallComponent(String componentName, boolean forceDelete, String targetName) uninstalls component ( service engine, binding component)
Map<String,String>	uninstallComponent(String componentName, boolean forceDelete, String[] targetNames) uninstalls component ( service engine, binding component)
String	uninstallComponent(String componentName, String targetName) uninstalls component ( service engine, binding component)
Map<String,String>	uninstallComponent(String componentName, String[] targetNames) uninstalls component ( service engine, binding component)
protected String	uninstallComponentInternal(String componentName, boolean force, boolean retainInDomain, String targetName) uninstalls component ( service engine, binding component)
protected String	uninstallComponentInternal(String componentName, boolean force, String targetName) uninstalls component ( service engine, binding component)
String	uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String targetName) uninstalls shared library
Map<String,String>	uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String[] targetNames) uninstalls shared library
String	uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, String targetName) uninstalls shared library
Map<String,String>	uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, String[] targetNames) uninstalls shared library
String	uninstallSharedLibrary(String sharedLibraryName, String targetName) uninstalls shared library
Map<String,String>	uninstallSharedLibrary(String sharedLibraryName, String[] targetNames) uninstalls shared library
protected String	uninstallSharedLibraryInternal(String sharedLibraryName, boolean forceDelete, String targetName) uninstalls shared library
protected boolean	unloadComponentInstaller(ObjectName installerObjectName, boolean isRemoveComponent, boolean isIgnoreExceptions, String targetName) unloads the installer from memory and removes the component optionally
protected boolean	unloadComponentInstaller(String componentName, boolean isRemoveComponent, boolean isIgnoreExceptions, String targetName) Unloads the installer from memory and removes the component optionally
protected boolean	unloadComponentInstallerInternal(String componentName, boolean isRemoveComponent, boolean isIgnoreExceptions, String targetName) Unloads the installer from memory and removes the component optionally
String	upgradeComponent(String componentName, String zipFilePath) updates component ( service engine, binding component)

Methods inherited from class com.sun.esb.management.base.services.AbstractServiceMBeansImpl

checkForValidTarget, checkForValidTarget, checkTargetType, constructMBeanAttributes, constructMBeanAttributes, constructMBeanAttributes, createManagementException, createManagementMessage, domainTargetCheck, findLiveExtensionMBeanObjectNames, getAdminServiceMBeanObjectName, getAdminServiceMBeanObjectName, getAttributeValue, getAttributeValue, getAttributeValue, getAttributeValue, getComponentExtensionMBeanObjectNames, getComponentExtensionMBeanObjectNames, getDeploymentServiceMBeanObjectName, getEbiJmxDomain, getEbiStatusMBeanObjectName, getEnvironmentContext, getExtensionMBeanObjectName, getI18NBundle, getI18NBundle, getInstallationServiceMBeanObjectName, getMBeanAttribute, getMBeanAttributeValues, getMBeanAttributeValuesAsMap, getMBeanServerConnection, getPlatformContext, getPlatformContextAdminServerName, getPlatformContextClusteredServerNames, getPlatformContextClusterNames, getPlatformContextInstallRoot, getPlatformContextInstanceName, getPlatformContextInstanceRoot, getPlatformContextJmxRmiPort, getPlatformContextMBeanServer, getPlatformContextServersInCluster, getPlatformContextStandaloneServerNames, getPlatformContextTargetName, getPlatformContextTargetName, getStackTrace, invokeMBeanOperation, invokeMBeanOperation, invokeMBeanOperation, invokeMBeanOperation, invokeMBeanOperation, isMBeanRegistered, isPlatformContextAdminServer, isPlatformContextCluster, isPlatformContextClusteredServer, isPlatformContextInstanceClustered, isPlatformContextInstanceUp, isPlatformContextStandaloneServer, isPlatformContextValidTarget, isTargetUp, isValidTarget, isValidTarget, listTargetNames, log, logDebug, logDebug, logError, logWarning, platformContextSupportsMultipleServers, setAttributeValue, setAttributeValue, setAttributeValue, setLevel, setMBeanAttribute, setMBeanAttributes, setMBeanAttributes, setMBeanConfigAttributes, setMBeanConfigAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

InstallationServiceMBeanImpl

public InstallationServiceMBeanImpl(EnvironmentContext anEnvContext)

Constructor - Constructs a new instance of InstallationServiceMBeanImpl

Parameters:

anEnvContext -

Method Detail

installComponent

public String installComponent(String zipFilePath,
                      Properties paramProps,
                      String targetName)
                        throws ManagementRemoteException

installs component ( service engine, binding component)

Specified by:

installComponent in interface InstallationService

Parameters:

paramProps - Properties object contains name/value pair.

zipFilePath - archive file in a zip format

targetName -

Returns:

name of the component.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.installComponent(java.lang.String, java.util.Properties, java.lang.String)

installComponent

public String installComponent(String zipFilePath,
                      String targetName)
                        throws ManagementRemoteException

installs component ( service engine, binding component)

Specified by:

installComponent in interface InstallationService

Parameters:

zipFilePath - archive file in a zip format

targetName -

Returns:

name of the component.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.installComponent(java.lang.String, java.lang.String)

installComponentFromDomain

public String installComponentFromDomain(String componentName,
                                Properties properties,
                                String targetName)
                                  throws ManagementRemoteException

installs component ( service engine, binding component)

Specified by:

installComponentFromDomain in interface InstallationService

Parameters:

componentName - name of the component.

component - configuration properties

targetName - name of the target for this operation

Returns:

result.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.installComponentFromDomain(java.lang.String, java.util.Properties, java.lang.String)

installComponentFromDomain

public String installComponentFromDomain(String componentName,
                                String targetName)
                                  throws ManagementRemoteException

installs component ( service engine, binding component)

Specified by:

installComponentFromDomain in interface InstallationService

Parameters:

componentName - name of the component.

targetName - name of the target for this operation

Returns:

result.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.installComponentFromDomain(java.lang.String, java.lang.String)

installSharedLibrary

public String installSharedLibrary(String zipFilePath,
                          String targetName)
                            throws ManagementRemoteException

installs shared library

Specified by:

installSharedLibrary in interface InstallationService

Parameters:

zipFilePath - archive file in a zip format

targetName -

Returns:

shared library name.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.installSharedLibrary(java.lang.String, java.lang.String)

installSharedLibraryFromDomain

public String installSharedLibraryFromDomain(String libraryName,
                                    String targetName)
                                      throws ManagementRemoteException

installs shared library

Specified by:

installSharedLibraryFromDomain in interface InstallationService

Parameters:

libraryName - Shared Library Name

targetName - name of the target for this operation

Returns:

Map of targetName and shared library name strings.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.installSharedLibraryFromDomain(java.lang.String, java.lang.String)

uninstallComponent

public String uninstallComponent(String componentName,
                        boolean forceDelete,
                        boolean retainInDomain,
                        String targetName)
                          throws ManagementRemoteException

uninstalls component ( service engine, binding component)

Specified by:

uninstallComponent in interface InstallationService

Parameters:

componentName - name of the component

forceDelete - true to delete, false to not

retainInDomain - true to not delete it from the domain target, false to also delete it from the domain target.

targetName - name of the target for this operation

Returns:

component name string.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.uninstallComponent(java.lang.String, boolean, boolean, java.lang.String)

uninstallComponent

public String uninstallComponent(String componentName,
                        boolean forceDelete,
                        String targetName)
                          throws ManagementRemoteException

uninstalls component ( service engine, binding component)

Specified by:

uninstallComponent in interface InstallationService

Parameters:

componentName - name of the component

forceDelete - true to delete, false to not

targetName - name of the target for this operation

Returns:

Map of targetName and component name strings.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.uninstallComponent(java.lang.String, boolean, java.lang.String)

uninstallComponent

public String uninstallComponent(String componentName,
                        String targetName)
                          throws ManagementRemoteException

uninstalls component ( service engine, binding component)

Specified by:

uninstallComponent in interface InstallationService

Parameters:

componentName - name of the component

targetName -

Returns:

name of the component.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.uninstallComponent(java.lang.String, java.lang.String)

uninstallSharedLibrary

public String uninstallSharedLibrary(String sharedLibraryName,
                            boolean forceDelete,
                            boolean retainInDomain,
                            String targetName)
                              throws ManagementRemoteException

uninstalls shared library

Specified by:

uninstallSharedLibrary in interface InstallationService

Parameters:

sharedLibraryName - name of the shared library

forceDelete - true to delete, false to not

retainInDomain - true to not delete it from the domain target, false to also delete it from the domain target.

targetName - name of the target for this operation

Returns:

shared library name string.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.uninstallSharedLibrary(java.lang.String, boolean, boolean, java.lang.String)

uninstallSharedLibrary

public String uninstallSharedLibrary(String sharedLibraryName,
                            boolean forceDelete,
                            String targetName)
                              throws ManagementRemoteException

uninstalls shared library

Specified by:

uninstallSharedLibrary in interface InstallationService

Parameters:

sharedLibraryName - name of the shared library

forceDelete - true to delete, false to not

targetName - name of the target for this operation

Returns:

Map of targetName and shared library name strings.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.uninstallSharedLibrary(java.lang.String, boolean, java.lang.String)

uninstallSharedLibrary

public String uninstallSharedLibrary(String sharedLibraryName,
                            String targetName)
                              throws ManagementRemoteException

uninstalls shared library

Specified by:

uninstallSharedLibrary in interface InstallationService

Parameters:

sharedLibraryName - name of the shared library

targetName -

Returns:

shared library name.

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.uninstallSharedLibrary(java.lang.String, java.lang.String)

upgradeComponent

public String upgradeComponent(String componentName,
                      String zipFilePath)
                        throws ManagementRemoteException

updates component ( service engine, binding component)

Specified by:

upgradeComponent in interface InstallationService

Parameters:

componentName - Name of the component to update.

zipFilePath - archive file in a zip format

Returns:

The name of the component if successful

Throws:

ManagementRemoteException - on error

See Also:

InstallationService.upgradeComponent(java.lang.String, java.lang.String)

installComponent

public Map<String,String> installComponent(String zipFilePath,
                                  Properties paramProps,
                                  String[] targetNames)
                                    throws ManagementRemoteException

installs component ( service engine, binding component)

Specified by:

installComponent in interface InstallationService

Parameters:

paramProps - Properties object contains name/value pair.

zipFilePath - archive file in a zip format

targetNames -

Returns:

name of the component as map of [targetName,string].

Throws:

ManagementRemoteException - on error

installComponent

public Map<String,String> installComponent(String zipFilePath,
                                  String[] targetNames)
                                    throws ManagementRemoteException

installs component ( service engine, binding component)

Specified by:

installComponent in interface InstallationService

Parameters:

paramProps - Properties object contains name/value pair.

zipFilePath - archive file in a zip format

targetNames -

Returns:

name of the component as map of [targetName,string].

Throws:

ManagementRemoteException - on error

installSharedLibrary

public Map<String,String> installSharedLibrary(String zipFilePath,
                                      String[] targetNames)
                                        throws ManagementRemoteException

installs shared library

Specified by:

installSharedLibrary in interface InstallationService

Parameters:

zipFilePath - archive file in a zip format

targetNames -

Returns:

shared library name as map of [targetName,string].

Throws:

ManagementRemoteException - on error

uninstallComponent

public Map<String,String> uninstallComponent(String componentName,
                                    String[] targetNames)
                                      throws ManagementRemoteException

uninstalls component ( service engine, binding component)

Specified by:

uninstallComponent in interface InstallationService

Parameters:

componentName - name of the component

targetNames -

Returns:

name of the component as [targetName, String] map.

Throws:

ManagementRemoteException - on error

uninstallSharedLibrary

public Map<String,String> uninstallSharedLibrary(String sharedLibraryName,
                                        String[] targetNames)
                                          throws ManagementRemoteException

uninstalls shared library

Specified by:

uninstallSharedLibrary in interface InstallationService

Parameters:

sharedLibraryName - name of the shared library

targetNames -

Returns:

shared library name as [targetName, string] map.

Throws:

ManagementRemoteException - on error

installComponentFromDomain

public Map<String,String> installComponentFromDomain(String componentName,
                                            String[] targetNames)
                                              throws ManagementRemoteException

installs component from Domain( service engine, binding component)

Specified by:

installComponentFromDomain in interface InstallationService

Parameters:

componentName - name of the component

targetNames - array of targets for this operation

Returns:

Map of targetName and component name strings.

Throws:

ManagementRemoteException - on error

installComponentFromDomain

public Map<String,String> installComponentFromDomain(String componentName,
                                            Properties properties,
                                            String[] targetNames)
                                              throws ManagementRemoteException

installs component from Domain( service engine, binding component)

Specified by:

installComponentFromDomain in interface InstallationService

Parameters:

componentName - name of the component

component - configuration properties

targetNames - array of targets for this operation

Returns:

Map of targetName and component name strings.

Throws:

ManagementRemoteException - on error

uninstallComponent

public Map<String,String> uninstallComponent(String componentName,
                                    boolean forceDelete,
                                    String[] targetNames)
                                      throws ManagementRemoteException

uninstalls component ( service engine, binding component)

Specified by:

uninstallComponent in interface InstallationService

Parameters:

componentName - name of the component

forceDelete - true to delete, false to not

targetName - name of the target for this operation

Returns:

Map of targetName and component name strings.

Throws:

ManagementRemoteException - on error

installSharedLibraryFromDomain

public Map<String,String> installSharedLibraryFromDomain(String libraryName,
                                                String[] targetNames)
                                                  throws ManagementRemoteException

installs shared library

Specified by:

installSharedLibraryFromDomain in interface InstallationService

Parameters:

libraryName - name of the library

targetName - name of the target for this operation

Returns:

Map of targetName and shared library name strings.

Throws:

ManagementRemoteException - on error

uninstallSharedLibrary

public Map<String,String> uninstallSharedLibrary(String sharedLibraryName,
                                        boolean forceDelete,
                                        String[] targetNames)
                                          throws ManagementRemoteException

uninstalls shared library

Specified by:

uninstallSharedLibrary in interface InstallationService

Parameters:

sharedLibraryName - name of the shared library

forceDelete - true to delete, false to not

targetName - name of the target for this operation

Returns:

Map of targetName and shared library name strings.

Throws:

ManagementRemoteException - on error

uninstallComponent

public Map<String,String> uninstallComponent(String componentName,
                                    boolean forceDelete,
                                    boolean retainInDomain,
                                    String[] targetNames)
                                      throws ManagementRemoteException

uninstalls component ( service engine, binding component)

Specified by:

uninstallComponent in interface InstallationService

Parameters:

componentName - name of the component

forceDelete - true to delete, false to not

retainInDomain - true to not delete it from the domain target, false to also delete it from the domain target.

targetNames - array of targets for this operation

Returns:

Map of targetName and component name strings.

Throws:

ManagementRemoteException - on error

uninstallSharedLibrary

public Map<String,String> uninstallSharedLibrary(String sharedLibraryName,
                                        boolean forceDelete,
                                        boolean retainInDomain,
                                        String[] targetNames)
                                          throws ManagementRemoteException

uninstalls shared library

Specified by:

uninstallSharedLibrary in interface InstallationService

Parameters:

sharedLibraryName - name of the shared library

forceDelete - true to delete, false to not

retainInDomain - true to not delete it from the domain target, false to also delete it from the domain target.

targetNames - array of targets for this operation

Returns:

Map of targetName and shared library name strings.

Throws:

ManagementRemoteException - on error

configureComponentInstaller

protected void configureComponentInstaller(ObjectName installerObjectName,
                               Properties paramProps)
                                    throws ManagementRemoteException

set the installer configuration parameters

Parameters:

installerObjectName - objectname

paramProps - name,value pair list

Throws:

ManagementRemoteException - on error.

getComponentNameFromJmxObjectName

protected String getComponentNameFromJmxObjectName(ObjectName jmxObjectName)

finds the component id property in the object name

Parameters:

jmxObjectName - jmx obj name

Returns:

componentId of the component if embbeded in object name else null.

unloadComponentInstaller

protected boolean unloadComponentInstaller(ObjectName installerObjectName,
                               boolean isRemoveComponent,
                               boolean isIgnoreExceptions,
                               String targetName)
                                    throws ManagementRemoteException

unloads the installer from memory and removes the component optionally

Parameters:

installerObjectName - installerObjectName.

isIgnoreExceptions - true or false.

isRemoveComponent - true if this should cleanup disk or false. true is usded in uninstall process

targetName -

Returns:

true or false

Throws:

ManagementRemoteException - on error

unloadComponentInstaller

protected boolean unloadComponentInstaller(String componentName,
                               boolean isRemoveComponent,
                               boolean isIgnoreExceptions,
                               String targetName)
                                    throws ManagementRemoteException

Unloads the installer from memory and removes the component optionally

Parameters:

componentName - componentName.

isIgnoreExceptions - true or false.

isRemoveComponent - true if this should cleanup disk or false. true is

targetName - usded in uninstall process

Returns:

true or false

Throws:

ManagementRemoteException - on error.

unloadComponentInstallerInternal

protected boolean unloadComponentInstallerInternal(String componentName,
                                       boolean isRemoveComponent,
                                       boolean isIgnoreExceptions,
                                       String targetName)
                                            throws ManagementRemoteException

Unloads the installer from memory and removes the component optionally

Parameters:

componentName - componentName.

isRemoveComponent - true if this should cleanup disk or false. true is

retainInDomain - true if this should be kept in domain target, false if not

isIgnoreExceptions - true or false.

targetName - used in uninstall process

Returns:

true or false

Throws:

ManagementRemoteException - on error.

uninstallComponentInternal

protected String uninstallComponentInternal(String componentName,
                                boolean force,
                                String targetName)
                                     throws ManagementRemoteException

uninstalls component ( service engine, binding component)

Parameters:

componentName - name of the component

targetName -

Returns:

name of the component.

Throws:

ManagementRemoteException - on error

uninstallComponentInternal

protected String uninstallComponentInternal(String componentName,
                                boolean force,
                                boolean retainInDomain,
                                String targetName)
                                     throws ManagementRemoteException

uninstalls component ( service engine, binding component)

Parameters:

componentName - name of the component

force -

retainInDomain -

targetName -

Returns:

name of the component.

Throws:

ManagementRemoteException - on error

uninstallSharedLibraryInternal

protected String uninstallSharedLibraryInternal(String sharedLibraryName,
                                    boolean forceDelete,
                                    String targetName)
                                         throws ManagementRemoteException

uninstalls shared library

Parameters:

sharedLibraryName - name of the shared library

forceDelete - true to delete, false to not

targetName - name of the target for this operation

Returns:

Map of targetName and shared library name strings.

Throws:

ManagementRemoteException - on error