The componentRef Element attributes (N1 Service Provisioning System 4.1 Reference Guide)

N1 Service Provisioning System 4.1 Reference Guide

The componentRef Element attributes

Name	Type	Required	Configurable	Description
modifier	modifierEnum	No	No	The modifier of the componentRef, as described below.
name	identifier	Yes	No	A local name for the referenced component. Must be unique among all sibling <componentRef> elements.
installMode	One of:· TOPLEVEL NESTED	No	No	The way in which the referenced component should be installed. If unspecified, NESTED is used by default.

Name

Type

Required

Configurable

Description

modifier

modifierEnum

The modifier of the componentRef, as described below.

name

identifier

Yes

A local name for the referenced component. Must be unique among all sibling <componentRef> elements.

installMode

One of:·

TOPLEVEL
NESTED

The way in which the referenced component should be installed. If unspecified, NESTED is used by default.

componentRef modifier Attribute

The "modifier" attribute of the <componentRef> element specifies the override requirements for the component reference.

If ABSTRACT, the component reference <component> element is omitted and must be specified by non-abstract derived components. Component references may only be declared abstract if the component is also declared abstract. Non-abstract component references must declare a <component> element.

If FINAL, the component reference may not be overridden by derived components.

If unspecified, then derived components can choose whether or not to override the component reference.

componentRef installMode Attribute

The installMode attribute of the <componentRef> element specifies the way in which the referenced component should be installed and targeted thereafter. If the referenced component is installed as TOPLEVEL, then it can be used by any other component just as if it had been directly installed by a plan. However, if the referenced component is installed as NESTED, then its installation is implicitly scoped to that of the referencing component, and its services are only available to the referencing component.

Logically, a nested referenced component defines a finer-grained unit of functionality required by the referencing component, but not otherwise useful to other components. Whereas a toplevel referenced component defines services that will be used by the referencing component, but may also be used by other components.

The lifetime of a nested referenced component is implicitly scoped to that of the referencing component. The nested referenced component can only be installed during the installation of the referencing component, and is implicitly uninstalled when the referencing component is uninstalled. In contrast, the lifetime of a toplevel referenced component is not tied to that of the referencing component in any way. The referencing component may install a toplevel referenced component when it is installed, or the referenced component have been installed previously or later by other means. When the referencing component is uninstalled, a toplevel referenced component will remain installed unless it is explicitly uninstalled by the referencing component. Other components are also free to uninstall it.