|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface that installer classes must use to generate package information and perform install/remove steps.
A handler will be called upon when dependencies and requirements are found in the PackageDescription that match the NamespaceURI of the handler and also when a package is installed or uninstalled.
N.B: A handler for "http://www.foo.com/basepath" is also the handler for "http://www.foo.com/basepath/extendedpath" but a handler for the entire namespace will take precidence.
Field Summary | |
static String |
FEATURE_NAMESPACE
|
static String |
FUNCTIONALITY
|
static String |
INTERFACE
|
Method Summary | |
Dependency |
buildDependency(org.w3c.dom.Element depEl)
Build a dependency from an element found in a package description document (Conflicts and dependencies have the same structure). |
Vector |
generateConflicts()
This function is used at build time. |
Vector |
generateProvides()
This function is used at build time. |
Vector |
generateRequires()
This function is used at build time. |
String[] |
getHandlerPredependencies()
Return the namespaces of handlers that must be called before this one at package install time. |
String |
getNamespaceURI()
Returns the namespace URI associated with this installer. |
void |
install(XoePackage xoePackage,
Proviso[] provisos)
Perform any install time operations |
void |
setPackage(XoePackage p)
This function is used at build time. |
void |
uninstall(XoePackage xoePackage,
Proviso[] provisos)
Perform any uninstall time operations |
void |
verify(XoePackage xoePackage,
Proviso[] provisos)
Pre-install check to make sure the package makes sense |
Methods inherited from interface org.xoe.core.services.IService |
getFeatures, getFunctionalities, getInformation, getInterfaces, init |
Field Detail |
public static final String INTERFACE
public static final String FUNCTIONALITY
public static final String FEATURE_NAMESPACE
Method Detail |
public Dependency buildDependency(org.w3c.dom.Element depEl) throws PackageDescriptionException
Dependency
returned must have an xpath defined.public String getNamespaceURI()
getHandlerPredependencies
.public String[] getHandlerPredependencies()
Strings
corresponding to the namespace
URIs of predependee handlers.public void verify(XoePackage xoePackage, Proviso[] provisos) throws PackageException
Use this function to prevent package installation from starting if there are any fatal flaws identified.
xoePackage
- the package to be verifiedprovisos
- any provisos in the package that match this installer's namespacePackageException
- if fatal flaws are identified in the packagepublic void install(XoePackage xoePackage, Proviso[] provisos) throws InstallException
Any installers identified by getHandlerPredependencies will already have been called.
xoePackage
- the package being installedprovisos
- any provisos in the package that match this installer's namespaceInstallException
- if installation failspublic void uninstall(XoePackage xoePackage, Proviso[] provisos)
Any installers identified by getHandlerPredependencies will not have been called yet.
xoePackage
- the package being uninstalledprovisos
- any provisos in the package that match this installer's namespacepublic void setPackage(XoePackage p) throws PackageException
public Vector generateRequires() throws PackageException
null
.public Vector generateConflicts() throws PackageException
null
.public Vector generateProvides() throws PackageException
null
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |