com.sun.enterprise.deployment.node

Interface VersionUpgrade

All Known Implementing Classes:

DataSourceNameVersionUpgrade, RemoveVersionUpgrade, ReplaceVersionUpgrade, StartMdbsWithApplicationVersionUpgrade

public interface VersionUpgrade

This interface defines the processing used to upgrade an older configuration file to the latest version. The class should be initialized by the init method, which should initialize the map returned by getMatchXPath with the keys to look for in the input configuration file and with values set to null. For REMOVE_ELEMENT, the map would usually contain one item. For REPLACE_ELEMENT, the map could contain more that one item. For REPLACE_ELEMENT, when all elements in the map have been matched, the isValid method is called. If it returns true, the getReplacementElementName and getReplacementElementValue methods are called and should return the replacement element name and value. if the input matched items are valid. Otherwise, these methods should return null.

Version:

Author:

Gerald Ingalls

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VersionUpgrade.UpgradeType

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getMatchXPath() Return the map of xml element to match
String	getReplacementElementName() Return the replacement element name
String	getReplacementElementValue() Return the replacement element value
VersionUpgrade.UpgradeType	getUpgradeType() Return the kind of processing to do
void	init() Initialize
boolean	isValid() Return whether the matched items are valid.

Method Detail

getUpgradeType

VersionUpgrade.UpgradeType getUpgradeType()

Return the kind of processing to do

Returns:

the kind of processing to do

init

void init()

Initialize

getMatchXPath

Map<String,String> getMatchXPath()

Return the map of xml element to match

Returns:

the map of xml element to match

getReplacementElementName

String getReplacementElementName()

Return the replacement element name

Returns:

the replacement element name

getReplacementElementValue

String getReplacementElementValue()

Return the replacement element value

Returns:

the replacement element value

isValid

boolean isValid()

Return whether the matched items are valid.

Returns:

whether the matched items are valid.