org.apache.flink.runtime.rest.handler.HandlerRequest Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.11 Show documentation
There is a newer version: 1.13.6
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.flink.runtime.rest.handler;

import org.apache.flink.runtime.rest.messages.MessageParameters;
import org.apache.flink.runtime.rest.messages.MessagePathParameter;
import org.apache.flink.runtime.rest.messages.MessageQueryParameter;
import org.apache.flink.runtime.rest.messages.RequestBody;
import org.apache.flink.util.Preconditions;

import javax.annotation.Nonnull;

import java.io.File;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.StringJoiner;

/**
 * Simple container for the request to a handler, that contains the {@link RequestBody} and path/query parameters.
 *
 * @param  type of the contained request body
 * @param  type of the contained message parameters
 */
public class HandlerRequest {

	private final R requestBody;
	private final Collection uploadedFiles;
	private final Map>, MessagePathParameter> pathParameters = new HashMap<>(2);
	private final Map>, MessageQueryParameter> queryParameters = new HashMap<>(2);

	public HandlerRequest(R requestBody, M messageParameters) throws HandlerRequestException {
		this(requestBody, messageParameters, Collections.emptyMap(), Collections.emptyMap(), Collections.emptyList());
	}

	public HandlerRequest(R requestBody, M messageParameters, Map receivedPathParameters, Map> receivedQueryParameters) throws HandlerRequestException {
		this(requestBody, messageParameters, receivedPathParameters, receivedQueryParameters, Collections.emptyList());
	}

	public HandlerRequest(R requestBody, M messageParameters, Map receivedPathParameters, Map> receivedQueryParameters, Collection uploadedFiles) throws HandlerRequestException {
		this.requestBody = Preconditions.checkNotNull(requestBody);
		this.uploadedFiles = Collections.unmodifiableCollection(Preconditions.checkNotNull(uploadedFiles));
		Preconditions.checkNotNull(messageParameters);
		Preconditions.checkNotNull(receivedQueryParameters);
		Preconditions.checkNotNull(receivedPathParameters);

		for (MessagePathParameter pathParameter : messageParameters.getPathParameters()) {
			String value = receivedPathParameters.get(pathParameter.getKey());
			if (value != null) {
				try {
					pathParameter.resolveFromString(value);
				} catch (Exception e) {
					throw new HandlerRequestException("Cannot resolve path parameter (" + pathParameter.getKey() + ") from value \"" + value + "\".");
				}

				@SuppressWarnings("unchecked")
				Class> clazz = (Class>) pathParameter.getClass();
				pathParameters.put(clazz, pathParameter);
			}
		}

		for (MessageQueryParameter queryParameter : messageParameters.getQueryParameters()) {
			List values = receivedQueryParameters.get(queryParameter.getKey());
			if (values != null && !values.isEmpty()) {
				StringJoiner joiner = new StringJoiner(",");
				values.forEach(joiner::add);

				try {
					queryParameter.resolveFromString(joiner.toString());
				} catch (Exception e) {
					throw new HandlerRequestException("Cannot resolve query parameter (" + queryParameter.getKey() + ") from value \"" + joiner + "\".");
				}

				@SuppressWarnings("unchecked")
				Class> clazz = (Class>) queryParameter.getClass();
				queryParameters.put(clazz, queryParameter);
			}

		}
	}

	/**
	 * Returns the request body.
	 *
	 * @return request body
	 */
	public R getRequestBody() {
		return requestBody;
	}

	/**
	 * Returns the value of the {@link MessagePathParameter} for the given class.
	 *
	 * @param parameterClass class of the parameter
	 * @param             the value type that the parameter contains
	 * @param            type of the path parameter
	 * @return path parameter value for the given class
	 * @throws IllegalStateException if no value is defined for the given parameter class
	 */
	public > X getPathParameter(Class parameterClass) {
		@SuppressWarnings("unchecked")
		PP pathParameter = (PP) pathParameters.get(parameterClass);
		Preconditions.checkState(pathParameter != null, "No parameter could be found for the given class.");
		return pathParameter.getValue();
	}

	/**
	 * Returns the value of the {@link MessageQueryParameter} for the given class.
	 *
	 * @param parameterClass class of the parameter
	 * @param             the value type that the parameter contains
	 * @param            type of the query parameter
	 * @return query parameter value for the given class, or an empty list if no parameter value exists for the given class
	 */
	public > List getQueryParameter(Class parameterClass) {
		@SuppressWarnings("unchecked")
		QP queryParameter = (QP) queryParameters.get(parameterClass);
		if (queryParameter == null) {
			return Collections.emptyList();
		} else {
			return queryParameter.getValue();
		}
	}

	@Nonnull
	public Collection getUploadedFiles() {
		return uploadedFiles;
	}
}