com.sun.jbi.component

Interface Upgrade

public interface Upgrade

This is an optional interface that can be implemented by a JBI component to provide a way to upgrade to a new version of the component. It is called by the JBI runtime during the upgrade processing initiated by a client, which can be either an ant task, an asadmin command, or an action in the admin console.

Author:

Mark S White

Method Summary

Methods

Modifier and Type	Method and Description
void	upgrade(String workspaceRoot, List<String> serviceUnitRoots) This method is called by the JBI runtime to allow a component to upgrade its workspace and any existing Service Units to match the new version of the component.

Method Detail

upgrade

void upgrade(String workspaceRoot,
           List<String> serviceUnitRoots)
             throws JBIException

This method is called by the JBI runtime to allow a component to upgrade its workspace and any existing Service Units to match the new version of the component. The JBI runtime copies the existing workspace root to the new workspace root prior to calling this method, so that the component can examine the contents of the workspace root to determine the version of the component from which the upgrade is being made. All updates to the workspace root and Service Unit roots are done in-place; in the event of a failure, the JBI runtime reverts back to the original workspace root and the Service Unit roots.

Note that the component must ensure that it never holds open references to any files in the workspace root or any of the Service Unit roots upon returning from this method. Failure to do so will cause problems when the runtime attempts to complete the upgrade processing.

Parameters:

workspaceRoot - the workspace root for the new version of the component that will replace the currently installed version. This is populated with the contents of the original workspace root and the component must update it to match the new version of the component.

serviceUnitRoots - a list of directory paths to all of the Service Units currently deployed to the component. The component must update all of these to match the new version of the component.

Throws:

JBIException - when there is an error requiring that the upgrade be terminated.