Working with Component Types
Introduction
A Component Type is a user definable object that is used to control how to handle source items referenced by a component. The component type object is actually another component that manages the acquisition and deployment of source items such as files, directories, and configurations.
All components must have its component type attribute set to some component type. Even if a component does not have a defined component type, its component type is set to untyped.
The files, directories, and other tree structures referenced by a simple component is managed as a discrete unit within a component. For example, an IIS application, which the provisioning software would manage as referenced source items might include the following:
-
a directory of content
-
IIS Web site settings
-
COM+ application
-
Windows Registry settings
Some source items referenced by components, such as files and directories, can be easily copied from a gold server or data source. Others, such as IIS Web site settings or Windows registry entries, need to be intelligently extracted from a data source in order to be treated as an independent, manageable entity. With its built-in component types, the provisioning software can recognize the most common source items used for J2EE and Windows applications, and can intelligently and accurately extract data for use as a component source, store the component source in a repository, and install the source items correctly in its intended destination.
When a component contains a procedure, such as testing to verify that a web server is alive, the procedure is seen ion the procedures section of the components details page.
The provisioning software comes populated with a large number of commonly used component types. See Built-in Components Types for more information on built-in component types.
Checking In a Component Type
Checking in a resource means copying a specific piece of software from a specific location (such as a directory on a gold server) and entering it in the repository with a specific name, a version number, and a resource type.
A resource type identifies the format and in many cases the function of a resource. Examples of resource types are file, directory, IIS Web Site Settings, and COM+ Application. For a complete list, see Built-in Components Types.
The resource repository uses a hierarchical namespace. Within this namespace, individual resources are identified by their name, which must be unique, and their version number.
The CLI command cdb.rsrc.ci checks in a resource. When you check in a resource with cdb.rsrc.ci, you specify the location of the source of the resource (with the -src argument), the location (a hierarchical name) in the repository where you would like to store the resource (with the -dst argument), and the resource type (with the -type argument).
A resource may be used for more than one component. Checking in a resource with cdb.rsrc.ci does not associate the resource with any particular component.
Extended Control Services
Extended control services are procedures that perform a software operation related to a resource or component. For a description of general purpose control services, see General Purpose Extended Control Services.
Built-in Components Types
Built-in component types enable you to quickly model many of the most common WebLogic, Windows, and J2EE application components and to automatically associate install, uninstall, export, and snapshot behavior with a particular resource.
Table 5–6 List of Built-in Component Types|
Any WebLogic WebLogic Enterprise Application WebLogic Web Application WebLogic EJB Any IIS IIS Application IIS Web Site or Virtual Directory Settings IIS Global Settings Global ISAPI Filter Settings Web site ISAPI Filter Settings Any Windows COM+ Application COM Object |
Registry Key Windows Registry File Data Source Name Windows Installer File (.msi) Windows Batch file Windows scripting host script Any UNIX Symbolic Link RPM File File Directory Container untyped |
Component Type: File
Files represent an untyped single file taken from a target machine. The provisioning software deploys the files directly with no special post processing. Although files have a system component the functionality for installation, snapshot, and un-installation are built-in to the system and are not represented in the component XML.
Browsing
Table 5–7 File Browsing Behavior|
|
Unix |
Windows |
|
Root Path |
“/” |
List of physical drives on the host or network shares mapped to a drive letter. Removable media (floppy, cd, zip, etc.) are not displayed. |
|
Delimiter |
“/” |
“\” |
|
Ordering |
Alphabetical with directories first |
|
|
Selection Type |
User can single select a file for check in. Double click on a directory to view its contents |
|
|
Sample Path |
/foo/foo.txt |
C:\foo\foo.txt |
|
Filters |
None |
|
|
Special |
Links will display their local name and the location pointed to. i.e. “foo->/usr/bar” |
|
Extended Control Procedures
Table 5–8 File Extended Control Procedures|
Name |
Parameters |
Description |
|
Delete |
path: Full path to a file on disk |
Removes the file from the filesystem. Provides a platform independent way to remove files. |
Component Type: Directory
Directories represent an untyped collection of files and folders taken from a target machine. Although Directories have a system component the functionality for installation, snapshot, and un-installation are built-in to the system and are not represented in the component XML.
Browsing
Table 5–9 Directory Browsing Behavior|
|
Unix |
Windows |
|
Root Path |
“/” |
List of physical drives on the host or network shares mapped to a drive letter. Removable media (floppy, cd, zip, etc.) are not displayed. |
|
Delimiter |
“/” |
“\” |
|
Ordering |
Alphabetical with directories first |
|
|
Selection Type |
User can single select a directory for check in. Double click on a directory to view its contents |
|
|
Sample Path |
/foo/foo |
C:\foo\foo |
|
Filters |
None |
|
|
Special |
Links will display their local name and the location pointed to. i.e. “foo/->/usr/bar/” |
|
Extended Control Procedures
Table 5–10 Directory Extended Control Procedures|
Name |
Parameters |
Description |
|
Delete |
path: Full path to a directory on disk |
Removes the directory from the filesystem and all if its children recursively. Provides a platform independent way to remove directories. |
IIS Types Introduction
The following four IIS Types share a common implementation. All four export, Install, and delete data stored in the IIS metabase. As a result there are a common set of functions, formats, and errors.
Exported/Internal File Format
All four IIS types use an XML format to store their section of the metabase. The present XML format does not support metabase properties of type NTACL (such as AdminACL); if any are encountered while reading/writing to the metabase, they are ignored. Also, properties of type IPSec (such as IPSecurity) are written out as serialized objects, and as a result they are not human-readable (during either direct examination, or as difference results).
M-I Difference
During a snapshot the current state of the metabase is exported into an XML file. During an M-I difference the metabase is re-exported and compared against the original XML file. The standard XML differentiator is used to generate differences between these files.
Error Conditions
Table 5–11 IIS Types Introduction Error Conditions|
Action |
Condition |
Result |
|
Install/Export |
IIS Does not exist or is the improper version |
Install/Export fails |
|
Install/Uninstall |
Remote Agent does not have administrator privileges |
Install/Uninstall fails |
IIS Web Site or Virtual Directory Settings
Represents the settings for an IIS Website or Virtual Directory. Please note that this resource type only contains the settings for a website or virtual directory. The content on the web site must be checked in as a separate resource.
Browsing
Table 5–12 IIS Types Introduction Browsing Behavior|
Root Path |
List of web sites on the target system |
|
Delimiter |
“\” |
|
Ordering |
web sites and virtual directories appear in the order they occur in the metabase. This corresponds to the order they appear in the IIS Control panel and are NOT alphabetical. |
|
Selection Type |
User can single select a web site or virtual directory. Selecting a web site is considered recursive. Double-clicking on a web site provides a listing of the virtual directories underneath the web site. |
|
Sample Path |
Website1\VirturalDir2 |
|
Filters |
None |
Installation
Installation occurs by reading the XML file and importing into the target system metabase. If a web site with the same name exists it is overwritten. If there are multiple web sites with the same name on the system the first matching one will be removed and overwritten.
Special cases include untyped keys/nodes (see below for more info) and SSL certificates, which are not deployed. The relevant settings for SSL certs in IIS (SSLCertHash and SSLStoreName) are preserved during a deployment if they exist on the target, but if they do not exist they are not added.
To bring up a secure site after being deployed (or redeployed) requires a restart of IIS.
Un-Install
The entire web site is removed on the target system. All Virtual Directories underneath the web site are removed regardless of whether they were installed by the provisioning software. If the settings are just for a virtual directory only that directory is removed, not its containing site. Note the matching for uninstall is done via name, so the first web site with the same name found on the system will be uninstalled. Once this is complete the XML file used during installation is removed.
Component Type: IIS Global Filter Settings
Resource type is used to represent Global ISAPI filter settings. Please note that this resource type only contains the settings for a IIS Global Filter. The actual DLL implementing the filter must be installed separately.
Browsing
Table 5–13 IIS Global Filter Settings Browser Behavior|
Root Path |
Flat list of the global filters on the target system |
|
Delimiter |
N\A |
|
Ordering |
Filters appear in the order they occur in the metabase. This corresponds to the order they appear in the IIS Control panel. This is not alphabetical. |
|
Selection Type |
User can single select a filter. Filters cannot be expanded |
|
Sample Path |
Filter1 |
|
Filters |
None |
Installation
Installation occurs by reading the XML file and importing into the target system metabase. If a filter setting with the same name exists on the target machine it is overwritten.
Un-Install
The filter settings are removed on the target system then the XML file used during installation is removed.
Component Type: IIS Web Site Filter Settings
Please note that this resource type only contains the settings for a Web site Filter. The actual DLL implementing the filter must be installed separately.
Browsing
Table 5–14 IIS Web Site Filter Settings Browser Behavior|
Root Path |
List of the web sites on the system |
|
Delimiter |
\ |
|
Ordering |
Filters will appear in the order they occur in the metabase. This will correspond to the order they appear in the IIS Control panel. This is not alphabetical. |
|
Selection Type |
User must first expand a web site to see the list of filters for that web site. All web site filters, or just an individual filter may be selected for check in. |
|
Sample Path |
Website1\filter1 |
|
Filters |
None |
Installation
Installation occurs by reading the XML file and importing into the target system metabase. If a filter settings with the same name exists on the target machine it is overwritten.
Un-Install
The filter settings are removed on the target system metabase, then the XML file used during installation is removed.
Component Type: IIS Global Settings
Resource type is used to represent Global IIS Settings.
Browsing
Table 5–15 IIS Global Settings Browser Behavior|
Root Path |
List of the global settings on the target system |
|
Delimiter |
N\A |
|
Ordering |
Settings will appear in the order they are presented in the metabase. |
|
Selection Type |
User can single select an individual setting for check in. Settings have no children and cannot be expanded. |
|
Sample Path |
AspCacheSize |
|
Filters |
none |
Installation
Installation occurs by reading the XML file and importing into the target system metabase. The setting on the target system is overwritten if it exists.
Un-Install
Global settings cannot be uninstalled. Uninstalls will have no affect on the target system except to remove the *.XML file used during install.
Component Type: COM+ Application
Resource type is used to represent COM+ Applications. COM+ Applications are treated as a monolithic unit. The settings and content are installed as a group.
Browsing
Table 5–16 COM+ Application Browser Behavior|
Root Path |
List of COM+ Applications on the system |
|
Delimiter |
N\A |
|
Ordering |
Alphabetical based on application name. |
|
Selection Type |
User can single select an individual COM+ Application for check in. COM+ Applications have no children and cannot be expanded. |
|
Sample Path |
FM Stocks |
|
Filters |
None |
Exported/Internal File Format
COM+ Applications are exported into a Windows Installer File (*.MSI) using the COM+ Admin SDK.
M-I Difference
The COM+ Application is re-exported on the target system as an MSI file and compared against the MSI file used to install the application. M-I diff will only indicate that there were differences (i.e. the two binary files are different) but will not indicate the details of the differences.
Installation
-
If the COM+ Application with the same name is already installed on the target system and running as a service then it is stopped along with all of its running dependent services. The COM+ Application will then be deleted from the COM+ Catalog.
-
The new COM+ Application is installed using the COM+ Admin SDK.
-
To start the COM+ Application the user will have to use the startApplication call step to manually start the COM+ application.
Un-Install
The MSI used to install the COM+ Application is used to uninstall the COM+ Applications using the following command line:
msiexec /qn /x <path to msi file> |
Once this is complete the msi file is removed from the target system.
Error Conditions
Table 5–17 COM+ Application Error Conditions|
Action |
Condition |
Result |
|
Install |
COM+ Application already exists with the same name and either cannot be stopped or dependent services cannot be stopped. |
Installation fails. |
|
Uninstall |
MSI file used for installation is no longer available |
Uninstall fails |
|
Install/Uninstall |
Remote Agent does not have administrator privileges |
Install/Uninstall fails |
Extended Control Procedures
Table 5–18 COM+ Application Extended Control Procedures|
Name |
Parameters |
Description |
|
startApp |
appName: Full name of the COM+ application. |
Starts the COM+ application if it is run as a service |
|
stopApp |
appName: Fill name of the COM+ application to stop. |
Stops the COM+ application and all dependent services |
|
stopRouter |
N/A |
Stops the COM+ Routing services |
|
startRouter |
N/A |
Starts the COM+ Routing services |
|
installAsUser |
rsrcSrcPath: Name of the COM+ application rsrcInstallPath: Path to the msi file representing the application userID: User whom is going to run the application password: Password of the user |
Allows installation of a COM+ application which runs as a particular user. |
Component Type: COM Component
Resource type is used to represent COM components.
Browsing
Table 5–19 COM Component Browser Behavior|
Root Path |
Uses standard File Browser |
|
Delimiter |
|
|
Ordering |
|
|
Selection Type |
|
|
Sample Path |
|
|
Filters |
*.ocx. *.dll |
Exported/Internal File Format
COM components are stored as a file in their native format.
M-I Difference
The COM component is compared as a binary file against the file used during installation. M-I diff will only indicate that there were differences (i.e. the two binary files are different) but will not indicate the details of the differences.
Installation
Regsvr32 is called to register the COM components in the dll using the following command line call:
regsvr32.exe /s <file path> |
Uninstall
Regsvr32 is called to unregister the COM components in the dll using the following command line call:
regsvr32.exe /s /u <file path> |
After the dll is unregistered it is removed from the target system.
Error Conditions
Table 5–20 COM Component Error Conditions|
Action |
Condition |
Result |
|
Install |
The supplied .dll or .ocx does not contain COM components |
Installation fails. |
|
Uninstall |
The supplied .dll or .ocx does not contain COM components |
Uninstall fails |
Component Type: Registry Keys
This resource type is used to represent registry keys and their associated values.
Browsing
Table 5–21 Registry Keys Browser Behavior|
Root Path |
List of the 5 main registry roots: HKEY_LOCAL_MACHINE HKEY_CLASSES_ROOT HKEY_CURRENT_USER HKEY_USERS HKEY_CURRENT_CONFIG |
|
Delimiter |
\ |
|
Ordering |
Settings will appear in the order in which they are presented in the registry. |
|
Selection Type |
User can single select an individual key for check in. Selecting a key will check in that key and all of its children. Double clicking on keys will recursively check down the registry until a value is found. The name the value is displayed but not its contents. Values can be individually exported. |
|
Sample Path |
HKEY_LOCAL_MACHINE\Software\Example\Key |
|
Filters |
None |
Exported/Internal File Format
Registry keys are exported into an XML file.
M-I Difference
During a snapshot the current state of registry key (and its children) is exported into an XML file. During an M-I difference the registry key is re-exported and compared against the original XML file. The standard XML diff comparator is used to generate differences between these files.
Installation
The XML file representing the registry is read and imported into the target system using an execJava step. Any keys are values already existing in the target system is overwritten.
Un-Install
The execJava implementation will take the root of the exported key, and delete all keys and values beneath it. If the root is a value, it will be deleted.
Error Conditions
Table 5–22 Registry Keys Error Conditions|
Action |
Condition |
Result |
|
Install/Uninstall |
Remote Agent does not have administrator privileges |
Install/Uninstall fails |
Component Type: Registry File
Registry files are generated by Regedit to represent exports to the metabase. *.reg files are in text format and specify the keys and values to add or remove from the registry.
Browsing
Table 5–23 Registry File Browser Behavior|
Root Path |
Uses standard File Browser |
|
Delimiter |
|
|
Ordering |
|
|
Selection Type |
|
|
Sample Path |
|
|
Filters |
*.reg |
Exported/Internal File Format
COM components are stored as a file in their native text file format.
M-I Difference
M-I Differencing is not supported for *.reg files. Snapshots will not be taking during installation resulting in nothing to diff during the M-I diff. If the user would like to difference registry changes they are encouraged to use the built-in Registry keys type.
Installation
Regedit /s <file path> is called on the *.reg file to write its changes to the registry.
Un-Install
During uninstall only the *.reg file used during installation will be removed. The registry keys inside the reg file are unaffected. Users are encouraged to use the build-in Registry keys type to allow for registry un-installation.
Error Conditions
Table 5–24 Registry File Error Conditions|
Action |
Condition |
Result |
|
Install |
The supplied *.reg file is not in the proper format for regedit. |
Installation fails. |
|
Install |
The agent does not have proper permissions to write into the registry sections designated by the *.reg file |
Installation fails. |
Component Type: Data Source Name
DSN Entries represent ODBC settings for connecting to a database. They can be edited by the user on the system by bringing up the “Data Source Administrator” control panel. The actual settings are stored in specific places in the registry. As a result, the Data source name Resource Type is built on top of the Registry keys resource type. The DSN Install, export, and uninstall directly use the facilities provided by the Registry Key resource handler. The DSN browser wraps the Registry browser to provide an experience closer to the “Data Source Administrator” control panel.
Browsing
Table 5–25 Data Source Name Browser Behavior|
Root Path |
List of the 2 DSN roots: User System |
|
Delimiter |
/ |
|
Ordering |
Settings will appear in alphabetical order. |
|
Selection Type |
Double clicking on the System and User roots will provide a list of the DSN entries underneath. Users can then select a single entry for check in. |
|
Sample Path |
User/Oracle8 |
|
Filters |
None |
Exported/Internal File Format
On export the browser will export the key containing all the DSN settings, as well as the value of the same name in the `ODBC Data Sources' key at the same level in the registry hierarchy.
Un-Install
The DSN uninstall is based on the registry uninstall with the caveat that the path being deleted is the key containing the DSN settings, but not the key the DSN GUI uses to display the available DSN settings. Special logic exists to delete this key as well. The semantics of this differ slightly from the registry uninstall semantics, though they use the same executor.
Error Conditions
The DSN system component directly calls the Install method of the registry system component. Please reference the Registry Key section of this document for further information on implementation and possible errors.
Component Type: Windows Installer File (*.msi)
Resource type used to represent Silent MSI files.
Browsing
Table 5–26 Windows Installer File Browser Behavior|
Root Path |
Uses standard File Browser |
|
Delimiter |
|
|
Ordering |
|
|
Selection Type |
|
|
Sample Path |
|
|
Filters |
*.msi |
Exported/Internal File Format
MSI files are stored as a file in their native format.
M-I Difference
M-I Differencing is not supported for Windows Installer files. Snapshots will not be taking during installation resulting in nothing to diff during the M-I diff. Since ROX does not have first-hand knowledge of the actions taken during the installer run it is not feasible to determine what needs to be captured.
Installation
The windows installer service is called on the msi file to import it into the target system with the following command:
misexec /qn /i <file path> |
Un-Install
The windows installer service uninstalls is called on the msi file used during installation to uninstall the package using the following command:
msiexec /qn /x <file path> |
After msiexec is called the msi file is removed.
Error Conditions
Table 5–27 Windows Installer File Error Conditions|
Action |
Condition |
Result |
|
Install |
The supplied *.msi is not a proper windows installer file. |
Installation fails. |
|
Install |
The agent does not have proper permissions to run installations |
Installation fails. |
|
Uninstall |
The package has already been uninstalled |
Uninstall fails |
Component Type: Windows Batch File
Resource type used to represent *.bat and *.cmd files.
Browsing
Table 5–28 Windows Batch File Browser Behavior|
Root Path |
Uses standard File Browser |
|
Delimiter |
|
|
Ordering |
|
|
Selection Type |
|
|
Sample Path |
|
|
Filters |
*.cmd, *.bat |
Exported/Internal File Format
Windows batch files are stored as a file in their native text format.
M-I Difference
M-I Differencing is not supported for Windows Batch files. Snapshots are not taken during installation resulting in nothing to diff during the M-I diff.
Installation
The batch file is run during installation.
Un-Install
During uninstall the *.bat file is removed from the target system.
Error Conditions
Table 5–29 Windows Batch File Error Conditions|
Action |
Condition |
Result |
|
Install |
The supplied batch file is not a valid batch file or contains errors. |
Installation fails. |
Component Type: Windows Scripting Host Script
Windows scripting host (WSH) scripts are text files either vbscript (*.vbs) or jscript (*.js) or contained within an XML project file (*.wsf).
Browsing
Table 5–30 Windows Scripting Host Script Browsing Behavior|
Root Path |
Uses standard File Browser |
|
Delimiter |
|
|
Ordering |
|
|
Selection Type |
|
|
Sample Path |
|
|
Filters |
*.js, *.vbs, *.wsf |
Exported/Internal File Format
Stored as a file in their native text format.
M-I Difference
M-I Differencing is not supported for WSH files. Snapshots will not be taking during installation resulting in nothing to diff during the M-I diff.
Installation
The WSH script is run via cscript.exe as follows:
cscript <file path> |
Un-Install
During uninstall the script file is removed from the target host.
Error Conditions
Table 5–31 Windows Scripting Host Script Error Conditions|
Action |
Condition |
Result |
|
Install |
The supplied file is not a valid wsf file or contains errors. |
Installation fails. |
Component Type: IIS Website (IIS Virtual Directory)
Browsing
Uses IIS Website Settings Browser.
Exported/Internal File Format
Composite Component: IIS Website/VDir Settings, IIS Virtual Directory Set, IIS Website Filter Set, Directory
Upon creation the contained entities (listed above) are created and linked to separately as appropriate.
Component Type: IIS Website Filter
Browsing
Uses IIS Website Filter Settings Browser.
Exported/Internal File Format
Composite Component: IIS Website Filter Settings, COM Object
Upon creation the contained entities (listed above) are created and linked to separately as appropriate.
Component Type: Symbolic Link
Browsing
Uses standard File Browser (with restricted export rules)
Exported/Internal File Format
Symlinks are an exception among simple component types in that they do not contain a resource. The data of a symlink is stored as a set of variables (one each for name and location) in the component.
Component Type: WebLogic WAR file
Browsing
Not directly browsable. Must be obtained through WebLogic web application browsers.
Exported/Internal File Format
This component has a dual nature. It can be either a .war archive, or the exploded version of that archive. Thus the file format is either an archive file in native format, or a package, respectively.
M-I Difference
Will use the standard file/directory MI diff approach.
Installation
Can not be directly installed. Must be installed as part of a WebLogic web application container. The file/directory is copied to the filesystem based on the install path, and then registered with the WL admin server.
Un-Install
Can not be directly uninstalled. The containing WebLogic web application container must be uninstalled, which will result in the removal of this file/dir.
Error Conditions
See Error Conditions.
Component Type: WebLogic web application settings
Browsing
Not directly browsable. Must be obtained through WebLogic web application browsers.
Exported/Internal File Format
On export the relevant settings for this webapp will be read from the admin server and stored as a custom config gen'd file.
M-I Difference
The relevant settings for the app. will be exported into a file, which will be compared to the file that contained the settings during deployment.
Installation
Can not be directly installed. Must be installed as part of a WebLogic web application container. Installation involves reading the post-configured file and applying all the settings to the admin server.
Un-Install
Can not be directly uninstalled. The containing WebLogic web application container must be uninstalled, which will result in the removal of this file and related settings of the webapp within WebLogic. Settings not specific to the webapp will not be removed.
Error Conditions
See Table 5–34.
Component Type: WebLogic Web Application
Browsing
Two browsers are supported. An admin server browser from which you can select one of the installed applications and its relevant settings, and a filesystem browser from which you can select the WAR file and a component without settings is created.
Admin Server Browser:
Table 5–32 WebLogic Web Application Browsing Behavior (Admin Server)|
Root Path |
List of Web Applications on the admin server |
|
Delimiter |
N/A |
|
Ordering |
Alphabetical based on app name |
|
Selection Type |
Single individual web app. Only standalone web applications will show up in this list. Any webapps that are part of an EAR file will not be displayed in, or selection allowed from, this list. |
|
Sample Path |
JChart |
|
Filters |
None |
Filesystem Browser:
Table 5–33 WebLogic Web Application Browsing Behavior (File System)|
Root Path |
Uses standard File Browser (directories are valid selections) |
|
Delimiter |
|
|
Ordering |
|
|
Selection Type |
|
|
Sample Path |
|
|
Filters |
*.war |
Exported/Internal File Format
Composite Component: WebLogic web application container
Installation
Must be targeted at a WL target (server/cluster) which will install the component on that target, and install the contained reg component on the admin server of the target.
Un-Install
Untargets the webapp from the target, and if not currently targeted elsewhere, removes the registration comp from the admin server.
Error Conditions
Table 5–34 WebLogic Web Application Error Conditions|
Action |
Condition |
Result |
|
Install |
The topology is incorrectly configured (target host doesn't point at correct domain host) |
Targeting fails. |
|
Install |
The target host is not a valid WL target. |
Installation prohibited. |
|
Browsing/Install/Uninstall |
Credentials aren't properly configured. |
Operation fails. |
|
Browsing |
Path not correctly configured in domain host. |
Browsing fails. |
Component Type: WebLogic JAR file
Browsing
Not directly browsable. Must be obtained through WebLogic EJB browsers.
Exported/Internal File Format
This component has a dual nature. It can be either a.jar archive, or the exploded version of that archive. Thus the file format is either an archive file in native format, or a package, respectively.
M-I Difference
Will use the standard file/directory MI diff approach.
Installation
Can not be directly installed. Must be installed as part of a WebLogic EJB container. The file/directory is copied to the filesystem based on the install path, and then registered with the WL admin server.
Un-Install
Can not be directly uninstalled. The containing WebLogic EJB container must be uninstalled, which will result in the removal of this file/dir.
Error Conditions
See Component Type: WebLogic EJB.
Component Type: WebLogic EJB settings
Browsing
Not directly browsable. Must be obtained through WebLogic EJB browsers.
Exported/Internal File Format
On export the relevant settings for this EJB will be read from the admin server and stored as a custom config gen'd file.
M-I Difference
The relevant settings for the EJB will be exported into a file, which will be compared to the file that contained the settings during deployment.
Installation
Can not be directly installed. Must be installed as part of a WebLogic web application container.Installation involves reading the post-configured file and applying all the settings to the admin server.
Un-Install
Can not be directly uninstalled. The containing WebLogic web application container must be uninstalled, which will result in the removal of this file and related settings of the webapp within WebLogic. Settings not specific to the webapp will not be removed.
Error Conditions
See Component Type: WebLogic EJB
Component Type: WebLogic EJB container
Browsing
Not directly browsable. Must be obtained through WebLogic EJB browsers.
Exported/Internal File Format
Composite Component: WebLogic JAR file, WebLogic EJB container
Installation
Must be targeted at a WL Domain host. Installs the nested components, and registers the EJB with WebLogic. Can be installed as part of a retarget during installation of a WebLogic EJB.
Un-Install
Removes the EJB from WebLogic, then uninstalls the nested components.
Error Conditions
Table 5–35 WebLogic EJB container Error Conditions|
Action |
Condition |
Result |
|
Uninstall |
A dependant WebLogic EJB is still installed. |
Uninstall fails indicating the dependency. |
Component Type: WebLogic EJB
Browsing
Two browsers are supported. An admin server browser from which you can select one of the installed applications and its relevant settings, and a filesystem browser from which you can select the JAR file and a component without settings is created.
Admin Server Browser:
Table 5–36 WebLogic EJB Browsing Behavior (Admin Server)|
Root Path |
List of EJBs on the admin server |
|
Delimiter |
N/A |
|
Ordering |
Alphabetical based on app name |
|
Selection Type |
Single individual web app. Only standalone EJBs will show up in this list. Any EJBs that are part of an EAR file will not be displayed in, or selection allowed from, this list. |
|
Sample Path |
companyStoreEJBs |
|
Filters |
None |
Filesystem Browser:
Table 5–37 WebLogic EJB Browsing Behavior (File System)|
Root Path |
Uses standard File Browser (directories are valid selections) |
|
Delimiter |
|
|
Ordering |
|
|
Selection Type |
|
|
Sample Path |
|
|
Filters |
*.jar |
Composite Component: WebLogic EJB Container
Installation
Must be targeted at a WL target (server/cluster) which will install the component on that target, and install the contained reg component on the admin server of the target.
Un-Install
Untargets the EJB from the target, and if not currently targeted elsewhere, removes the registration comp from the admin server.
Error Conditions
Table 5–38 WebLogic EJB Container Error Conditions|
Action |
Condition |
Result |
|
Install |
The topology is incorrectly configured (target host doesn't point at correct domain host) |
Targeting fails. |
|
Install |
The target host is not a valid WL target. |
Installation prohibited. |
|
Browsing/Install/Uninstall |
Credentials aren't properly configured. |
Operation fails. |
|
Browsing |
Path not correctly configured in domain host. |
Browsing fails. |
Component Type: WebLogic EAR file
Browsing
Not directly browsable. Must be obtained through WebLogic enterprise application browsers.
Exported/Internal File Format
This component has a dual nature. It can be either a .EAR archive, or the exploded version of that archive. Thus the file format is either an archive file in native format, or a package, respectively.
M-I Difference
Will use the standard file/directory MI diff approach.
Installation
Can not be directly installed. Must be installed as part of a WebLogic enterprise application container. The file/directory is copied to the filesystem based on the install path, and then registered with the WL admin server.
Un-Install
Can not be directly uninstalled. The containing WebLogic EJB container must be uninstalled, which will result in the removal of this file/dir.
Error Conditions
See Table 5–34
Component Type: WebLogic enterprise application settings
Browsing
Not directly browsable. Must be obtained through WebLogic enterprise application browsers.
Exported/Internal File Format
On export the relevant settings for this app will be read from the admin server and stored as a custom config gen'd file.
M-I Difference
The relevant settings for the Application will be exported into a file, which will be compared to the file that contained the settings during deployment.
Installation
Can not be directly installed. Must be installed as part of a WebLogic enterprise application container. Installation involves reading the post-configured file and applying all the settings to the admin server.
Un-Install
Can not be directly uninstalled. The containing WebLogic enterprise application container must be uninstalled, which will result in the removal of this file and related settings of the webapp within WebLogic. Settings not specific to the webapp will not be removed.
Error Conditions
See Table 5–34
Component Type: WebLogic Enterprise Application Container
Browsing
Not directly browsable. Must be obtained through WebLogic enterprise application browsers.
Exported/Internal File Format
WebLogic EAR file, WebLogic enterprise application container, WebLogic List.
Installation
Must be targeted at a WL Domain host. Installs the nested components, and registers the Enterprise Application with WebLogic. Can be installed as part of a retarget during installation of a WebLogic enterprise application, or WebLogic Contained module.
Un-Install
Removes the Enterprise Application from WebLogic, then uninstalls the nested components.
Error Conditions
Table 5–39 WebLogic Enterprise Application Container Error Conditions|
Action |
Condition |
Result |
|
Uninstall |
A dependant WebLogic enterprise application, or contained WebLogic module is still installed. |
Uninstall fails indicating the dependency. |
Component Type: WebLogic Enterprise Application
Browsing
Two browsers are supported. An admin server browser from which you can select one of the installed applications and its relevant settings, and a filesystem browser from which you can select the EAR file and a component without settings is created.
Admin Server Browser:
Table 5–40 WebLogic Enterprise Application Browsing Behavior (Admin Server)|
Root Path |
List of Enterprise Applications on the admin server |
|
Delimiter |
N/A |
|
Ordering |
Alphabetical based on app name |
|
Selection Type |
Single individual enterprise application. |
|
Sample Path |
companyStoreAdmin |
|
Filters |
None |
Filesystem Browser:
Table 5–41 WebLogic Enterprise Application Browsing Behavior (File System)|
Root Path |
Uses standard File Browser (directories are valid selections) |
|
Delimiter |
|
|
Ordering |
|
|
Selection Type |
|
|
Sample Path |
|
|
Filters |
*.ear |
Exported/Internal File Format
Composite Component: WebLogic enterprise application container.
Installation
Must be targeted at a WL target (server/cluster) which will install the component on that target, and install the contained reg component on the admin server of the target.
Un-Install
Untargets the enterprise app from the target, and if not targeted elsewhere, removes the registration comp from the admin server.
Error Conditions
Table 5–42 WebLogic Enterprise Application Error Conditions|
Action |
Condition |
Result |
|
Install |
The topology is incorrectly configured (target host doesn't point at correct domain host) |
Targeting fails. |
|
Install |
The target host is not a valid WL target. |
Installation prohibited. |
|
Browsing/Install/Uninstall |
Credentials aren't properly configured. |
Operation fails. |
|
Browsing |
Path not correctly configured in domain host. |
Browsing fails. |
Component Type: WebLogic List
Browsing
Not directly browsable. Must be obtained through WebLogic enterprise application browsers.
Exported/Internal File Format
This component is a container component with some custom install/uninstall/snapshot blocks. In all other ways it is only a generic container component.
Installation
Does not support direct installation.
Un-Install
Does not support direct uninstallation.
Error Conditions
See contained WebLogic module types.
Component Type: Contained WebLogic web Application Container
Browsing
Not directly browsable. Must be obtained through WebLogic enterprise application browsers.
Exported/Internal File Format
Composite Component:
Contains a final WebLogic WAR file stub component, and a non-final, stub by default, WebLogic web application settings component.
Also contains a final compRef to the WebLogic enterprise application container component contained by the WebLogic enterprise application that contains the WebLogic List that contains this component.
Installation
Can be installed on a WL Domain host. Results in the installation of the WebLogic enterprise application container as well.
Un-Install
Uninstalls the WebLogic enterprise application container.
Error Conditions
Table 5–43 Contained WebLogic web Application Container Error Conditions|
Action |
Condition |
Result |
|
Uninstall |
A dependant contained WebLogic web application is installed. |
Uninstall fails indicating the dependency. |
Component Type: contained WebLogic web application
Same as WebLogic web application except it contains a final Contained WebLogic web application container.
Component Type: Contained WebLogic EJB Container
Browsing
Not directly browsable. Must be obtained through WebLogic enterprise application browsers.
Exported/Internal File Format
Composite Component:
Contains a final WebLogic JAR file stub component, and a non-final, stub by default, WebLogic web application settings component.
Also contains a final compRef to the WebLogic enterprise application container component contained by the WebLogic enterprise application that contains the WebLogic List that contains this component.
Installation
Can be installed on a WL Domain host. Results in the installation of the WebLogic enterprise application container as well.
Un-Install
Uninstalls the WebLogic enterprise application container.
Error Conditions
Table 5–44 Contained WebLogic EJB Container Error Conditions|
Action |
Condition |
Result |
|
Uninstall |
A dependant contained WebLogic web application. |
Uninstall fails indicating the dependency. |
Component Type: Contained WebLogic EJB
Same as WebLogic EJB except it contains a final Contained WebLogic web application container.
- © 2010, Oracle Corporation and/or its affiliates