cs-office-365/src/main/java/io/cloudslang/content/office365/utils/InputsValidation.java
/*
* Copyright 2024 Open Text
* This program and the accompanying materials
* are made available under the terms of the Apache License v2.0 which accompany this distribution.
*
* The Apache License is available 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 io.cloudslang.content.office365.utils;
import io.cloudslang.content.utils.NumberUtilities;
import io.cloudslang.content.utils.StringUtilities;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import static io.cloudslang.content.httpclient.entities.HttpClientInputs.*;
import static io.cloudslang.content.office365.utils.Constants.FILE_PATH;
import static io.cloudslang.content.office365.utils.Constants.*;
import static io.cloudslang.content.office365.utils.Inputs.AuthorizationInputs.PASSWORD;
import static io.cloudslang.content.office365.utils.Inputs.AuthorizationInputs.USERNAME;
import static io.cloudslang.content.office365.utils.Inputs.AuthorizationInputs.*;
import static io.cloudslang.content.office365.utils.Inputs.CommonInputs.PROXY_PORT;
import static io.cloudslang.content.office365.utils.Inputs.CreateMessage.*;
import static io.cloudslang.content.office365.utils.Inputs.CreateUser.*;
import static io.cloudslang.content.office365.utils.Inputs.EmailInputs.*;
import static io.cloudslang.content.office365.utils.Inputs.MoveMessage.DESTINATION_ID;
import static io.cloudslang.content.utils.BooleanUtilities.isValid;
import static io.cloudslang.content.utils.OtherUtilities.isValidIpPort;
import static org.apache.commons.lang3.StringUtils.isEmpty;
public final class InputsValidation {
@NotNull
public static List<String> verifyAuthorizationInputs(@Nullable final String loginType, @Nullable final String clientId, @Nullable final String clientSecret, @Nullable final String username, @Nullable final String password, @NotNull final String proxyPort) {
final List<String> exceptionMessages = new ArrayList<>();
addVerifyLoginType(exceptionMessages, loginType, LOGIN_TYPE);
addVerifyNotNullOrEmpty(exceptionMessages, clientId, CLIENT_ID);
if (StringUtilities.equalsIgnoreCase(loginType, NATIVE)) {
addVerifyNotNullOrEmpty(exceptionMessages, username, USERNAME);
addVerifyNotNullOrEmpty(exceptionMessages, password, PASSWORD);
}
if (StringUtilities.equalsIgnoreCase(loginType, API)) {
addVerifyNotNullOrEmpty(exceptionMessages, clientSecret, CLIENT_SECRET);
}
addVerifyProxy(exceptionMessages, proxyPort, PROXY_PORT);
return exceptionMessages;
}
@NotNull
public static List<String> verifyGetMessageInputs(@Nullable final String messageId,
@Nullable final String userPrincipalName,
@Nullable final String userId,
@Nullable final String proxyPort,
@Nullable final String trust_all_roots,
@Nullable final String connectTimeout,
@Nullable final String socketTimeout,
@Nullable final String keepAlive,
@Nullable final String connectionsMaxPerRoute,
@Nullable final String connectionsMaxTotal) {
final List<String> exceptionMessages = verifyCommonInputs(userPrincipalName, userId, proxyPort, trust_all_roots,
connectTimeout, socketTimeout, keepAlive, connectionsMaxPerRoute, connectionsMaxTotal);
addVerifyNotNullOrEmpty(exceptionMessages, messageId, MESSAGE_ID);
return exceptionMessages;
}
@NotNull
public static List<String> verifySendEmailInputs(@Nullable final String clientId,
@NotNull final String proxyPort,
@Nullable final String userPrincipalName,
@Nullable final String userId,
@Nullable final String trust_all_roots,
@Nullable final String connectTimeout,
@Nullable final String socketTimeout,
@Nullable final String keepAlive,
@Nullable final String connectionsMaxPerRoute,
@Nullable final String connectionsMaxTotal) {
final List<String> exceptionMessages = verifyCommonInputs(userPrincipalName, userId, proxyPort, trust_all_roots,
connectTimeout, socketTimeout, keepAlive, connectionsMaxPerRoute, connectionsMaxTotal);
addVerifyProxy(exceptionMessages, proxyPort, PROXY_PORT);
addVerifyNotNullOrEmpty(exceptionMessages, clientId, CLIENT_ID);
return exceptionMessages;
}
@NotNull
public static List<String> verifyGetAttachmentInputs(@Nullable final String messageId,
@Nullable final String userPrincipalName,
@Nullable final String attachmentId,
@Nullable final String userId,
@Nullable final String proxyPort,
@Nullable final String trust_all_roots,
@Nullable final String connectTimeout,
@Nullable final String socketTimeout,
@Nullable final String keepAlive,
@Nullable final String connectionsMaxPerRoute,
@Nullable final String connectionsMaxTotal) {
final List<String> exceptionMessages = verifyCommonInputs(userPrincipalName, userId, proxyPort, trust_all_roots,
connectTimeout, socketTimeout, keepAlive, connectionsMaxPerRoute, connectionsMaxTotal);
addVerifyNotNullOrEmpty(exceptionMessages, messageId, MESSAGE_ID);
addVerifyNotNullOrEmpty(exceptionMessages, attachmentId, ATTACHMENT_ID);
return exceptionMessages;
}
@NotNull
public static List<String> verifyCommonInputs(@Nullable final String userPrincipalName,
@Nullable final String userId,
@Nullable final String proxyPort,
@Nullable final String trust_all_roots,
@Nullable final String connectTimeout,
@Nullable final String socketTimeout,
@Nullable final String keepAlive,
@Nullable final String connectionsMaxPerRoute,
@Nullable final String connectionsMaxTotal) {
final List<String> exceptionMessages = new ArrayList<>();
addVerifyUserInputs(exceptionMessages, userPrincipalName, userId);
addVerifyProxy(exceptionMessages, proxyPort, PROXY_PORT);
addVerifyBoolean(exceptionMessages, trust_all_roots, TRUST_ALL_ROOTS);
addVerifyNumber(exceptionMessages, connectTimeout, CONNECT_TIMEOUT);
addVerifyNumber(exceptionMessages, socketTimeout, SOCKET_TIMEOUT);
addVerifyBoolean(exceptionMessages, keepAlive, KEEP_ALIVE);
addVerifyNumber(exceptionMessages, connectionsMaxPerRoute, CONNECTIONS_MAX_PER_ROUTE);
addVerifyNumber(exceptionMessages, connectionsMaxTotal, CONNECTIONS_MAX_TOTAL);
return exceptionMessages;
}
@NotNull
public static List<String> verifyMoveMessageInputs(@Nullable final String userPrincipalName,
@Nullable final String userId,
@Nullable final String messageId,
@Nullable final String destinationId,
@Nullable final String proxyPort,
@Nullable final String trust_all_roots,
@Nullable final String connectTimeout,
@Nullable final String socketTimeout,
@Nullable final String keepAlive,
@Nullable final String connectionsMaxPerRoute,
@Nullable final String connectionsMaxTotal) {
final List<String> exceptionMessages = verifyCommonInputs(userPrincipalName, userId, proxyPort, trust_all_roots,
connectTimeout, socketTimeout, keepAlive, connectionsMaxPerRoute, connectionsMaxTotal);
addVerifyNotNullOrEmpty(exceptionMessages, messageId, MESSAGE_ID);
addVerifyNotNullOrEmpty(exceptionMessages, destinationId, DESTINATION_ID);
return exceptionMessages;
}
@NotNull
public static List<String> verifyCommonUserInputs(@Nullable final String proxyPort,
@Nullable final String trust_all_roots,
@Nullable final String connectTimeout,
@Nullable final String socketTimeout,
@Nullable final String keepAlive,
@Nullable final String connectionsMaxPerRoute,
@Nullable final String connectionsMaxTotal) {
final List<String> exceptionMessages = new ArrayList<>();
addVerifyProxy(exceptionMessages, proxyPort, PROXY_PORT);
addVerifyBoolean(exceptionMessages, trust_all_roots, TRUST_ALL_ROOTS);
addVerifyNumber(exceptionMessages, connectTimeout, CONNECT_TIMEOUT);
addVerifyNumber(exceptionMessages, socketTimeout, SOCKET_TIMEOUT);
addVerifyBoolean(exceptionMessages, keepAlive, KEEP_ALIVE);
addVerifyNumber(exceptionMessages, connectionsMaxPerRoute, CONNECTIONS_MAX_PER_ROUTE);
addVerifyNumber(exceptionMessages, connectionsMaxTotal, CONNECTIONS_MAX_TOTAL);
return exceptionMessages;
}
@NotNull
public static List<String> verifyCreateUserInputs(@Nullable final String accountEnabled,
@Nullable final String displayName,
@Nullable final String mailNickname,
@Nullable final String userPrincipalName,
@Nullable final String forceChangePassword,
@Nullable final String password,
@Nullable final String proxyPort,
@Nullable final String trust_all_roots,
@Nullable final String connectTimeout,
@Nullable final String socketTimeout,
@Nullable final String keepAlive,
@Nullable final String connectionsMaxPerRoute,
@Nullable final String connectionsMaxTotal) {
final List<String> exceptionMessages = new ArrayList<>();
addVerifyNotNullOrEmpty(exceptionMessages, accountEnabled, ACCOUNT_ENABLED);
addVerifyBoolean(exceptionMessages, accountEnabled, ACCOUNT_ENABLED);
addVerifyNotNullOrEmpty(exceptionMessages, displayName, DISPLAY_NAME);
addVerifyNotNullOrEmpty(exceptionMessages, mailNickname, MAIL_NICKNAME);
addVerifyNotNullOrEmpty(exceptionMessages, userPrincipalName, USER_PRINCIPAL_NAME);
addVerifyNotNullOrEmpty(exceptionMessages, forceChangePassword, FORCE_CHANGE_PASSWORD);
addVerifyBoolean(exceptionMessages, forceChangePassword, FORCE_CHANGE_PASSWORD);
addVerifyNotNullOrEmpty(exceptionMessages, password, PASSWORD);
exceptionMessages.addAll(verifyCommonUserInputs(proxyPort, trust_all_roots,
connectTimeout, socketTimeout, keepAlive, connectionsMaxPerRoute, connectionsMaxTotal));
return exceptionMessages;
}
@NotNull
public static List<String> verifyUpdateUserInputs(@Nullable final String accountEnabled,
@Nullable final String userIdToUpdate,
@Nullable final String userPrincipalNameToUpdate,
@Nullable final String forceChangePassword,
@Nullable final String proxyPort,
@Nullable final String trust_all_roots,
@Nullable final String connectTimeout,
@Nullable final String socketTimeout,
@Nullable final String keepAlive,
@Nullable final String connectionsMaxPerRoute,
@Nullable final String connectionsMaxTotal) {
final List<String> exceptionMessages = verifyCommonInputs(userPrincipalNameToUpdate, userIdToUpdate, proxyPort, trust_all_roots,
connectTimeout, socketTimeout, keepAlive, connectionsMaxPerRoute, connectionsMaxTotal);
addVerifyBoolean(exceptionMessages, accountEnabled, ACCOUNT_ENABLED);
addVerifyBoolean(exceptionMessages, forceChangePassword, FORCE_CHANGE_PASSWORD);
return exceptionMessages;
}
@NotNull
public static List<String> verifyCreateMessageInputs(@Nullable final String sender, @Nullable final String importance,
@Nullable final String toRecipients, @Nullable final String isRead,
@Nullable final String isDeliveryReceiptRequested,
@Nullable final String isReadReceiptRequested,
@Nullable final String inferenceClassification) {
final List<String> exceptionMessages = new ArrayList<>();
addVerifyNotNullOrEmpty(exceptionMessages, sender, SENDER);
addVerifyNotNullOrEmpty(exceptionMessages, importance, IMPORTANCE);
addVerifyNotNullOrEmpty(exceptionMessages, inferenceClassification, INFERENCE_CLASSIFICATION);
addVerifyNotNullOrEmpty(exceptionMessages, toRecipients, TO_RECIPIENTS);
addVerifyBoolean(exceptionMessages, isRead, IS_READ);
addVerifyBoolean(exceptionMessages, isDeliveryReceiptRequested, IS_DELIVERY_RECEIPT_REQUESTED);
addVerifyBoolean(exceptionMessages, isReadReceiptRequested, IS_READ_RECEIPT_REQUESTED);
return exceptionMessages;
}
@NotNull
public static List<String> verifyAddAttachmentInputs(
@Nullable final String filePath,
@Nullable final String contentName,
@Nullable final String contentBytes,
@Nullable final String userPrincipalName,
@Nullable final String userId,
@Nullable final String messageId,
@Nullable final String proxyPort,
@Nullable final String trust_all_roots,
@Nullable final String connectTimeout,
@Nullable final String socketTimeout,
@Nullable final String keepAlive,
@Nullable final String connectionsMaxPerRoute,
@Nullable final String connectionsMaxTotal) {
final List<String> exceptionMessages = verifyCommonInputs(userPrincipalName, userId, proxyPort, trust_all_roots,
connectTimeout, socketTimeout, keepAlive, connectionsMaxPerRoute, connectionsMaxTotal);
addVerifyAttachmentBytesOrPath(exceptionMessages, filePath, contentName, contentBytes);
addVerifyNotNullOrEmpty(exceptionMessages, messageId, MESSAGE_ID);
return exceptionMessages;
}
@NotNull
private static List<String> addVerifyUserInputs(@NotNull List<String> exceptions, @Nullable final String userPrincipalName,
@Nullable final String userId) {
if (isEmpty(userPrincipalName) && isEmpty(userId)) {
exceptions.add(String.format(EXCEPTION_INVALID_LOGIN_TYPE_REST, USER_PRINCIPAL_NAME, USER_ID));
}
return exceptions;
}
@NotNull
private static List<String> addVerifyLoginType(@NotNull List<String> exceptions, @Nullable final String input, @NotNull final String inputName) {
if (!(StringUtilities.equalsIgnoreCase(input, API) || StringUtilities.equalsIgnoreCase(input, NATIVE))) {
exceptions.add(String.format(EXCEPTION_INVALID_LOGIN_TYPE, inputName));
}
return exceptions;
}
@NotNull
private static List<String> addVerifyAttachmentBytesOrPath(@NotNull List<String> exceptions, @Nullable final String filePath, @Nullable final String contentName, @Nullable final String contentBytes) {
boolean emptyContentNameAndBytes = isEmpty(contentName) || isEmpty(contentBytes);
if (isEmpty(filePath) && emptyContentNameAndBytes) {
exceptions.add(EXCEPTION_EMPTY_FILE_PATH_AND_CONTENT_BYTES);
} else if (!isEmpty(filePath) && !isValidFile(filePath) && emptyContentNameAndBytes) {
exceptions.add(String.format(EXCEPTION_INVALID_FILE, filePath, FILE_PATH));
}
return exceptions;
}
@NotNull
private static List<String> addVerifyNotNullOrEmpty(@NotNull List<String> exceptions, @Nullable final String input, @NotNull final String inputName) {
if (isEmpty(input)) {
exceptions.add(String.format(EXCEPTION_NULL_EMPTY, inputName));
}
return exceptions;
}
@NotNull
private static List<String> addVerifyProxy(@NotNull List<String> exceptions, @Nullable final String input, @NotNull final String inputName) {
if (isEmpty(input)) {
exceptions.add(String.format(EXCEPTION_NULL_EMPTY, inputName));
} else if (!isValidIpPort(input)) {
exceptions.add(String.format(EXCEPTION_INVALID_PROXY, PROXY_PORT));
}
return exceptions;
}
@NotNull
private static List<String> addVerifyBoolean(@NotNull List<String> exceptions, @Nullable final String input, @NotNull final String inputName) {
if (isEmpty(input)) {
exceptions.add(String.format(EXCEPTION_NULL_EMPTY, inputName));
} else if (!isValid(input)) {
exceptions.add(String.format(EXCEPTION_INVALID_BOOLEAN, input, inputName));
}
return exceptions;
}
@NotNull
private static List<String> addVerifyNumber(@NotNull List<String> exceptions, @Nullable final String input, @NotNull final String inputName) {
if (isEmpty(input)) {
exceptions.add(String.format(EXCEPTION_NULL_EMPTY, inputName));
} else if (!NumberUtilities.isValidInt(input)) {
exceptions.add(String.format(EXCEPTION_INVALID_NUMBER, input, inputName));
}
return exceptions;
}
private static boolean isValidFile(@NotNull final String filePath) {
return new File(filePath).exists();
}
}