public class InstallationProcessor extends Object
InstallationProcessor class implements operations specified in the installation
descriptor. This class also allows generating the default Vinci Service descriptor for the
specified component.InstallationDescriptor| Modifier and Type | Field and Description |
|---|---|
protected static String |
DELEGATE_ROOT_PREFIX_REGEX |
protected static String |
DELEGATE_ROOT_REL_SUFFIX_REGEX |
protected static String |
DELEGATE_ROOT_SUFFIX_REGEX |
protected static String |
DELEGATE_ROOT_URL_SUFFIX_REGEX |
static String |
INSD_FILE_PATH |
protected static String |
MAIN_ROOT_REGEX |
protected static String |
MAIN_ROOT_REL_REGEX |
protected static String |
MAIN_ROOT_URL_REGEX |
static String |
VS_DESCRIPTOR_PATH |
| Constructor and Description |
|---|
InstallationProcessor(String mainRootPath,
Hashtable<String,String> installationTable)
Constructs an instance of the
InstallationProcessor class, using given main
component root path and a table of installed delegate components. |
InstallationProcessor(String mainRootPath,
Hashtable<String,String> installationTable,
InstallationController controller)
Similar to previous constructor, but sets a given
InstallationController object as
the requestor. |
| Modifier and Type | Method and Description |
|---|---|
protected static String |
componentIdRootRegExp(String componentId,
String suffix)
Builds $component_id$<suffix> regular expression string for a given component ID and a
given 'suffix' string.
|
protected static void |
findAndReplacePath(InstallationDescriptor.ActionInfo action)
Performs a specified 'find_and_replace_path' installation action.
|
static void |
generateVSDescriptor(InstallationDescriptor insdObject,
File mainRootDir)
Generates default Vinci Service descriptor for a specified component, and puts it to a
specified location.
|
static InputStream |
generateVSDescriptorAsStream(InstallationDescriptor insdObject)
Generates default Vinci Service descriptor for a specified component, and returns the content
of the descriptor as a stream (for Eclipse plug-in).
|
protected static String |
generateVSDescriptorContent(InstallationDescriptor insdObject)
Generates the default Vinci Service descriptor content for a specified component.
|
InstallationDescriptor |
getInstallationDescriptor() |
protected void |
initSubstitutionTables(String mainRootPath)
Initializes two
Hashtable objects that are used to substitute $dlg_comp_id$root
macros in URL and absolute path expressions. |
void |
process()
Starts processing installation instructions from the specified installation descriptor.
|
protected static String |
substituteCompIdRootInString(String source,
String compId,
String compRootPath)
Substitutes '$dlg_comp_id$root_url' and '$dlg_comp_id$root' macros in a given string for a
given delegate component.
|
protected static String |
substituteMainRootInString(String source,
String mainRootPath)
Substitutes '$main_root_url' and '$main_root' macros in a given string.
|
protected void |
substituteStringVariablesInAction(Properties params)
Substitutes two $main_root as well as two $comp_id$root macros in a given 'action'
Properties object values. |
protected void |
substituteStringVariablesInFiles(File dir)
Substitutes two $main_root as well as three $comp_id$root macros in all files in a given
directory, including its sub-directories.
|
public static final String INSD_FILE_PATH
public static final String VS_DESCRIPTOR_PATH
protected static final String MAIN_ROOT_REGEX
protected static final String MAIN_ROOT_REL_REGEX
protected static final String MAIN_ROOT_URL_REGEX
protected static final String DELEGATE_ROOT_PREFIX_REGEX
protected static final String DELEGATE_ROOT_SUFFIX_REGEX
protected static final String DELEGATE_ROOT_REL_SUFFIX_REGEX
protected static final String DELEGATE_ROOT_URL_SUFFIX_REGEX
public InstallationProcessor(String mainRootPath, Hashtable<String,String> installationTable)
InstallationProcessor class, using given main
component root path and a table of installed delegate components.mainRootPath - The given main component root path.installationTable - The given table of installed delegate components.public InstallationProcessor(String mainRootPath, Hashtable<String,String> installationTable, InstallationController controller)
InstallationController object as
the requestor.mainRootPath - The given main component root path.installationTable - The given table of installed delegate components.controller - The given InstallationController requestor.protected static String componentIdRootRegExp(String componentId, String suffix)
componentId - The given component ID.suffix - a suffix to be added to the component ID Valid 'suffix' strings are
InstallationDescriptor.DELEGATE_ROOT_SUFFIX_REGEX for absolute path,
InstallationDescriptor.DELEGATE_ROOT_REL_SUFFIX_REGEX for relative path,
InstallationDescriptor.DELEGATE_ROOT_URL_SUFFIX_REGEX for URL.public static void generateVSDescriptor(InstallationDescriptor insdObject, File mainRootDir) throws IOException
insdObject - The given installation descriptor of the component.mainRootDir - The given root directory of the component.IOException - if any I/O exception occurred.public static InputStream generateVSDescriptorAsStream(InstallationDescriptor insdObject) throws IOException
insdObject - The given installation descriptor of the component.IOException - if any I/O exception occurred.protected static String generateVSDescriptorContent(InstallationDescriptor insdObject)
insdObject - The given installation descriptor of the component.protected static void findAndReplacePath(InstallationDescriptor.ActionInfo action) throws IOException
action - The given 'find_and_replace_path' installation action.IOException - if any I/O exception occurred.protected static String substituteCompIdRootInString(String source, String compId, String compRootPath)
source - The given source string.compId - The given component ID.compRootPath - The given component root directory path.protected static String substituteMainRootInString(String source, String mainRootPath)
source - The given source string.mainRootPath - The given main component root directory path.public InstallationDescriptor getInstallationDescriptor()
InstallationDescriptor object, if the processing completed,
null otherwise.protected void initSubstitutionTables(String mainRootPath)
Hashtable objects that are used to substitute $dlg_comp_id$root
macros in URL and absolute path expressions.mainRootPath - The given main component root directory path.public void process()
throws IOException
IOException - if any I/O exception occurred.protected void substituteStringVariablesInAction(Properties params)
Properties object values.params - The given Properties object.protected void substituteStringVariablesInFiles(File dir) throws IOException
dir - The given directory.IOException - if any I/O exception occurred.Copyright © 2006–2022 The Apache Software Foundation. All rights reserved.