Chapter 3 Built-in Component Types
You can use built-in component types to quickly model many of the most common WebLogic, Microsoft Windows, and J2EE application components. These component types enable you to automatically associate installation, uninstallation, export, and snapshot behavior with a particular component.
The following component types are available as part of the base product:
Other component types, such as those for WebLogic and Microsoft Windows applications, are available through plug-ins. For more information, see the N1 Grid Service Provisioning System 5.0 Plug-In Collection at http://docs.sun.com/db/coll/1223.1.
Component Type: system#file
The system#file component type represents a single file that is taken from a target server. The provisioning system deploys a file directly with no special postprocessing. The system#file component type includes installation, uninstallation, and snapshot procedures.
The system#file component type defines the following variables:
-
installName – The name to use for the resource when it is installed. The default value is the name of the component.
-
installPath – The path in which to intall the resource. The default value is the value of the installPath variable of the container component.
-
installPermissions – The permissions to assign to the resource when it is installed. See the chmod(1M) man page. The default value is empty.
-
installUser – The owner of this resource when it is installed. The default value is empty.
-
installGroup – The group to assign to this resource when it is installed. The default value is empty.
-
installDiffDeploy – Specifies whether the resource should be deployed in differential deploy mode. The default value is TRUE.
-
overrideRsrcInstallPath – The absolute path in which to install the resource. If not defined, the resource is installed in the path specified by installPath. This variable is not commonly used so that installPath can be used to specify the path in which to install both the component and the resource.
Browsing
|
|
UNIX Systems |
Microsoft Windows Systems |
|---|---|---|
|
Root Path |
/ |
List of physical drives on the host or network are mapped to a drive letter. Removable media is not shown. |
|
Delimiter |
/ |
\ |
|
Ordering |
Alphabetical with directories appearing first |
|
|
Selection Type |
User can select a file for check-in. Double click a directory to view its contents. |
|
|
Sample Path |
/foo/foo.txt |
C:\foo\foo.txt |
|
Special |
Links display their local name and the location pointed to: foo->/usr/bar |
|
Extended Control Procedures
The following procedures are defined for the system#file component type:
-
default install block – Deploys the contained file based on the state of the variables. No snapshots are captured.
-
markOnly install block – Marks the system to indicate that a new version of the component is installed. No resources are transferred, and no snapshots are captured.
-
default uninstall block – Undeploys the contained file from the location to which it was originally deployed.
-
markOnly uninstall block – Marks the system to indicate that the current version of the component has been uninstalled. The component's resources are not actually removed from the target host.
-
default snapshot block – Captures a snapshot of the deployed file. Because the default install block does not capture the file by default, container components must call this routine explicitly if you want a snapshot.
Component Type: system#directory
The system#directory component type represents a collection of files and folders that are taken from a target server. The system#directory component type includes installation, uninstallation, and snapshot procedures.
The system#directory component type defines the following variables:
-
installName – The name to use for the resource when it is installed. The default value is the name of the component.
-
installPath – The path in which to install the resource. The default value is the value of the installPath variable of the container component.
-
installPermissions – The permissions to assign to the resource when it is installed. See the chmod(1M) man page. The default value is empty.
-
installUser – The owner of this resource when it is installed. The default value is empty.
-
installGroup – The group to assign to this resource when it is installed. The default value is empty.
-
installDiffDeploy – Specifies whether the resource should be deployed in differential deploy mode. The default value is TRUE.
-
overrideRsrcInstallPath – The absolute path in which to install the resource. If not defined, the resource is installed in the path specified by installPath. This variable is not commonly used so that installPath can be used to specify the path in which to install both the component and the resource.
-
installDeployMode – Specifies whether to add files to the directory (ADD_TO) or replace the files in the directory (REPLACE). The default value is REPLACE.
Browsing
|
|
UNIX Systems |
Microsoft Windows Systems |
|---|---|---|
|
Root Path |
/ |
List of physical drives on the host or network are mapped to a drive letter. Removable media is not shown. |
|
Delimiter |
/ |
\ |
|
Ordering |
Alphabetical with directories appearing first |
|
|
Selection Type |
User can select a directory for check-in. Double click a directory to view its contents. |
|
|
Sample Path |
/foo/foo |
C:\foo\foo |
|
Filters |
None |
|
|
Special |
Links display their local name and the location pointed to: foo/->/usr/bar/ |
|
Extended Control Procedures
The following procedures are defined for the system#directory component type:
-
default install block – Deploys the contained file based on the state of the variables. No snapshots are captured.
-
markOnly install block – Marks the system to indicate that a new version of the component is installed. No resources are transferred, and no snapshots are captured.
-
default uninstall block – Undeploys the contained file from the location to which it was originally deployed.
-
markOnly uninstall block – Marks the system to indicate that the current version of the component has been uninstalled. The component's resources are not actually removed from the target host.
-
default snapshot block – Captures a snapshot of the deployed file. Because the default install block does not capture the file by default, container components must call this routine explicitly if you want a snapshot.
Component Type: system#symbolic link
The system#symbolic link component type represents a single symbolic link that is taken from a target server. The provisioning system deploys a symbolic link by creating a new link on the target server. The file that the symbolic link points to is taken from the value of the symlinkTarget variable. Any file that exists in the install location of the link is removed before the new symbolic link is created.
The system#symbolic link component type includes installation, uninstallation, and snapshot procedures. The uninstallation procedure removes the symbolic link, not the file to which it links. The snapshot procedure also captures the name of the file to which the symbolic link points, not to the file itself.
The system#symbolic link component type defines the following variables:
-
installName – The name to use for the resource when it is installed. The default value is the name of the component.
-
installPath – The path in which to install the resource. The default value is the value of the installPath variable of the container component.
-
symlinkTarget – The absolute path of the file to be linked to by this link. The default value is the file that was originally linked to by the file.
The following procedures are defined for the system#symbolic link component type:
-
defaultinstall block – Removes any file that previously existed in the install path and replaces it with a symbolic link that links to the value of the symlinkTarget variable. No snapshots are captured.
-
defaultuninstall block – Removes the deployed link without removing the file to which that it links.
-
default snapshot block – Captures a snapshot of the deployed link. Because the default install block does not capture the file by default, container components must call this routine explicitly if you want a snapshot. If you request a snapshot of a symbolic link, the path pointed to by the symbolic link is captured.
Browsing
|
|
UNIX Systems |
Microsoft Windows Systems |
|---|---|---|
|
Root Path |
/ |
List of physical drives on the host or network are mapped to a drive letter. Removable media is not shown. |
|
Delimiter |
/ |
\ |
|
Ordering |
Alphabetical with directories appearing first |
|
|
Selection Type |
User can select a file for check-in. Double click a directory to view its contents. Only symbolic link type files can be selected for check-in. |
|
|
Sample Path |
/foo/foo.txt |
C:\foo\foo.txt |
|
Special |
Links display their local name and the location pointed to: foo->/usr/bar |
|
Exported/Internal File Format
Symbolic links contain a resource that serves as a symbolic placeholder. Symbolic link data is stored as a set of variables, one for each name and location, in the component.
Component Type: system#container
A system#container component type should be used whenever components must be grouped together and installed as a single component. The container component has an install, uninstall, and snapshot block. These blocks automatically call in to the child components. These calls enable a container to have child components added directly by using the Component Builder user interface, without having to edit the container component's XML.
Browsing
The container component type is a composite component and cannot be browsed.
Model to Install Difference
This comparison optionally takes a snapshot of all child components.
The default snapshot block captures snapshots of all child components with installMode=“NESTED” by using the default snapshot blocks of each child.
Extended Control Procedures
The following procedures are defined for the system#container component type:
-
default install block – Installs only those child components that have installMode=“NESTED” set.
-
markOnly install block – Calls the markOnly install block of all the nested child components, then marks this component as installed.
-
default uninstall block – Uninstalls only those child components that have installMode=“NESTED” set.
-
markOnly uninstall block – Calls the markOnly uninstall block of all the nested child components, then marks this component as uninstalled.
-
default snapshot block – Captures a snapshot of all child components if createSnapshot is set to true. Only child components that have installMode=“NESTED” set are installed. By default, createSnapshot is set to false.
Snapshots are not always enabled. If the component is deployed as a nested component of another component, it should be deployed with createSnapshot=“false” because the container component will capture a snapshot of this component after all of its contained components have been deployed. If the component is being deployed as a top-level component, you can enable snapshots by setting createSnapshot=“true”.
Snapshots are not captured when a component is contained in a container component. The deployment of the other contained components after this component might affect the installed state of this component. Thus, the snapshot is captured after the top-level installations have completed.
Component Type: untyped
Components of type untyped extend from no base component and have no default behavior. They are intended for advanced edit use when custom types or XML is being added to the component and none of the default behaviors of the built-in types are relevant.
- © 2010, Oracle Corporation and/or its affiliates