Sun Java System Portal Server 7.2 Command-Line Reference

`psadmin add-dp`

Description

Adds a new display profile object to the display profile.

Syntax

Long Format

psadmin add-dp [--parent parent] --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [--global] [--dry-run] dp-document

Short Format

psadmin add-dp [-P parent] -u uid -f password-filename -d dn -p portal-ID [-g] [-r] dp-document

Options

The following options are required:

[--adminuser | -u] uid: Specifies the administrator's distinguished name.
[--dn | -d] dn: Distinguished name of the target node. This is mutually exclusive to -g option.
[--passwordfile | -f] password-filename: Specifies the administrator's password in the password file.
[--portalId | -p] portal-ID: Specifies the portal ID, if this is not supplied, the default is used.

The following options are optional:

[--dry-run | -r]: Attempt to execute command without writing out to LDAP. Default is false.
[--global | -g]: Global display profile. Default is false. This is mutually exclusive to -d option.
[--parent | -P] parent: Name of the parent display object. If not specified , the object gets added to the root.

Operand

Specifies one or more files each of which contains XML fragment.

Example

Example 2–5 `psadmin add-dp`

./psadmin add-dp -u amadmin -f ps_password -P JSPTabContainer/bookmark2 -d "cn=hr_role,o=Developersample,dc=country,dc=sun,dc=com" -p myPortal1 add.xml

In the example above, a new channel, bookmark2 is added to the container, JSPTabContainer. The psadmin add-dp takes data for the new object from standard input or from one or more files specified as an argument to the command. Data for the new object must be XML and conform the Sun Java System Portal Server display profile DTD. It requires that the object to be added does not exist in the display profile.

The add.xml file contains the data for the channel bookmark2. The content of add.xml file is displayed below:

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">
<Channel name="bookmark3" provider="BookmarkProvider">
    <Properties>
    </Properties>
</Channel>

The semantics of the add subcommand vary depending on the type of the display profile object being added. That is:

Display profile: An entire display profile document can be added to the specified LDAP node. If the document already exists at the node, then an error is reported. The parent option must not be specified when adding a new display profile document.
Channel or container: A channel or container can be added. If the parent option is present, the parent display profile object is located for the given name and under that parent container, the specified Channel or Container is added. If the parent option is absent, the parent display profile object is assumed to be the root display profile object, so under root the specified Channel or Container object is added.
Properties: Because a properties bundle is required for all display profile nodes and display profile provider objects, they already exist and cannot be added. Use the modify subcommand.
Available or selected: Because Available and selected objects are required for a display profile container, they already exist and cannot be added. Use the modify subcommand.
String, Boolean, Integer, Collection, or Locale: The display profile object String, Boolean, Integer, Collection, or Locale properties can be added. The parent option must be specified to add display profile object properties of this type. Under the specified parent, a display profile node (either a channel or container) or display profile provider is searched for (in that order) that matches the name. If found, the given display profile property is added to the display profile node or display profile provider.
Provider: A display profile provider is inserted under the root node. Because providers can only exist under the root node, do not use the parent option. If an object of the same name already exists, then an error is reported.

psadmin add-dp