Chapter 17 Support for JCAPS Applications

This chapter describes the subcommands to register or unregister portlets present in an EAR file. Registration creates Display Profile entries for all portlet applications packaged in an EAR file, after the EAR file has been deployed to the underlying Application Server. Unregistration removes Display Profile entries for all portlet applications packaged in an EAR file.

This feature works only with EAR files generated by JCAPS tools, because the EAR files need Sun Portal proprietary artifacts inserted in them for this feature to work.

This chapter describes the following subcommands:

• psadmin register-portlet

• psadmin unregister-portlet

psadmin register-portlet

Description

Registers all portlet applications packaged in an EAR file. This feature works only with EAR files generated by JCAPS tools, because the EAR files need Sun Portal proprietary artifacts inserted in them for this feature to work.

Syntax

Long Format

psadmin register-portlet --adminuser uid --passwordfile password-filename --dn dn | --global [--rolesfile roles-file] [--userinfofile user-info-file] --portal portal-ID portletearfile

Short Format

psadmin register-portlet -u uid -fpasswordfile -d [-r roles-file] [-n user-info-file] -p portal-ID portletearfile

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] dn

Specifies the distinguished name in the LDAP node to access the Display Profile document. The -d or -g option is required.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.

The following options are optional:

[--global | -g]

Specifies the global level node in LDAP to access the display profile document. The -d or -g option is required.

[--rolesfile | -r] roles-file

Specifies the file containing the Access Manager software and portlet application role mapping information.

[--userinfofile | -n] user-info-file

Specifies the file containing the user information mapping information.

The following is the operand:

portletearfile

Specifies the path to the EAR file.

The following is the usage:

psadmin register-portlet -u amadmin -f pfile -p portal1 -g /tmp/helloworld.ear

In the example provided above, all portlet applications in helloworld.ear are registered at the Global level.

psadmin register-portlet -u amadmin -f pfile -p portal1 -d o=DeveloperSample,dc=sun,dc=com --rolesfile temp/rolefile -g myejbapp.ear

In the example provided above, all portlet applications in myejbapp.ear are registered at the DeveloperSample node. A role mapping file is also specified.

psadmin unregister-portlet

Description

This command unregisters all portlet applications packaged in a EAR file. This feature works only for EAR files that have been already registered using the psadmin register-portlet command.

Syntax

Long Format

psadmin unregister-portlet --adminuser uid --passwordfile password-filename --dn dn | --global --portal portal-ID portletearapp

Short Format

psadmin unregister-portlet -u uid -f passwordfile -d -p portal-ID portletearapp

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] dn

Specifies the distinguished name in the LDAP node to access the Display Profile document. The -d or -g option is required.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.

The following options are optional:

[--global | -g]

Specifies the global level node in LDAP to access the display profile document. The -d or -g option is required.

The following is the operand:

portletearapp

Name of the EAR application that needs to be unregistered.

The following is the usage:

psadmin unregister-portlet -u amadmin -f pfile -p portal1 -g helloworld

In the example provided above, all portlet applications in helloworld.ear are unregistered from the Global level.

psadmin unregister-portlet -u amadmin -f pfile -p portal1 -d o=DeveloperSample,dc=sun,dc=com --rolesfile /tmp/rolesfile -g /export/home/myejbapp

In the example provided above, all portlet applications in myejbapp.ear are unregistered from the DeveloperSample node. A role mapping file is also specified.