Package org.exoplatform.portal.rest

Class UserRestResourcesV1

java.lang.Object

org.exoplatform.portal.rest.UserRestResourcesV1

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class UserRestResourcesV1
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_PASSWORD_NOT_ALLOWED
static final String	CREATION_SOURCE_UI
static final int	DEFAULT_LIMIT
static final UserFieldValidator	EMAIL_VALIDATOR
static final UserFieldValidator	FIRSTNAME_VALIDATOR
static final UserFieldValidator	LASTNAME_VALIDATOR
static final String	OTP_CODE_INVALID
static final String	PASSWORD_UNKNOWN_ERROR_CODE
static final UserFieldValidator	PASSWORD_VALIDATOR
static final String	UNCHANGED_NEW_PASSWORD_ERROR_CODE
static final String	USER_NOT_FOUND_ERROR_CODE
static final UserFieldValidator	USERNAME_VALIDATOR
static final String	WRONG_USER_PASSWORD_ERROR_CODE

Constructor Summary

Constructors

Constructor	Description
UserRestResourcesV1(org.exoplatform.services.organization.OrganizationService organizationService, org.exoplatform.services.organization.search.UserSearchService userSearchService, UserACL userACL, org.exoplatform.web.login.recovery.PasswordRecoveryService passwordRecoveryService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	changePassword(jakarta.servlet.http.HttpServletRequest request, String username, String currentPassword, String newPassword)
javax.ws.rs.core.Response	confirmSession(jakarta.servlet.http.HttpServletRequest request, String otpCode)
javax.ws.rs.core.Response	createUser(jakarta.servlet.http.HttpServletRequest request, UserRestEntity userEntity)
javax.ws.rs.core.Response	deleteUser(jakarta.servlet.http.HttpServletRequest request, String userName)
static String	getCurrentUsername()
javax.ws.rs.core.Response	getOnboardingSettings()
javax.ws.rs.core.Response	getUser(javax.ws.rs.core.UriInfo uriInfo, String id)
javax.ws.rs.core.Response	getUserMemberships(String userName, String groupId, boolean includeNestedGroups, int offset, int limit, boolean returnSize)
javax.ws.rs.core.Response	getUsers(String q, String status, int offset, int limit, boolean returnSize)
boolean	isMemberOfAdminGroup()
javax.ws.rs.core.Response	isSuperUser()
javax.ws.rs.core.Response	isSynchronizedUserAllowedToChangePassword(javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	updateUser(jakarta.servlet.http.HttpServletRequest request, UserRestEntity userEntity)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

• Constant Field Values

PASSWORD_UNKNOWN_ERROR_CODE

public static final String PASSWORD_UNKNOWN_ERROR_CODE

See Also:

• Constant Field Values

USER_NOT_FOUND_ERROR_CODE

public static final String USER_NOT_FOUND_ERROR_CODE

See Also:

• Constant Field Values

WRONG_USER_PASSWORD_ERROR_CODE

public static final String WRONG_USER_PASSWORD_ERROR_CODE

See Also:

• Constant Field Values

CHANGE_PASSWORD_NOT_ALLOWED

public static final String CHANGE_PASSWORD_NOT_ALLOWED

See Also:

• Constant Field Values

UNCHANGED_NEW_PASSWORD_ERROR_CODE

public static final String UNCHANGED_NEW_PASSWORD_ERROR_CODE

See Also:

• Constant Field Values

CREATION_SOURCE_UI

public static final String CREATION_SOURCE_UI

See Also:

• Constant Field Values

OTP_CODE_INVALID

public static final String OTP_CODE_INVALID

See Also:

• Constant Field Values

USERNAME_VALIDATOR

public static final UserFieldValidator USERNAME_VALIDATOR

EMAIL_VALIDATOR

public static final UserFieldValidator EMAIL_VALIDATOR

LASTNAME_VALIDATOR

public static final UserFieldValidator LASTNAME_VALIDATOR

FIRSTNAME_VALIDATOR

public static final UserFieldValidator FIRSTNAME_VALIDATOR

PASSWORD_VALIDATOR

public static final UserFieldValidator PASSWORD_VALIDATOR

Constructor Details

UserRestResourcesV1

public UserRestResourcesV1(org.exoplatform.services.organization.OrganizationService organizationService,
 org.exoplatform.services.organization.search.UserSearchService userSearchService,
 UserACL userACL,
 org.exoplatform.web.login.recovery.PasswordRecoveryService passwordRecoveryService)

Method Details

getUsers

@RolesAllowed("administrators")
public javax.ws.rs.core.Response getUsers(String q,
 String status,
 int offset,
 int limit,
 boolean returnSize)
                                   throws Exception

Throws:

Exception

createUser

@RolesAllowed("administrators")
public javax.ws.rs.core.Response createUser(@Context
 jakarta.servlet.http.HttpServletRequest request,
 UserRestEntity userEntity)
                                     throws Exception

Throws:

Exception

getOnboardingSettings

@RolesAllowed("administrators")
public javax.ws.rs.core.Response getOnboardingSettings()

updateUser

@RolesAllowed("users")
public javax.ws.rs.core.Response updateUser(@Context
 jakarta.servlet.http.HttpServletRequest request,
 UserRestEntity userEntity)
                                     throws Exception

Throws:

Exception

deleteUser

@RolesAllowed("administrators")
public javax.ws.rs.core.Response deleteUser(@Context
 jakarta.servlet.http.HttpServletRequest request,
 String userName)
                                     throws Exception

Throws:

Exception

getUser

@RolesAllowed("users")
public javax.ws.rs.core.Response getUser(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String id)
                                  throws Exception

Throws:

Exception

changePassword

@RolesAllowed("users")
public javax.ws.rs.core.Response changePassword(@Context
 jakarta.servlet.http.HttpServletRequest request,
 String username,
 String currentPassword,
 String newPassword)

confirmSession

@RolesAllowed("users")
public javax.ws.rs.core.Response confirmSession(@Context
 jakarta.servlet.http.HttpServletRequest request,
 String otpCode)

getUserMemberships

@RolesAllowed("users")
public javax.ws.rs.core.Response getUserMemberships(String userName,
 String groupId,
 boolean includeNestedGroups,
 int offset,
 int limit,
 boolean returnSize)
                                             throws Exception

Throws:

Exception

isSuperUser

@RolesAllowed("users")
public javax.ws.rs.core.Response isSuperUser()

isSynchronizedUserAllowedToChangePassword

@RolesAllowed("users")
public javax.ws.rs.core.Response isSynchronizedUserAllowedToChangePassword(@Context
 javax.ws.rs.core.UriInfo uriInfo)
                                                                    throws Exception

Throws:

Exception

getCurrentUsername

public static String getCurrentUsername()

isMemberOfAdminGroup

public boolean isMemberOfAdminGroup()