com.tsgrp.opencontent.core.user

Class RestUser

java.lang.Object

com.tsgrp.opencontent.rest.RESTService

com.tsgrp.opencontent.core.user.RestUser

@Controller
public class RestUser
extends RESTService

REST Endpoints for user/group info

Field Summary

Fields inherited from class com.tsgrp.opencontent.rest.RESTService

CHUNKSIZE, HEADER_ACCEPT_LANGUAGE, HEADER_ACCEPT_RANGES, HEADER_CACHE_CONTROL, HEADER_CONTENT_DISPOSITION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_RANGE, HEADER_CONTENT_TYPE, HEADER_ETAG, HEADER_IF_MODIFIED_SINCE, HEADER_LAST_MODIFIED, HEADER_LOCATION, HEADER_RANGE, HEADER_USER_AGENT, MULTIPART_BYTERANGES_BOUNDRY, MULTIPART_BYTERANGES_BOUNDRY_END, MULTIPART_BYTERANGES_BOUNDRY_SEP, MULTIPART_BYTERANGES_HEADER

Constructor Summary

Constructors

Constructor and Description
RestUser()

Method Summary

Modifier and Type	Method and Description
boolean	addUsersToGroup(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String groupName, java.lang.String[] users)
UserBean[]	allUsers(java.lang.String paramTicket, java.lang.String cookieTicket) Deprecated.
void	checkRecoveryCode(java.lang.String code, java.lang.String userName, java.lang.String password)
java.lang.String	createGroup(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String groupName)
OCUser	createUser(java.lang.String userName, java.lang.String firstName, java.lang.String lastName, java.lang.String email, java.lang.String displayName, java.lang.String password)
boolean	deleteUser(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String userToRemove)
UserResult	findAllUsersInGroup(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String[] groupNames) Deprecated.
UserResult	findGroupsWithUser(java.lang.String ticket, java.lang.String loginName) Deprecated.
UserResult	findUsersIngroups(java.lang.String paramTicket, java.lang.String cookieTicket, boolean recursive, java.lang.String group) Deprecated.
OCGroup[]	getAllGroups(java.lang.String paramTicket, java.lang.String cookieTicket)
OCUser	getAuthenticatedOcUser(java.lang.String paramTicket, java.lang.String cookieTicket)
OCAuthority[]	getChildAuthorities(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String group, java.lang.String authorityType, boolean recursive)
OCGroup	getGroup(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String group)
UserResult	getGroupDetails(java.lang.String ticket, java.lang.String[] groupNames) Deprecated.
UserBean	getUser(java.lang.String paramTicket, boolean failQuietly, java.lang.String cookieTicket, java.lang.String loginName, boolean includeGroups)
java.lang.String	getUserHomeDirectory(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String loginName)
boolean	isUserInGroup(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String userName, java.lang.String groupName)
OCAuthority[]	queryForGroups(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String searchTerm)
OCAuthority[]	queryForUsers(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String searchTerm)
java.lang.String	removeGroup(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String groupName)
boolean	removeUsersFrom(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String groupName, java.lang.String[] users)
OCAuthority[]	searchAuthorities(java.lang.String paramTicket, java.lang.String cookieTicket, OCAuthoritySearchCriteria criteria)
UserBean[]	searchUsersInGroup(java.lang.String ticket, java.lang.String group, java.lang.String searchTerm, boolean searchSubGroups) Deprecated.
boolean	updateUser(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String userName, java.lang.String displayName, java.lang.String email, java.lang.String password)
UserBean	userForgotPassword(java.lang.String userName)
boolean	userSetInboxProxy(java.lang.String paramTicket, java.lang.String cookieTicket, java.util.Map<java.lang.String,java.lang.String> userPrefs)

Methods inherited from class com.tsgrp.opencontent.rest.RESTService

contentNotProcessed, contentNotReady, genericException, notAuth, notFoundException, notSupported, objectLocked, ocConflict, ocConflict, ocForbidden, ocRuntimeException, resolveTicket

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestUser

public RestUser()

Method Detail

findUsersIngroups

@Deprecated
 @RequestMapping(value="/users/{group}",
                method=GET)
 @ResponseBody
public UserResult findUsersIngroups(@RequestParam(value="ticket",required=false)
                                                                                                                                        java.lang.String paramTicket,
                                                                                                                                        @CookieValue(value="ticket",required=false)
                                                                                                                                        java.lang.String cookieTicket,
                                                                                                                                        @RequestParam(value="recursive",required=false)
                                                                                                                                        boolean recursive,
                                                                                                                                        @PathVariable
                                                                                                                                        java.lang.String group)

Deprecated.

See Also:

IUser.findAllUsersInGroups(String, String[]), IUser.findAllUsersInGroupsRecursive(String, String[])

searchUsersInGroup

@Deprecated
 @RequestMapping(value="/users/searchUsersInGroup/{group}",
                method=GET)
 @ResponseBody
public UserBean[] searchUsersInGroup(@RequestParam
                                                                                                                                                            java.lang.String ticket,
                                                                                                                                                            @PathVariable
                                                                                                                                                            java.lang.String group,
                                                                                                                                                            @RequestParam(value="searchTerm")
                                                                                                                                                            java.lang.String searchTerm,
                                                                                                                                                            @RequestParam(value="searchSubGroups",required=false)
                                                                                                                                                            boolean searchSubGroups)

Deprecated.

See Also:

IUser.searchUsersInGroup(String, String, String, boolean)

queryForGroups

@RequestMapping(value="/users/queryForGroups",
                method=GET)
 @ResponseBody
public OCAuthority[] queryForGroups(@RequestParam(value="ticket",required=false)
                                                                                                                                 java.lang.String paramTicket,
                                                                                                                                 @CookieValue(value="ticket",required=false)
                                                                                                                                 java.lang.String cookieTicket,
                                                                                                                                 @RequestParam(value="query",required=false)
                                                                                                                                 java.lang.String searchTerm)

queryForUsers

@RequestMapping(value="/users/queryForUsers",
                method=GET)
 @ResponseBody
public OCAuthority[] queryForUsers(@RequestParam(value="ticket",required=false)
                                                                                                                               java.lang.String paramTicket,
                                                                                                                               @CookieValue(value="ticket",required=false)
                                                                                                                               java.lang.String cookieTicket,
                                                                                                                               @RequestParam(value="query",required=false)
                                                                                                                               java.lang.String searchTerm)

allUsers

@Deprecated
 @RequestMapping(value="/users/allUsers",
                method=GET)
 @ResponseBody
public UserBean[] allUsers(@RequestParam(value="ticket",required=false)
                                                                                                                                java.lang.String paramTicket,
                                                                                                                                @CookieValue(value="ticket",required=false)
                                                                                                                                java.lang.String cookieTicket)

Deprecated.

findGroupsWithUser

@Deprecated
 @RequestMapping(value="/users/findGroupsWithUser",
                method=GET)
 @ResponseBody
public UserResult findGroupsWithUser(@RequestParam
                                                                                                                                                    java.lang.String ticket,
                                                                                                                                                    @RequestParam(value="loginName",required=false)
                                                                                                                                                    java.lang.String loginName)

Deprecated.

findAllUsersInGroup

@Deprecated
 @RequestMapping(value="/users/findAllUsersInGroups",
                method=GET)
 @ResponseBody
public UserResult findAllUsersInGroup(@RequestParam(value="ticket",required=false)
                                                                                                                                                       java.lang.String paramTicket,
                                                                                                                                                       @CookieValue(value="ticket",required=false)
                                                                                                                                                       java.lang.String cookieTicket,
                                                                                                                                                       @RequestParam(value="groupNames",required=false)
                                                                                                                                                       java.lang.String[] groupNames)

Deprecated.

getGroupDetails

@Deprecated
 @RequestMapping(value="/users/getGroupDetails",
                method=GET)
 @ResponseBody
public UserResult getGroupDetails(@RequestParam
                                                                                                                                              java.lang.String ticket,
                                                                                                                                              @RequestParam(value="groupNames",required=false)
                                                                                                                                              java.lang.String[] groupNames)

Deprecated.

getUser

@RequestMapping(value="/users/user/{loginName}",
                method=GET)
 @ResponseBody
public UserBean getUser(@RequestParam(value="ticket",required=false)
                                                                                                                       java.lang.String paramTicket,
                                                                                                                       @RequestParam(value="failQuietly",required=false)
                                                                                                                       boolean failQuietly,
                                                                                                                       @CookieValue(value="ticket",required=false)
                                                                                                                       java.lang.String cookieTicket,
                                                                                                                       @PathVariable
                                                                                                                       java.lang.String loginName,
                                                                                                                       @RequestParam(required=false)
                                                                                                                       boolean includeGroups)

getUserHomeDirectory

@RequestMapping(value="/users/getUserHomeDirectory",
                method=GET)
 @ResponseBody
public java.lang.String getUserHomeDirectory(@RequestParam(value="ticket",required=false)
                                                                                                                                                java.lang.String paramTicket,
                                                                                                                                                @CookieValue(value="ticket",required=false)
                                                                                                                                                java.lang.String cookieTicket,
                                                                                                                                                @RequestParam(value="loginName",required=true)
                                                                                                                                                java.lang.String loginName)

getGroup

@RequestMapping(value="/groups/{group}",
                method=GET)
 @ResponseBody
public OCGroup getGroup(@RequestParam(value="ticket",required=false)
                                                                                                               java.lang.String paramTicket,
                                                                                                               @CookieValue(value="ticket",required=false)
                                                                                                               java.lang.String cookieTicket,
                                                                                                               @PathVariable
                                                                                                               java.lang.String group)

See Also:

IUser.getGroup(String, String)

getAllGroups

@RequestMapping(value="/groups",
                method=GET)
 @ResponseBody
public OCGroup[] getAllGroups(@RequestParam(value="ticket",required=false)
                                                                                                             java.lang.String paramTicket,
                                                                                                             @CookieValue(value="ticket",required=false)
                                                                                                             java.lang.String cookieTicket)

See Also:

IUser.getGroups(String, String, boolean)

getChildAuthorities

@RequestMapping(value="/groups/{group}/children",
                method=GET)
 @ResponseBody
public OCAuthority[] getChildAuthorities(@RequestParam(value="ticket",required=false)
                                                                                                                                         java.lang.String paramTicket,
                                                                                                                                         @CookieValue(value="ticket",required=false)
                                                                                                                                         java.lang.String cookieTicket,
                                                                                                                                         @PathVariable
                                                                                                                                         java.lang.String group,
                                                                                                                                         @RequestParam(value="authorityType",required=true)
                                                                                                                                         java.lang.String authorityType,
                                                                                                                                         @RequestParam(value="recursive",required=false)
                                                                                                                                         boolean recursive)

See Also:

IUser.getGroups(String, String, boolean)

searchAuthorities

@RequestMapping(value="/authorities/search",
                method=POST)
 @ResponseBody
public OCAuthority[] searchAuthorities(@RequestParam(value="ticket",required=false)
                                                                                                                                   java.lang.String paramTicket,
                                                                                                                                   @CookieValue(value="ticket",required=false)
                                                                                                                                   java.lang.String cookieTicket,
                                                                                                                                   @RequestBody
                                                                                                                                   OCAuthoritySearchCriteria criteria)

isUserInGroup

@RequestMapping(value="/authorities/isUserInGroup",
                method=GET)
 @ResponseBody
public boolean isUserInGroup(@RequestParam(value="ticket",required=false)
                                                                                                                               java.lang.String paramTicket,
                                                                                                                               @CookieValue(value="ticket",required=false)
                                                                                                                               java.lang.String cookieTicket,
                                                                                                                               @RequestParam(value="userName",required=true)
                                                                                                                               java.lang.String userName,
                                                                                                                               @RequestParam(value="groupName",required=true)
                                                                                                                               java.lang.String groupName)

userSetInboxProxy

@RequestMapping(value="/users/setInboxProxy",
                method=POST)
 @ResponseBody
public boolean userSetInboxProxy(@RequestParam(value="ticket",required=false)
                                                                                                                              java.lang.String paramTicket,
                                                                                                                              @CookieValue(value="ticket",required=false)
                                                                                                                              java.lang.String cookieTicket,
                                                                                                                              @RequestBody
                                                                                                                              java.util.Map<java.lang.String,java.lang.String> userPrefs)

createGroup

@RequestMapping(value="/users/createGroup",
                method=POST)
 @ResponseBody
public java.lang.String createGroup(@RequestParam(value="ticket",required=false)
                                                                                                                               java.lang.String paramTicket,
                                                                                                                               @CookieValue(value="ticket",required=false)
                                                                                                                               java.lang.String cookieTicket,
                                                                                                                               @RequestParam(value="groupName",required=false)
                                                                                                                               java.lang.String groupName)

removeGroup

@RequestMapping(value="/users/deleteGroup",
                method=POST)
 @ResponseBody
public java.lang.String removeGroup(@RequestParam(value="ticket",required=false)
                                                                                                                               java.lang.String paramTicket,
                                                                                                                               @CookieValue(value="ticket",required=false)
                                                                                                                               java.lang.String cookieTicket,
                                                                                                                               @RequestParam(value="groupName",required=false)
                                                                                                                               java.lang.String groupName)

addUsersToGroup

@RequestMapping(value="/users/addUsersToGroup",
                method=POST)
 @ResponseBody
public boolean addUsersToGroup(@RequestParam(value="ticket",required=false)
                                                                                                                              java.lang.String paramTicket,
                                                                                                                              @CookieValue(value="ticket",required=false)
                                                                                                                              java.lang.String cookieTicket,
                                                                                                                              @RequestParam(value="groupName",required=true)
                                                                                                                              java.lang.String groupName,
                                                                                                                              @RequestBody
                                                                                                                              java.lang.String[] users)

removeUsersFrom

@RequestMapping(value="/users/removeUsersFromGroup",
                method=POST)
 @ResponseBody
public boolean removeUsersFrom(@RequestParam(value="ticket",required=false)
                                                                                                                                   java.lang.String paramTicket,
                                                                                                                                   @CookieValue(value="ticket",required=false)
                                                                                                                                   java.lang.String cookieTicket,
                                                                                                                                   @RequestParam(value="groupName",required=true)
                                                                                                                                   java.lang.String groupName,
                                                                                                                                   @RequestBody
                                                                                                                                   java.lang.String[] users)

createUser

@RequestMapping(value="/users/createUser",
                method=POST)
 @ResponseBody
public OCUser createUser(@RequestParam(value="userName",required=false)
                                                                                                                   java.lang.String userName,
                                                                                                                   @RequestParam(value="firstName",required=false)
                                                                                                                   java.lang.String firstName,
                                                                                                                   @RequestParam(value="lastName",required=false)
                                                                                                                   java.lang.String lastName,
                                                                                                                   @RequestParam(value="email",required=false)
                                                                                                                   java.lang.String email,
                                                                                                                   @RequestParam(value="displayName",required=false)
                                                                                                                   java.lang.String displayName,
                                                                                                                   @RequestParam(value="password",required=false)
                                                                                                                   java.lang.String password)

deleteUser

@RequestMapping(value="/users/deleteUser",
                method=POST)
 @ResponseBody
public boolean deleteUser(@RequestParam(value="ticket",required=false)
                                                                                                                    java.lang.String paramTicket,
                                                                                                                    @CookieValue(value="ticket",required=false)
                                                                                                                    java.lang.String cookieTicket,
                                                                                                                    @RequestParam(value="userToRemove",required=false)
                                                                                                                    java.lang.String userToRemove)

updateUser

@RequestMapping(value="/users/updateUser",
                method=POST)
 @ResponseBody
public boolean updateUser(@RequestParam(value="ticket",required=false)
                                                                                                                    java.lang.String paramTicket,
                                                                                                                    @CookieValue(value="ticket",required=false)
                                                                                                                    java.lang.String cookieTicket,
                                                                                                                    @RequestParam(value="userName",required=false)
                                                                                                                    java.lang.String userName,
                                                                                                                    @RequestParam(value="displayName",required=false)
                                                                                                                    java.lang.String displayName,
                                                                                                                    @RequestParam(value="email",required=false)
                                                                                                                    java.lang.String email,
                                                                                                                    @RequestParam(value="password",required=false)
                                                                                                                    java.lang.String password)

userForgotPassword

@RequestMapping(value="/users/userForgotPassword",
                method=POST)
 @ResponseBody
public UserBean userForgotPassword(@RequestParam(value="userName",required=false)
                                                                                                                                     java.lang.String userName)

checkRecoveryCode

@RequestMapping(value="/users/checkRecoveryCode",
                method=POST)
 @ResponseBody
public void checkRecoveryCode(@RequestParam(value="code",required=false)
                                                                                                                               java.lang.String code,
                                                                                                                               @RequestParam(value="userName",required=false)
                                                                                                                               java.lang.String userName,
                                                                                                                               @RequestParam(value="password",required=false)
                                                                                                                               java.lang.String password)

getAuthenticatedOcUser

@RequestMapping(value="/users/getAuthenticatedUser",
                method=GET)
 @ResponseBody
public OCUser getAuthenticatedOcUser(@RequestParam(value="ticket",required=false)
                                                                                                                                        java.lang.String paramTicket,
                                                                                                                                        @CookieValue(value="ticket",required=false)
                                                                                                                                        java.lang.String cookieTicket)