Examples with ErrorVO org.olat.restapi.support.vo.ErrorVO used on opensource projects

Example 16 with ErrorVO

use of org.olat.restapi.support.vo.ErrorVO in project openolat by klemens.

the class UserWebService method update.

/**
 * Update an user
 * @response.representation.qname {http://www.example.com}userVO
 * @response.representation.mediaType application/xml, application/json
 * @response.representation.doc The user
 * @response.representation.example {@link org.olat.user.restapi.Examples#SAMPLE_USERVO}
 * @response.representation.200.qname {http://www.example.com}userVO
 * @response.representation.200.mediaType application/xml, application/json
 * @response.representation.200.doc The user
 * @response.representation.200.example {@link org.olat.user.restapi.Examples#SAMPLE_USERVO}
 * @response.representation.401.doc The roles of the authenticated user are not sufficient
 * @response.representation.404.doc The identity not found
 * @response.representation.406.qname {http://www.example.com}errorVO
 * @response.representation.406.mediaType application/xml, application/json
 * @response.representation.406.doc The list of validation errors
 * @response.representation.406.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_ERRORVOes}
 * @param identityKey The user key identifier
 * @param user The user datas
 * @param request The HTTP request
 * @return <code>User</code> object. The operation status (success or fail)
 */
@POST
@Path("{identityKey}")
@Consumes({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response update(@PathParam("identityKey") Long identityKey, UserVO user, @Context HttpServletRequest request) {
    try {
        if (user == null) {
            return Response.serverError().status(Status.NO_CONTENT).build();
        }
        if (!isUserManager(request)) {
            return Response.serverError().status(Status.UNAUTHORIZED).build();
        }
        BaseSecurity baseSecurity = BaseSecurityManager.getInstance();
        Identity retrievedIdentity = baseSecurity.loadIdentityByKey(identityKey, false);
        if (retrievedIdentity == null) {
            return Response.serverError().status(Status.NOT_FOUND).build();
        }
        User retrievedUser = retrievedIdentity.getUser();
        List<ErrorVO> errors = validateUser(retrievedUser, user, request);
        if (errors.isEmpty()) {
            if (StringHelper.containsNonWhitespace(user.getExternalId()) && !user.getExternalId().equals(retrievedIdentity.getExternalId())) {
                retrievedIdentity = baseSecurity.setExternalId(retrievedIdentity, user.getExternalId());
                retrievedUser = retrievedIdentity.getUser();
            }
            String oldEmail = retrievedUser.getEmail();
            post(retrievedUser, user, getLocale(request));
            UserManager.getInstance().updateUser(retrievedUser);
            BaseSecurityManager.getInstance().deleteInvalidAuthenticationsByEmail(oldEmail);
            return Response.ok(get(retrievedIdentity, true, true)).build();
        }
        // content not ok
        ErrorVO[] errorVos = new ErrorVO[errors.size()];
        errors.toArray(errorVos);
        return Response.ok(errorVos).status(Status.NOT_ACCEPTABLE).build();
    } catch (Exception e) {
        log.error("Error updating an user", e);
        return Response.serverError().status(Status.INTERNAL_SERVER_ERROR).build();
    }
}

Example 17 with ErrorVO

use of org.olat.restapi.support.vo.ErrorVO in project openolat by klemens.

the class UserWebService method validateProperty.

private boolean validateProperty(User user, String value, UserPropertyHandler userPropertyHandler, List<ErrorVO> errors, UserManager um, Locale locale) {
    ValidationError error = new ValidationError();
    if (!StringHelper.containsNonWhitespace(value) && um.isMandatoryUserProperty(PROPERTY_HANDLER_IDENTIFIER, userPropertyHandler)) {
        Translator translator = new PackageTranslator("org.olat.core", locale);
        String translation = translator.translate("new.form.mandatory");
        errors.add(new ErrorVO("org.olat.core:new.form.mandatory:" + userPropertyHandler.getName(), translation));
        return false;
    }
    value = parseUserProperty(value, userPropertyHandler, locale);
    if (!userPropertyHandler.isValidValue(user, value, error, locale)) {
        String pack = userPropertyHandler.getClass().getPackage().getName();
        Translator translator = new PackageTranslator(pack, locale);
        String translation = translator.translate(error.getErrorKey(), error.getArgs());
        errors.add(new ErrorVO(pack, error.getErrorKey(), translation));
        return false;
    } else if ((userPropertyHandler.getName().equals(UserConstants.INSTITUTIONALEMAIL) && StringHelper.containsNonWhitespace(value)) || userPropertyHandler.getName().equals(UserConstants.EMAIL)) {
        if (!UserManager.getInstance().isEmailAllowed(value, user)) {
            String pack = userPropertyHandler.getClass().getPackage().getName();
            Translator translator = new PackageTranslator(pack, locale);
            String translation = translator.translate("form.name." + userPropertyHandler.getName() + ".error.exists", new String[] { value });
            translation += " (" + value + ")";
            errors.add(new ErrorVO("org.olat.user.propertyhandlers:new.form.name." + userPropertyHandler.getName() + ".exists", translation));
        }
    }
    return true;
}

Example 18 with ErrorVO

use of org.olat.restapi.support.vo.ErrorVO in project openolat by klemens.

the class UserWebService method create.

/**
 * Creates and persists a new user entity
 * @response.representation.qname {http://www.example.com}userVO
 * @response.representation.mediaType application/xml, application/json
 * @response.representation.doc The user to persist
 * @response.representation.example {@link org.olat.user.restapi.Examples#SAMPLE_USERVO}
 * @response.representation.200.mediaType application/xml, application/json
 * @response.representation.200.doc The persisted user
 * @response.representation.200.example {@link org.olat.user.restapi.Examples#SAMPLE_USERVO}
 * @response.representation.401.doc The roles of the authenticated user are not sufficient
 * @response.representation.406.mediaType application/xml, application/json
 * @response.representation.406.doc The list of errors
 * @response.representation.406.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_ERRORVOes}
 * @param user The user to persist
 * @param request The HTTP request
 * @return the new persisted <code>User</code>
 */
@PUT
@Consumes({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response create(UserVO user, @Context HttpServletRequest request) {
    if (!isUserManager(request)) {
        return Response.serverError().status(Status.UNAUTHORIZED).build();
    }
    // Check if login is still available
    Identity identity = BaseSecurityManager.getInstance().findIdentityByName(user.getLogin());
    if (identity != null) {
        Locale locale = getLocale(request);
        Translator translator = Util.createPackageTranslator(UserShortDescription.class, locale);
        String translation = translator.translate("new.error.loginname.choosen");
        ErrorVO[] errorVos = new ErrorVO[] { new ErrorVO("org.olat.admin.user", "new.error.loginname.choosen", translation) };
        return Response.ok(errorVos).status(Status.NOT_ACCEPTABLE).build();
    }
    List<ErrorVO> errors = validateUser(null, user, request);
    if (errors.isEmpty()) {
        User newUser = UserManager.getInstance().createUser(user.getFirstName(), user.getLastName(), user.getEmail());
        Identity id = BaseSecurityManager.getInstance().createAndPersistIdentityAndUserWithDefaultProviderAndUserGroup(user.getLogin(), user.getExternalId(), user.getPassword(), newUser);
        post(newUser, user, getLocale(request));
        UserManager.getInstance().updateUser(newUser);
        return Response.ok(get(id)).build();
    }
    // content not ok
    ErrorVO[] errorVos = new ErrorVO[errors.size()];
    errors.toArray(errorVos);
    return Response.ok(errorVos).status(Status.NOT_ACCEPTABLE).build();
}

Example 19 with ErrorVO

use of org.olat.restapi.support.vo.ErrorVO in project openolat by klemens.

the class UserMgmtTest method testCreateUserWithValidationError.

@Test
public void testCreateUserWithValidationError() throws IOException, URISyntaxException {
    RestConnection conn = new RestConnection();
    assertTrue(conn.login("administrator", "openolat"));
    String login = "rest-809-" + UUID.randomUUID();
    UserVO vo = new UserVO();
    vo.setLogin(login);
    vo.setFirstName("John");
    vo.setLastName("Smith");
    vo.setEmail("");
    vo.putProperty("gender", "lu");
    URI request = UriBuilder.fromUri(getContextURI()).path("users").build();
    HttpPut method = conn.createPut(request, MediaType.APPLICATION_JSON, true);
    conn.addJsonEntity(method, vo);
    HttpResponse response = conn.execute(method);
    assertEquals(406, response.getStatusLine().getStatusCode());
    InputStream body = response.getEntity().getContent();
    List<ErrorVO> errors = parseErrorArray(body);
    assertNotNull(errors);
    assertFalse(errors.isEmpty());
    assertTrue(errors.size() >= 2);
    assertNotNull(errors.get(0).getCode());
    assertNotNull(errors.get(0).getTranslation());
    assertNotNull(errors.get(1).getCode());
    assertNotNull(errors.get(1).getTranslation());
    Identity savedIdent = BaseSecurityManager.getInstance().findIdentityByName(login);
    assertNull(savedIdent);
    conn.shutdown();
}

Example 20 with ErrorVO

use of org.olat.restapi.support.vo.ErrorVO in project openolat by klemens.

the class UserAuthenticationMgmtTest method createAuthentications_checkDuplicate.

/**
 * Check if the REST call return a specific error if the pair authentication user name and provider
 * is already used.
 */
@Test
public void createAuthentications_checkDuplicate() throws IOException, URISyntaxException {
    Identity id1 = JunitTestHelper.createAndPersistIdentityAsRndUser("check-auth-1");
    Identity id2 = JunitTestHelper.createAndPersistIdentityAsRndUser("check-auth-2");
    String authUsername = UUID.randomUUID().toString();
    dbInstance.commitAndCloseSession();
    RestConnection conn = new RestConnection();
    Assert.assertTrue(conn.login("administrator", "openolat"));
    // set the first authentication
    AuthenticationVO vo1 = new AuthenticationVO();
    vo1.setAuthUsername(authUsername);
    vo1.setIdentityKey(id1.getKey());
    vo1.setProvider("REST-API");
    vo1.setCredential("credentials");
    URI request1 = UriBuilder.fromUri(getContextURI()).path("/users/" + id1.getName() + "/auth").build();
    HttpPut method1 = conn.createPut(request1, MediaType.APPLICATION_JSON, true);
    conn.addJsonEntity(method1, vo1);
    HttpResponse response1 = conn.execute(method1);
    Assert.assertEquals(200, response1.getStatusLine().getStatusCode());
    conn.parse(response1, AuthenticationVO.class);
    Authentication refAuth1 = securityManager.findAuthentication(id1, "REST-API");
    Assert.assertNotNull(refAuth1);
    Assert.assertEquals(id1, refAuth1.getIdentity());
    // set the second which duplicates the first
    AuthenticationVO vo2 = new AuthenticationVO();
    vo2.setAuthUsername(authUsername);
    vo2.setIdentityKey(id2.getKey());
    vo2.setProvider("REST-API");
    vo2.setCredential("credentials");
    URI request2 = UriBuilder.fromUri(getContextURI()).path("/users/" + id2.getName() + "/auth").build();
    HttpPut method2 = conn.createPut(request2, MediaType.APPLICATION_JSON, true);
    conn.addJsonEntity(method2, vo2);
    HttpResponse response2 = conn.execute(method2);
    Assert.assertEquals(409, response2.getStatusLine().getStatusCode());
    ErrorVO error = conn.parse(response2, ErrorVO.class);
    Assert.assertNotNull(error);
    conn.shutdown();
}