Minor Description
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>