com.adobe.cq.testing.client.security.User Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-cloud-testing-clients Show documentation
Show all versions of aem-cloud-testing-clients Show documentation
AEM related clients and testing utilities for AEM as a Cloud Service
/*
* Copyright 2017 Adobe Systems Incorporated
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.adobe.cq.testing.client.security;
import com.adobe.cq.testing.client.SecurityClient;
import org.apache.sling.testing.clients.ClientException;
import org.apache.sling.testing.Constants;
import org.apache.sling.testing.clients.SlingHttpResponse;
import org.apache.sling.testing.clients.util.FormEntityBuilder;
import org.apache.sling.testing.clients.util.HttpUtils;
import org.apache.sling.testing.clients.util.poller.Polling;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeoutException;
import static org.apache.http.HttpStatus.*;
/**
* Object which handles user actions
*/
public class User extends AbstractAuthorizable {
private static final Logger LOG = LoggerFactory.getLogger(User.class);
public static final String ROOT_PATH = "/home/users";
/**
*
* How many millisecond to wait before giving up on waiting for an async index to be updated.
*
*
* By default it will wait {@code 6000}ms but it can be fine tuned with, for example
* {@code -Dgranite.it.maxasync=12000}
*
*/
public static final int MAX_ASYNC_WAIT_MILLIS = Integer.getInteger("granite.it.maxasync", 6000);
protected UserProfile profile;
public User(T client, String authorizableId) throws ClientException, InterruptedException {
super(client, authorizableId);
}
public String getRootPath() {
return ROOT_PATH;
}
/**
* Adds impersonators to the user.
*
* @param authorizables list of any {@code User} objects
* @param expectedStatus list of allowed HTTP Status to be returned.
* @param user type
* @return Sling response
* @throws ClientException if something fails during request/response cycle
* @throws InterruptedException if waiting was interrupted
*/
public SlingHttpResponse addImpersonators(T[] authorizables, int... expectedStatus) throws
ClientException, InterruptedException {
if (authorizables == null) {
throw new IllegalArgumentException("List of authorizables may not be null!");
}
// add user to group - base = group
// prepare the form
FormEntityBuilder formEntry = FormEntityBuilder.create();
formEntry.addParameter(Constants.PARAMETER_CHARSET, Constants.CHARSET_UTF8);
for (T authorizable : authorizables) {
formEntry.addParameter(Authorizable.PARAM_ADD_IMPERSONATORS, encodeURI(authorizable.getId()));
}
class PostPolling extends Polling {
private final FormEntityBuilder entity;
private final int[] expectedStatus;
private SlingHttpResponse response;
public PostPolling(final FormEntityBuilder entity, final int... expectedStatus) {
super();
this.entity = entity;
this.expectedStatus = expectedStatus;
}
@Override
public Boolean call() throws Exception {
response = doPost(entity, expectedStatus);
return true;
}
public SlingHttpResponse getResponse() {
return response;
}
}
PostPolling polling = new PostPolling(formEntry, expectedStatus);
try {
polling.poll(MAX_ASYNC_WAIT_MILLIS, 100);
} catch (TimeoutException e) {
throw new ClientException("Failed to add impersonators.", e);
}
return polling.getResponse();
}
/**
* Remove impersonators from the user
*
* @param authorizables list of any {@code User} objects
* @param expectedStatus list of allowed HTTP Status to be returned.
* @param user type
* @return Sling response
* @throws ClientException
* If something fails during request/response cycle
*/
public SlingHttpResponse removeImpersonators(T[] authorizables, int... expectedStatus)
throws ClientException {
if (authorizables == null) {
throw new IllegalArgumentException("List of authorizables may not be null!");
}
// add user to group - base = group
// prepare the form
FormEntityBuilder formEntry = FormEntityBuilder.create();
formEntry.addParameter(Constants.PARAMETER_CHARSET, Constants.CHARSET_UTF8);
for (T authorizable : authorizables) {
formEntry.addParameter(Authorizable.PARAM_REMOVE_IMPERSONATORS, encodeURI(authorizable.getId()));
}
// send the request
return doPost(formEntry, HttpUtils.getExpectedStatus(SC_OK, expectedStatus));
}
/**
* Get user profile
*
* @return {@link UserProfile}
* @throws ClientException if the request failed
*/
public UserProfile getUserProfile() throws ClientException {
if (profile == null) {
initProfile();
}
return profile;
}
protected void initProfile() throws ClientException {
// initialize profile
this.profile = new UserProfile(this);
}
/**
* Creates a new user.
*
* @param client any class implementing the {@link SecurityClient}.
* @param userId the user ID for the new user.
* @param password the password to be assigned.
* @param intermediatePath the root path user will be created.
* @param profileMap profile properties to be set for the new user.
* @param expectedStatus list of allowed HTTP Status to be returned. If not set,
* http status 201 (CREATED) is assumed.
* @param client type
* @return {@code User}
* @throws ClientException
* If something fails during request/response cycle
* @throws InterruptedException to mark this method as "waiting"
*/
// FIXME move reading to a method loadUser() and make constructor private
public static User createUser(T client, String userId, String password,
String intermediatePath, Map profileMap,
int... expectedStatus) throws ClientException, InterruptedException {
if (client == null || userId == null) {
throw new IllegalArgumentException("Client and userId may not be null!");
}
// password: fallback = userId
if (password == null) {
password = userId;
}
FormEntityBuilder feb = FormEntityBuilder.create();
feb.addParameter(Constants.PARAMETER_CHARSET, Constants.CHARSET_UTF8);
feb.addParameter(Authorizable.PARAM_CREATE_USER, "" + Authorizable.ACTION_CREATE_USER);
feb.addParameter(Authorizable.PARAM_AUTHORIZABLE_ID, userId);
feb.addParameter(Authorizable.PARAM_PASSWORD, password);
if (intermediatePath != null) {
feb.addParameter(Authorizable.PARAM_INTERMEDIATE_PATH, intermediatePath);
}
// profile
if (profileMap != null) {
Set profileProps = profileMap.keySet();
for (String propName : profileProps) {
String propValue = profileMap.get(propName);
if (propValue != null) {
feb.addParameter("./" + UserProfile.NODE_PROFILE + "/" + propName, propValue);
}
}
}
// Create the user
String createUserPath = client.getManager()
.doPost(feb, HttpUtils.getExpectedStatus(SC_CREATED, expectedStatus))
.getSlingPath();
LOG.info("Created user at {}", createUserPath);
// wait for user and get Authorizable
// new User is blocking until the user is found on the instance
return new User(client, userId);
}
/**
* Creates a new user.
*
* @param client any class implementing the {@link SecurityClient}.
* @param userId the user ID for the new user.
* @param password the password to be assigned.
* @param intermediatePath the root path user will be created.
* @param profileMap profile properties to be set for the new user.
* @param waitForIndex Whether or not to wait for indexing to be complete before returning
* @param expectedStatus list of allowed HTTP Status to be returned. If not set,
* http status 201 (CREATED) is assumed.
* @param client type
* @return {@code User}
* @throws ClientException
* If something fails during request/response cycle
* @throws InterruptedException to mark this method as "waiting"
*
* @deprecated waitForIndex parameter is not needed. Use {@link #createUser(SecurityClient, String, String, String, Map, int...)}
*/
@Deprecated
public static User createUser(T client, String userId, String password,
String intermediatePath, Map profileMap,
boolean waitForIndex,
int... expectedStatus) throws ClientException, InterruptedException {
return createUser(client, userId, password, intermediatePath, profileMap, expectedStatus);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy