com.sun.esb.management.api.installation

Interface InstallationService

All Known Implementing Classes:

InstallationServiceImpl

public interface InstallationService

Defines operations for common installation services.

Author:

graj

Method Summary

Methods

Modifier and Type	Method and Description
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) from the domain target
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) from the domain target
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 from domain target
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) with option to retain in domain target and option to forcibly remove from specified target
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) with forcibly remove option
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)
String	uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String targetName) uninstalls shared library with option to retain in domain target and option to forcibly remove from specified target
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 with option to forcibly remove
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
String	upgradeComponent(String componentName, String zipFilePath) upgrades component (service engine, binding component) Upgrades a component in a way that actually involves the component.

Method Detail

installComponent

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

installs component (service engine, binding component)

Parameters:

paramProps - Properties object contains name/value pair.

zipFilePath - archive file in a zip format

targetName - name of the target for this operation

Returns:

The name of the component if successful

Throws:

ManagementRemoteException - on error

installComponent

String installComponent(String zipFilePath,
                      String targetName)
                        throws ManagementRemoteException

installs component (service engine, binding component)

Parameters:

zipFilePath - archive file in a zip format

targetName - name of the target for this operation

Returns:

The name of the component if successful

Throws:

ManagementRemoteException - on error

installComponentFromDomain

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

installs component (service engine, binding component) from the domain target

Parameters:

componentName - name of the component.

component - configuration properties

targetName - name of the target for this operation

Returns:

The name of the component if successful

Throws:

ManagementRemoteException - on error

installComponentFromDomain

String installComponentFromDomain(String componentName,
                                String targetName)
                                  throws ManagementRemoteException

installs component (service engine, binding component) from the domain target

Parameters:

componentName - name of the component.

targetName - name of the target for this operation

Returns:

The name of the component if successful

Throws:

ManagementRemoteException - on error

installSharedLibrary

String installSharedLibrary(String zipFilePath,
                          String targetName)
                            throws ManagementRemoteException

installs shared library

Parameters:

zipFilePath - archive file in a zip format

targetName - name of the target for this operation

Returns:

shared library name string.

Throws:

ManagementRemoteException - on error

installSharedLibraryFromDomain

String installSharedLibraryFromDomain(String libraryName,
                                    String targetName)
                                      throws ManagementRemoteException

installs shared library from domain target

Parameters:

libraryName - Shared Library Name

targetName - name of the target for this operation

Returns:

shared library name string.

Throws:

ManagementRemoteException - on error

uninstallComponent

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

uninstalls component (service engine, binding component) with option to retain in domain target and option to forcibly remove from specified target

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:

The name of the component if successful

Throws:

ManagementRemoteException - on error

uninstallComponent

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

uninstalls component (service engine, binding component) with forcibly remove option

Parameters:

componentName - name of the component

forceDelete - true to delete, false to not

targetName - name of the target for this operation

Returns:

The name of the component if successful

Throws:

ManagementRemoteException - on error

uninstallComponent

String uninstallComponent(String componentName,
                        String targetName)
                          throws ManagementRemoteException

uninstalls component (service engine, binding component)

Parameters:

componentName - name of the component

targetName - name of the target for this operation

Returns:

The name of the component if successful

Throws:

ManagementRemoteException - on error

uninstallSharedLibrary

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

uninstalls shared library with option to retain in domain target and option to forcibly remove from specified target

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

uninstallSharedLibrary

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

uninstalls shared library with option to forcibly remove

Parameters:

sharedLibraryName - name of the shared library

forceDelete - true to delete, false to not

targetName - name of the target for this operation

Returns:

shared library name string.

Throws:

ManagementRemoteException - on error

uninstallSharedLibrary

String uninstallSharedLibrary(String sharedLibraryName,
                            String targetName)
                              throws ManagementRemoteException

uninstalls shared library

Parameters:

sharedLibraryName - name of the shared library

targetName - name of the target for this operation

Returns:

shared library name string.

Throws:

ManagementRemoteException - on error

upgradeComponent

String upgradeComponent(String componentName,
                      String zipFilePath)
                        throws ManagementRemoteException

upgrades component (service engine, binding component) Upgrades a component in a way that actually involves the component. During the upgrade processing, the component's implementation of the new upgrade SPI will be invoked to give the component the opportunity to perform any special processing necessary to complete the upgrade. Components which do not provide an implementation of the upgrade SPI can still be updated using the updateComponent API. Also, in the upgrade implementation, changes in the component's installation descriptor will be allowed, with the exception of the component name (for obvious reasons). This allows new shared library dependencies, changes to the class names of the component's SPI implementations, and changes to the component's class loading preferences (class path and class loading order). These changes are allowed regardless of whether or not the component provides an implementation of the new upgrade SPI.

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

installComponent

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

installs component ( service engine, binding component)

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

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

installs component ( service engine, binding component)

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

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

installs shared library

Parameters:

zipFilePath - archive file in a zip format

targetNames -

Returns:

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

Throws:

ManagementRemoteException - on error

uninstallComponent

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

uninstalls component ( service engine, binding component)

Parameters:

componentName - name of the component

targetNames -

Returns:

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

Throws:

ManagementRemoteException - on error

uninstallSharedLibrary

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

uninstalls shared library

Parameters:

sharedLibraryName - name of the shared library

targetNames -

Returns:

shared library name as [targetName, string] map.

Throws:

ManagementRemoteException - on error

installComponentFromDomain

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

installs component from Domain( service engine, binding component)

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

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

installs component from Domain( service engine, binding component)

Parameters:

componentName - name of the component

properties - configuration properties

targetNames - array of targets for this operation

Returns:

Map of targetName and component name strings.

Throws:

ManagementRemoteException - on error

uninstallComponent

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

uninstalls component ( service engine, binding component)

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

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

installs shared library

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

Map<String,String> uninstallSharedLibrary(String sharedLibraryName,
                                        boolean forceDelete,
                                        String[] targetNames)
                                          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

uninstallComponent

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

uninstalls component ( service engine, binding component)

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

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

uninstalls shared library

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