You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by "Mikko Wuokko (JIRA)" <je...@portals.apache.org> on 2007/05/11 12:13:15 UTC
[jira] Updated: (JS2-685) Add functionality to AJAX API to
information about users
[ https://issues.apache.org/jira/browse/JS2-685?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mikko Wuokko updated JS2-685:
-----------------------------
Attachment: jetspeed-user-ajax-api-xdocs-and-update.patch
Wrote some xdocs for the new APIs and added a feature for the "getuserlist" API to modify the protection level for the SecurityBehavior. The new constructor parameter protectionScope can have values of "all", "private-offline," "private" (default) and "none". If set to all, the api will return just failure unless the SecurityBehaviour will grant access. If set to "private-offline", the basic info of online users and guest session count will be shown to everyone, but the extended userinfo only to priviledged users. The "private" is the same, but will include the offline users too. If set to "none", everything will be shown to every, which might not be wise, though, on a production server.
I added that extra feature so that the online userinfo can be used for example in user status portlets.
> Add functionality to AJAX API to information about users
> --------------------------------------------------------
>
> Key: JS2-685
> URL: https://issues.apache.org/jira/browse/JS2-685
> Project: Jetspeed 2
> Issue Type: Improvement
> Components: Ajax
> Affects Versions: 2.1.1
> Environment: Any
> Reporter: Mikko Wuokko
> Assigned To: David Sean Taylor
> Priority: Minor
> Fix For: 2.1.1
>
> Attachments: jetspeed-user-ajax-api-xdocs-and-update.patch, jetspeed_userinfo_ajax_api.patch
>
>
> In the patch there are two Jetspeed AJAX API actions; getuserinfo and getuserlist.
> Action getuserinfo:
> action: getuserinfo
> params: none
> This AJAX API action will retreave information about the currently logged in user. If user if not logged in, status failure is returned. It will return this information:
> - username
> - principal class
> - full list of user information (names, email, etc...)
> Here's an example output:
> <js>
> <status>success</status>
> <action>userinformation</action>
> <username>admin</username>
> <type>org.apache.jetspeed.security.impl.UserPrincipalImpl</type>
> <userinfo>
> <user.name.given>Test Dude</user.name.given>
> <user.name.family>Dudley</user.name.family>
> </userinfo>
> </js>
> Action getuserlist:
> This action will return a list of currently logged in users with username and ipaddress and optionally offline users, userinformation and number of guest sessions.
> action: getuserlist
> guest: true | false (default) ; return number of guest sessions
> userinfo: true | false (default); return full userinformation if available
> offline: true | false (default); return list of offline users
> all: true | false (default); return everything
> Here's an example output with all set to true:
> <js>
> <status>success</status>
> <action>getuserlist</action>
> <users>
> <user>
> <username>admin</username>
> <sessions>1</sessions>
> <status>online</status>
> <ipaddress>127.0.0.1</ipaddress>
> <userinfo>
> <user.name.given>Test Dude</user.name.given>
> <user.name.family>Dudley</user.name.family>
> </userinfo>
> </user>
> <user>
> <username>user</username>
> <status>offline</status>
> </user>
> <guests>0</guests>
> </users>
> </js>
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org