N1 Grid Service Provisioning System 5.0 Plan and Component Developer's Guide

Secondary Component Expansion

Nested Component Expansion

A nested-component specifies the component that is referenced by a nested component reference that is declared by the current component. It has the component resolution semantics of the <nestedRef> installed component targeter. See Installed Component Targeters in N1 Grid Service Provisioning System 5.0 XML Schema Reference Guide.

nested-component has the following syntax:


nestedRef:component-reference-name

component-reference-name is the name of a <componentRef> element where installMode=NESTED for the current component.

nested-component can only be used when the current component is a composite component. It can only be used as a primary-component when the external component substitution reference appears in a composite component. When used as a primary-component, it cannot be used as the default value of a component variable or override variable setting. This is because the referenced component will not yet have been installed when the variable is evaluated.

Top-Level Component Expansion

A toplevel-component specifies the component that is referenced by a top-level component reference that is declared by the current component. It has the component resolution semantics of the <toplevelRef> installed component targeter. See Installed Component Targeters in N1 Grid Service Provisioning System 5.0 XML Schema Reference Guide.

toplevel-component has the following syntax:


toplevelRef:component-reference-name
toplevelRef:component-reference-name@{path}
toplevelRef(host-redirect):component-reference-name
toplevelRef(host-redirect):component-reference-name@{path}

component-reference-name is the name of a <componentRef> element where installMode=TOPLEVEL for the current component.

path is the absolute install path name of the specified component, or a substitution variable reference. The reference, when expanded, represents the absolute install path of the specified component. If path includes the } character, it must be escaped using the }} sequence.

host-redirect is the host on which the referenced component is expected to be installed. The syntax for host-redirect is described in Host Redirects.

toplevel-component can only be used when the current component is a composite component. It can only be used as a primary-component when the external component substitution reference appears in a composite component. When used as a primary-component, it cannot be used as the default value of a component variable or an override variable setting. This is because the referenced component has already been installed.

Dependee Component Expansion

A dependee-component specifies the component on which the current component depends as a result of a dependency created by a <createDependency> step. dependee-component has the component resolution semantics of the <dependee> installed component targeter. See Installed Component Targeters in N1 Grid Service Provisioning System 5.0 XML Schema Reference Guide.

dependee-component has the following syntax:


dependee:dependency-name

dependency-name is the name of a dependency that is created by the current component.

dependee-component can only be used as a primary-component when the external component substitution reference appears in a component. When used as a primary-component, it cannot be used as the default value of a component variable or an override variable setting. This is because the dependency will not yet have been created when the variable is evaluated.

Container Component Expansion

A container-component specifies the component that contains the current component as a nested reference.

container-component has the following syntax:


container

container-component can only be used as a primary-component when the external component substitution reference appears in a component that has been installed as a nested component by another “container” component.