Chapter 18 WSRP Consumer Subcommands

This supplement contains the following:

• psadmin list-attributes

• psadmin get-attribute

• psadmin set-attribute

• psadmin list-configured-producers

• psadmin create-configured-producer

• psadmin delete-configured-producer

• psadmin update-configured-producer-service-description

• psadmin search-registry

psadmin list-attributes

Description

List the attributes for a Consumer.

Syntax

Long Format

psadmin list-attributes --adminuser uid --passwordfile password-filename --component consumer --portal portal-ID [--configuredproducer]

Short Format

psadmin list-attributes -u uid -f password-filename -m consumer -p portal-ID [-R]

Options

The following options are required:

[--component | -m] consumer

Specifies the name of the component. The value should be consumer.

[--portal | -p] portal-ID

Specifies the portal ID.

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

The following option is optional:

[--configuredproducer | -R]

Specifies that this is for a configured producer.

psadmin get-attribute

Description

Display the value of an attribute for a Consumer.

Syntax

Long Format

psadmin get-attribute --component consumer --portal portal-ID --attribute-name attribute-name --adminuser uid --passwordfile password-filename [--dn organization-DN] [--producer producer-id ]]

Short Format

psadmin get-attribute -m consumer -p portal-ID -a attribute-name -u uid -f password-filename [-d organization-DN] [-l producer-id]]

Options

The following options are required:

[--component | -m] consumer

Specifies the name of the component. Value should be consumer.

[--attribute-name | -a] attribute-name

Specifies the name of the Consumer attribute for which the value is to be retrieved.

Attributes for the Consumer can be:

• AllDisabled ("true" or "false", global attribute)

• UserProfileMapping

• Name

Attributes for the Configured Producers can be:

• Name

• Enabled ("true" or "false")

• WSDL_URL

• UserCategoryMapping

• RegistrationProperties

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--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:

[--dn | -d] organization-DN

Specifies the distinguished name for the organization from where the attributes are to be listed.

[--producer | -l] producer-id

Specifies the ID of the configured producer to fetch the attribute for.

psadmin set-attribute

Description

Set the value of an attribute for a Consumer.

Syntax

Long Format

psadmin set-attribute --component consumer --portal portal-ID --attribute-name attribute-name --adminuser uid --passwordfile password-filename [--dn organization-DN] [--producer producer-id ] [--add] [--remove] values

Short Format

psadmin set-attribute -m consumer -p portal-ID -a attribute-name -u uid -f password-filename [-d organization-DN] [-l producer-id] [-A] [ -E] values

Options

The following options are required:

[--component | -m] consumer

Specifies the name of the component. Value should be consumer.

[--attribute-name | -a] attribute-name

Specifies the name of the Consumer attribute for which the value is to be retrieved.

Attributes for the Consumer can be:

• AllDisabled ("true" or "false", global attribute)

• UserProfileMapping

• Name

Attributes for the Configured Producers can be:

• Name

• Enabled ("true" or "false")

• WSDL_URL

• UserCategoryMapping

• RegistrationProperties

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--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:

[--dn | -d] organization-DN

Specifies the distinguished name for the organization from where the attributes are to be listed.

[--producer | -l] producer-id

Specifies the ID of the configured producer to fetch the attribute for.

[--add | -A][--remove | -E] values

Specifies the values to be added or removed.

psadmin list-configured-producers

Description

List the configured Producers at a Consumer.

Syntax

Long Format

psadmin list-configured-producers --portal portal-ID --dn organization-DN --adminuser uid --passwordfile password-filename [--output output-filename]

Short Format

psadmin list-configured-producers -p portal-ID -d organization-DN -u uid -f password-filename [-o output-filename]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--dn | -d] organization-DN

Specifies the distinguished name for the organization from where the attributes are to be listed.

[--portal | -p] portal-ID

Specifies the portal ID.

The following option is optional:

[--output | -o] output-filename

Specifies the file to output the result of the command.

psadmin create-configured-producer

Description

Create a new configured Producer at a Consumer.

Syntax

Long Format

psadmin create-configured-producer --portal portal-ID --adminuser uid --passwordfile password-filename --dn organization-DN --producer producer-name --url producer-URL [--registrationdata file | --registrationhandle handle]

Short Format

psadmin create-configured-producer -p portal-ID -u uid -f password-filename -d organization-DN -N producer-name -Z producer-URL [-x file | -H handle]

Options

The following options are required:

[--producer | -N] producer-name

Specifies the name to assign to the Producer being created.

[--url | -Z] producer-URL

Specifies the URL of the Producer to be configured.

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--dn | -d] organization-DN

Specifies the distinguished name for the organization from where the attributes are to be listed.

[--portal | -p] portal-ID

Specifies the portal ID.

The following options are optional:

[--registrationdata | -x] filename

Specifies the properties filename that will contain the registration properties for the producer being configured.

[--registrationhandle | -H] handle

Specifies the registration handle of the Producer being configured.

psadmin delete-configured-producer

Description

Delete a configured Producer at a Consumer.

Syntax

Long Format

psadmin delete-configured-producer --adminuser uid --passwordfile password-filename --dn organization-DN --portal portal-ID --producer producer-id

Short Format

psadmin delete-configured-producer -u uid -f password-filename -d organization-DN -p portal-ID -l producer-id

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] organization-DN

Specifies the distinguished name for the organization from where the attributes are to be listed.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.

[--producer | -l] producer-id

Specifies the ID of the configured producers that are to be deleted.

psadmin update-configured-producer-service-description

Description

Update the service description for a configured Producer in a Consumer.

Syntax

Long Format

psadmin update-configured-producer-service-description --adminuser uid --passwordfile password-filename --dn organization-DN --portal portal-ID --producer producer-id

Short Format

psadmin update-configured-producer-service-description -u uid -f password-filename -d organization-DN -p portal-ID -l producer-id

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] organization-DN

Specifies the distinguished name for the organization from where the attributes are to be listed.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.

[--producer | -l] producer-id

Specifies the ID of the configured Producer to update the Service Description for.

psadmin search-registry

Description

Searches for WSRP artifacts in the ebXML repository. For generic search, use wildcard; for example:

**organization.name =%
organization.description=%

This retrieves all the records from Registry Server. Otherwise, exact name should be given to get particular data.

Syntax

Long Format

psadmin search-registry --component consumer --adminuser uid --passwordfile password-filename --portal portal-ID [--searchproducerdatafile file | --searchportletdatafile file | --searchorgdatafile file]

Short Format

psadmin search-registry -m consumer -u uid -f password-filename -p portal-ID [-C file | -D file | -L file]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--component | -m] consumer

Specifies the name of the component. Value should be consumer.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portalid

Specifies the portal ID.

The following options are optional:

[--searchorgdatafile | -L] file

Specifies the name of the file that contains the attributes to be searched for while searching for Organization that offers WSRP service. Contents of the file include:

• organization.name =acme

• organization.description=news - Wildcard search

[--searchportletsdatafile | -D] file

Specifies the name of the file that contains the attributes to be searched for while searching for WSRP Portlets. Contents of the file include:

• portlet.name =ACME Portlet

• portlet.description=news * - Wildcard search

[--searchproducerdatafile | -C] file

Specifies the name of the file that contains the attributes to be searched for while searching for WSRP Producer. Contents of the file include:

• producer.name =ACME Producer - Wildcard search

• producer.description=stocks* - Wildcard search