com.reprezen.kaizen.oasparser.val3.HeaderValidator Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 *  Copyright (c) 2017 ModelSolv, Inc. and others.
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  which accompanies this distribution, and is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  Contributors:
 *     ModelSolv, Inc. - initial API and implementation and/or initial documentation
 *******************************************************************************/
package com.reprezen.kaizen.oasparser.val3;

import static com.reprezen.kaizen.oasparser.ovl3.HeaderImpl.F_allowEmptyValue;
import static com.reprezen.kaizen.oasparser.ovl3.HeaderImpl.F_contentMediaTypes;
import static com.reprezen.kaizen.oasparser.ovl3.HeaderImpl.F_deprecated;
import static com.reprezen.kaizen.oasparser.ovl3.HeaderImpl.F_description;
import static com.reprezen.kaizen.oasparser.ovl3.HeaderImpl.F_example;
import static com.reprezen.kaizen.oasparser.ovl3.HeaderImpl.F_examples;
import static com.reprezen.kaizen.oasparser.ovl3.HeaderImpl.F_explode;
import static com.reprezen.kaizen.oasparser.ovl3.HeaderImpl.F_schema;
import static com.reprezen.kaizen.oasparser.ovl3.HeaderImpl.F_style;
import static com.reprezen.kaizen.oasparser.val.msg.Messages.msg;
import static com.reprezen.kaizen.oasparser.val3.OpenApi3Messages.IgnContType;
import static com.reprezen.kaizen.oasparser.val3.OpenApi3Messages.NonQryAllowRsvd;

import com.reprezen.kaizen.oasparser.model3.Example;
import com.reprezen.kaizen.oasparser.model3.Header;
import com.reprezen.kaizen.oasparser.model3.MediaType;
import com.reprezen.kaizen.oasparser.model3.Schema;
import com.reprezen.kaizen.oasparser.val.ObjectValidatorBase;

public class HeaderValidator extends ObjectValidatorBase {

	@Override
	public void runObjectValidations() {
		Header header = (Header) value.getOverlay();
		validateStringField(F_description, false);
		validateBooleanField(F_deprecated, false);
		validateBooleanField(F_allowEmptyValue, false);
		validateBooleanField(F_explode, false);
		validateField(F_example, false, Object.class, null);
		validateMapField(F_examples, false, false, Example.class, new ExampleValidator());
		validateStringField(F_style, false, Regexes.STYLE_REGEX);
		checkAllowReserved(header);
		// TODO Q: Should schema be required in header object?
		validateField(F_schema, false, Schema.class, new SchemaValidator());
		validateMapField(F_contentMediaTypes, false, false, MediaType.class, new MediaTypeValidator());
		validateExtensions(header.getExtensions());
		checkContentType();
		// TODO validate that location-related values (like style) are consistent with
		// header location
		// TODO warn if this appears on a request body whose media type is not multipart
	}

	private void checkAllowReserved(Header header) {
		// TODO Q: Shouldn't "allowReserved" be disallowed for headers, as are "name"
		// and "in"?
		if (header.isAllowReserved()) {
			results.addWarning(msg(NonQryAllowRsvd, value.getPathInParent(), "header"), value);
		}
	}

	private void checkContentType() {
		if (value.getPathInParent().equalsIgnoreCase("Content-Type")) {
			results.addWarning(msg(IgnContType), value);
		}
	}
}