RequiredQueryParamValidator.java

/*
 * Copyright 2015 uaiHebert
 *
 * 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.uaihebert.uaimockserver.validator;

import com.uaihebert.uaimockserver.facade.RequestValidatorFacade;
import com.uaihebert.uaimockserver.log.backend.Log;
import com.uaihebert.uaimockserver.model.UaiQueryParam;
import com.uaihebert.uaimockserver.model.UaiRequest;
import io.undertow.server.HttpServerExchange;

import java.util.Deque;
import java.util.Map;

/**
 * Will validate all the request query params if needed
 */
public final class RequiredQueryParamValidator implements RequestDataValidator {
    private static final String WILD_CARD_TEXT = "The header [%s] is using the wildcard. Its content will not be checked.";
    private static final String QUERY_PARAM_NOT_FOUND_MESSAGE = "%nThe required queryParam [%s] was not found in the request";
    private static final String QUERY_PARAM_VALUE_NOT_FOUND_MESSAGE = "%nThe required queryParamList [%s] has not the required values: [%s]";

    @Override
    public void validate(final UaiRequest uaiRequest, final HttpServerExchange exchange, final RequestValidatorFacade.RequestAnalysisResult result) {
        for (UaiQueryParam uaiQueryParam : uaiRequest.getRequiredQueryParamList()) {
            final Map<String, Deque<String>> queryParameterMap = exchange.getQueryParameters();

            validatedQueryParam(uaiQueryParam, queryParameterMap, result);
        }
    }

    private void validatedQueryParam(final UaiQueryParam uaiQueryParam, final Map<String, Deque<String>> queryParameterMap, final RequestValidatorFacade.RequestAnalysisResult result) {
        final Deque<String> valueDeque = queryParameterMap.get(uaiQueryParam.getName());

        if (valueDeque == null) {
            Log.warnFormatted(QUERY_PARAM_NOT_FOUND_MESSAGE, uaiQueryParam.getName());
            result.setInvalid();
            return;
        }

        if (uaiQueryParam.isUsingWildCard()) {
            Log.infoFormatted(WILD_CARD_TEXT, uaiQueryParam.getName());
            return;
        }

        if (!valueDeque.containsAll(uaiQueryParam.getValueList())) {
            Log.warnFormatted(QUERY_PARAM_VALUE_NOT_FOUND_MESSAGE, uaiQueryParam.getValueList(), uaiQueryParam.getName());
            result.setInvalid();
        }
    }
}