public interface ComponentManager
| Modifier and Type | Method and Description |
|---|---|
void |
cancelComponentUpgrade(String componentName)
Cancel a pending component upgrade.
|
Component |
getComponentInstance(String componentName)
Get the javax.jbi.component.Component instance for the component with
the specified name.
|
DeployerMBean |
getDeployerInstance(String componentName)
Get the com.sun.jbi.framework.DeployerMBean instance for the component
with the specified name.
|
void |
installSharedLibrary(String name,
String description,
String componentRoot,
boolean isSelfFirst,
List elements)
Install a Shared Library into the JBI framework.
|
ObjectName |
loadBootstrap(InstallationContext installContext,
String bootClassName,
List bootClassPathElements,
List sharedLibraryList,
boolean force)
Load a component's bootstrap into the JBI framework.
|
void |
uninstallSharedLibrary(String id)
Uninstall a Shared Library from the JBI framework.
|
void |
unloadBootstrap(String componentName)
Unload a component's bootstrap from the JBI framework.
|
void |
upgradeComponent(InstallationContext installContext,
String bootClassName,
List<String> bootClassPathElements,
List<String> sharedLibraryList)
Upgrade an installed component.
|
boolean |
validateComponentForUpgrade(InstallationContext installContext,
String bootClassName,
List<String> bootClassPathElements,
List<String> sharedLibraryList)
Validate a component for upgrade.
|
Component getComponentInstance(String componentName)
componentName - The unique name of the component.DeployerMBean getDeployerInstance(String componentName)
componentName - The unique name of the component.void installSharedLibrary(String name, String description, String componentRoot, boolean isSelfFirst, List elements) throws JBIException
name - The unique name of the Shared Library.description - The description of the Shared Library.componentRoot - The root directory for this Shared Library.isSelfFirst - Set to true to force the class loader for this Shared
Library to use a self-first hierarchy, or false for parent-first.elements - The list of jar files and class directories included in
this Shared Library, as a List of String objects in the order in which
they should appear in the class path. Each list element contains the full
path to either a jar file or a directory containing class files.JBIException - if any error occurs.ObjectName loadBootstrap(InstallationContext installContext, String bootClassName, List bootClassPathElements, List sharedLibraryList, boolean force) throws JBIException
installContext - The installation context.bootClassName - The name of the bootstrap class for the component.bootClassPathElements - A list of elements comprising the class
path for loading the bootstrap class. Each element in the list is a
String containing the full path to either a jar file or a directory
containing class files.sharedLibraryList - A list of String objects specifing the names of
the Shared Libraries required by the component, in the order in which
they should appear in the class path.force - Set to true if this is for a forced uninstall.JBIException - if the bootstrap cannot be loaded.void uninstallSharedLibrary(String id) throws JBIException
id - The component ID of the Shared Library.JBIException - if the uninstall fails.void unloadBootstrap(String componentName) throws JBIException
componentName - The unique name of the component.JBIException - if the bootstrap cannot be unloaded.void cancelComponentUpgrade(String componentName) throws JBIException
validateComponentForUpgrade() has already
been called but before upgradeComponent() is called. All
this method does is return the component to the SHUTDOWN
state and remove the busy indicator from the component entry in the
runtime registry cache.componentName - The name of the component.JBIException - if the component does not exist.void upgradeComponent(InstallationContext installContext, String bootClassName, List<String> bootClassPathElements, List<String> sharedLibraryList) throws JBIException
upgrade() method in its
bootstrap class, then the runtime jar files are updated and any changes
to the component's installation descriptor in jbi.xml are propagated. If
the component provides an upgrade() method, that method is
called to give the component the opportunity to upgrade its workspace
and all SUs deployed to it to a new version. In this case, it is the
responsibility of the component to perform all version verification, and
to provide any recovery processing required in the event of a failed
upgrade.installContext - The installation context.bootClassName - The name of the component's bootstrap class.bootClassPathElements - A list of elements comprising the class
path for loading the bootstrap class. Each element in the list is a
String containing the full path to either a jar file or a
directory containing class files.sharedLibraryList - A list of String objects specifing
the names of the Shared Libraries required by the component, in the order
in which they should appear in the class path.JBIException - if the update fails for some reason.boolean validateComponentForUpgrade(InstallationContext installContext, String bootClassName, List<String> bootClassPathElements, List<String> sharedLibraryList) throws JBIException
upgrade() method and returns an indicator of that to
the caller.installContext - The installation context.bootClassName - The name of the bootstrap class for the component.bootClassPathElements - A list of elements comprising the class
path for loading the bootstrap class. Each element in the list is a
String containing the full path to either a jar file or a
directory containing class files.sharedLibraryList - A list of String objects specifing
the names of the Shared Libraries required by the component, in the order
in which they should appear in the class path.true if the component provided an upgrade()
method, false if not.JBIException - if there is a problem with the component
implementation classes or with Shared Library dependencies.Copyright © 2011-2016 OpenESB Community. All Rights Reserved.