Daniel David Parry > Apache-Sling-0.17 > Apache::Sling::UserUtil

Download:
Apache-Sling-0.17.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.17   Source   Latest Release: Apache-Sling-0.27

NAME ^

Apache::Sling::UserUtil - Methods to generate and check HTTP requests required for manipulating users.

ABSTRACT ^

Utility library returning strings representing Rest queries that perform user related actions in the system.

METHODS ^

add_setup

Returns a textual representation of the request needed to add the user to the system.

add_eval

Check result of adding user to the system.

change_password_setup

Returns a textual representation of the request needed to change the password of the user in the system.

change_password_eval

Verify whether the change password attempt for the user in the system was successful.

delete_setup

Returns a textual representation of the request needed to delete the user from the system.

delete_eval

Check result of deleting user from the system.

exists_setup

Returns a textual representation of the request needed to test whether a given username exists in the system.

exists_eval

Inspects the result returned from issuing the request generated in exists_setup returning true if the result indicates the username does exist in the system, else false.

sites_setup

Returns a textual representation of the request needed to return the list of sites the current user is a member of.

sites_eval

Inspects the result returned from issuing the request generated in sites_setup returning true if the result indicates information was returned successfully, else false.

update_setup

Returns a textual representation of the request needed to update the user in the system.

update_eval

Check result of updateing user to the system.

USAGE ^

use Apache::Sling::UserUtil;

DESCRIPTION ^

UserUtil perl library essentially provides the request strings needed to interact with user functionality exposed over the system rest interfaces.

Each interaction has a setup and eval method. setup provides the request, whilst eval interprets the response to give further information about the result of performing the request.

REQUIRED ARGUMENTS ^

None required.

OPTIONS ^

n/a

DIAGNOSTICS ^

n/a

EXIT STATUS ^

0 on success.

CONFIGURATION ^

None required.

DEPENDENCIES ^

INCOMPATIBILITIES ^

None known.

BUGS AND LIMITATIONS ^

None known.

AUTHOR ^

Daniel David Parry <perl@ddp.me.uk>

LICENSE AND COPYRIGHT ^

LICENSE: http://dev.perl.org/licenses/artistic.html

COPYRIGHT: (c) 2011 Daniel David Parry <perl@ddp.me.uk>

syntax highlighting: