com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of springmvc-raml-parser Show documentation
Components including the parsing of RAML documents and Spring MVC Annotations to create RAML models
The newest version!
/*
 * Copyright 2002-2017 the original author or authors.
 * 
 * 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.phoenixnap.oss.ramlapisync.data;

import com.phoenixnap.oss.ramlapisync.naming.NamingHelper;
import com.phoenixnap.oss.ramlapisync.pojo.PojoGenerationConfig;
import com.phoenixnap.oss.ramlapisync.raml.RamlAction;
import com.phoenixnap.oss.ramlapisync.raml.RamlActionType;
import com.phoenixnap.oss.ramlapisync.raml.RamlResource;
import com.phoenixnap.oss.ramlapisync.raml.RamlRoot;
import com.sun.codemodel.JCodeModel;

import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;


/**
 *
 * Class containing the data required to successfully generate code for an api rest controller within spring mvc
 *
 * @author Kurt Paris
 * @since 0.2.1
 *
 */
public class ApiResourceMetadata {

	private String controllerUrl;
	private transient RamlResource resource;
	private RamlRoot document;
	private boolean singularizeName = true;
	private JCodeModel bodyCodeModel;
	private int resourceDepthInClassNames;
	private int resourceTopLevelInClassNames;
	private boolean reverseOrderInClassNames;

	private PojoGenerationConfig config;
	Set apiCalls = new LinkedHashSet<>();

	public ApiResourceMetadata(PojoGenerationConfig config, JCodeModel bodyCodeModel, String controllerUrl, RamlResource resource, RamlRoot document, int resourceDepthInClassNames, int resourceTopLevelInClassNames, boolean reverseOrderInClassNames) {
		super();
		this.controllerUrl = controllerUrl;
		this.resource = resource;
		this.document = document;
		this.bodyCodeModel = bodyCodeModel;
		this.config = config;
		this.resourceDepthInClassNames = resourceDepthInClassNames;
		this.resourceTopLevelInClassNames = resourceTopLevelInClassNames;
		this.reverseOrderInClassNames = reverseOrderInClassNames;
	}


	public void addApiCall(RamlResource resource, RamlActionType actionType, RamlAction action, String responseContentType, boolean injectHttpHeadersParameter) {
		apiCalls.add(new ApiActionMetadata(config, this, resource, actionType, action, responseContentType, injectHttpHeadersParameter));
	}

    public Set getApiCalls() {
		return Collections.unmodifiableSet(apiCalls);
	}

    public String getName() {
    	if(this.resourceDepthInClassNames != 1 || this.resourceTopLevelInClassNames != 0 || this.reverseOrderInClassNames){
			return NamingHelper.getAllResourcesNames(controllerUrl, singularizeName, this.resourceDepthInClassNames, this.resourceTopLevelInClassNames, this.reverseOrderInClassNames);
		} else {
			return NamingHelper.getResourceName(resource, singularizeName);
		}
    }


	public RamlResource getResource() {
		return resource;
	}

	public String getResourceName() {
		return NamingHelper.getResourceName(resource, singularizeName);
	}

	public String getResourceUri() {
		return resource.getUri();
	}

	public String getControllerUrl() {
		return controllerUrl;
	}


	public String toString() {
    	return "Controller "+getName()+"["+ getControllerUrl() +"]";

    }

	public String getBasePackage() {
		return config.getBasePackage();
	}

	public Set getDependencies() {
		Set dependencies = new LinkedHashSet<>();
		for (ApiActionMetadata method : apiCalls) {
			if (method.getRequestBody() != null) {
				dependencies.add(method.getRequestBody());
			}
			dependencies.addAll(method.getResponseBody().values());
		}
		return dependencies;
	}

    public Set getParameters() {
        Set parameters = new LinkedHashSet<>();
        for (ApiActionMetadata method : apiCalls) {
            parameters.addAll(method.getRequestHeaders());
            parameters.addAll(method.getRequestParameters());
        }
        return parameters;
    }

    public String getDescription() {
        return resource.getDescription();
    }


	public RamlRoot getDocument() {
		return document;
	}


	public void setSingularizeName(boolean singularizeName) {
		this.singularizeName = singularizeName;
	}


	public JCodeModel getBodyCodeModel() {
		return this.bodyCodeModel;
	}
}