com.phoenixnap.oss.ramlapisync.parser

Class SpringMvcResourceParser

java.lang.Object

com.phoenixnap.oss.ramlapisync.parser.ResourceParser

com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser

public class SpringMvcResourceParser
extends ResourceParser

Service scanner that handles generation from a Spring MVC codebase

Since:

0.0.1

Author:

Kurt Paris

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
protected boolean	restrictOnMediaType IF this is set to true, we will only parse methods that consume, produce or accept the requested defaultMediaType

Fields inherited from class com.phoenixnap.oss.ramlapisync.parser.ResourceParser

CATCH_ALL_MEDIA_TYPE, CSRF_HEADER, defaultMediaType, IGNORE_METHOD_REGEX, javaDocs, version

Constructor Summary

Constructors

Constructor and Description
SpringMvcResourceParser(File path, String version, String defaultMediaType, boolean restrictOnMediaType)

Method Summary

Modifier and Type	Method and Description
protected void	addHeadersForMethod(RamlAction action, RamlActionType actionType, Method method) Allows children to add common headers to API methods (eg CSRF, Authorization)
protected void	extractAndAppendResourceInfo(Class<?> clazz, Method method, JavaDocEntry docEntry, RamlResource parentResource) Extracts relevant info from a Java method and converts it into a RAML resource
protected String	extractExpectedMimeTypeFromMethod(Method method) Check for consumes annotation first.
protected String	extractMimeTypeFromMethod(Method method) Check for produces annotation first.
protected Pair<String,RamlMimeType>	extractRequestBody(Method method, Map<String,String> parameterComments, String comment, List<ApiParameterMetadata> apiParameters) Converts a method body into a request json schema and a mime type.
protected ApiParameterMetadata[]	extractResourceIdParameter(Method method) Queries the parameters in the Method and checks for an AjaxParameter Annotation with the resource Id flag enabled
protected List<ApiParameterMetadata>	getApiParameters(Method method, boolean includeUrlParameters, boolean includeNonUrlParameters) Allows children to specify which parameters within a method should be included in API generation
protected Map<RamlActionType,String>	getHttpMethodAndName(Class<?> clazz, Method method) Extracts the http method (verb) as well as the name of the api call
protected String	getParameterName(String preferredOption, String fallback)
protected Map<String,String>	getPathDescriptionsForMethod(Method method) Checks for instances of @Description annotations in
protected String	getResourceName(Class<?> clazz) Extracts the name of the resource that this class manages
protected boolean	isActionOnResourceWithoutCommand(Method method) Checks is this api call is made directly on a resource without a trailing command in the URL.
protected boolean	isNonPathParameter(Parameter param)
protected boolean	isParameter(Parameter param)
protected boolean	isPathParameter(Parameter param)
protected boolean	isQueryParameter(Parameter param) Allows children to specify whether a parameter should be included when generating query parameters for a method
protected boolean	shouldAddMethodToApi(Method method) Allows child Scanners to add their own logic on whether a method should be treated as an API or ignored
protected boolean	shouldAddParameter(Parameter param) Checks if a parameter has any metadata that has been attached using the RequestParam data which identifies it as an API request parameter

Methods inherited from class com.phoenixnap.oss.ramlapisync.parser.ResourceParser

doesActionTypeSupportMultipartMime, doesActionTypeSupportRequestBody, extractQueryParameters, extractRequestBodyFromMethod, extractResourceInfo, extractResponseFromMethod, setJavaDocs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static final org.slf4j.Logger logger

restrictOnMediaType

protected boolean restrictOnMediaType

IF this is set to true, we will only parse methods that consume, produce or accept the requested defaultMediaType

Constructor Detail

SpringMvcResourceParser

public SpringMvcResourceParser(File path,
                               String version,
                               String defaultMediaType,
                               boolean restrictOnMediaType)

Method Detail

extractRequestBody

protected Pair<String,RamlMimeType> extractRequestBody(Method method,
                                                       Map<String,String> parameterComments,
                                                       String comment,
                                                       List<ApiParameterMetadata> apiParameters)

Description copied from class: ResourceParser

Converts a method body into a request json schema and a mime type. TODO refactor this code structure

Overrides:

extractRequestBody in class ResourceParser

Parameters:

method - The method to be used to get the request object

parameterComments - Associated JavaDoc for Parameters (if any)

comment - Main Method Javadoc Comment (if any)

apiParameters - The Parameters identifed from this method

Returns:

The Request Body as a schema and the associated mime type

extractMimeTypeFromMethod

protected String extractMimeTypeFromMethod(Method method)

Check for produces annotation first. else use super implementation

Overrides:

extractMimeTypeFromMethod in class ResourceParser

Parameters:

method - The method to inspect

Returns:

The mime type as string

extractExpectedMimeTypeFromMethod

protected String extractExpectedMimeTypeFromMethod(Method method)

Check for consumes annotation first. else use super implementation

Overrides:

extractExpectedMimeTypeFromMethod in class ResourceParser

Parameters:

method - The method to inspect

Returns:

The mime type this method can work on

shouldAddMethodToApi

protected boolean shouldAddMethodToApi(Method method)

Description copied from class: ResourceParser

Allows child Scanners to add their own logic on whether a method should be treated as an API or ignored

Specified by:

shouldAddMethodToApi in class ResourceParser

Parameters:

method - The method to inspect

Returns:

If true the method is annotated in such a way that it should be included in the raml

getParameterName

protected String getParameterName(String preferredOption,
                                  String fallback)

shouldAddParameter

protected boolean shouldAddParameter(Parameter param)

Checks if a parameter has any metadata that has been attached using the RequestParam data which identifies it as an API request parameter

Parameters:

param - The Parameter to be checked

Returns:

If true the parameter should be added to the api

getApiParameters

protected List<ApiParameterMetadata> getApiParameters(Method method,
                                                      boolean includeUrlParameters,
                                                      boolean includeNonUrlParameters)

Description copied from class: ResourceParser

Allows children to specify which parameters within a method should be included in API generation

Specified by:

getApiParameters in class ResourceParser

Parameters:

method - The method to inspect

includeUrlParameters - If true this will include URL parameters

includeNonUrlParameters - If true this will include query and body params

Returns:

A list of request parameters for this API

isParameter

protected boolean isParameter(Parameter param)

isPathParameter

protected boolean isPathParameter(Parameter param)

isNonPathParameter

protected boolean isNonPathParameter(Parameter param)

isQueryParameter

protected boolean isQueryParameter(Parameter param)

Description copied from class: ResourceParser

Allows children to specify whether a parameter should be included when generating query parameters for a method

Specified by:

isQueryParameter in class ResourceParser

Parameters:

param - The the Parameter to be checked

Returns:

IF true this is a parameter that shuold be appended in the query string

getPathDescriptionsForMethod

protected Map<String,String> getPathDescriptionsForMethod(Method method)

Checks for instances of @Description annotations in

Parameters:

method - The method to Inspect

Returns:

a Map of Description and Partial URL Keys

extractResourceIdParameter

protected ApiParameterMetadata[] extractResourceIdParameter(Method method)

Description copied from class: ResourceParser

Queries the parameters in the Method and checks for an AjaxParameter Annotation with the resource Id flag enabled

Specified by:

extractResourceIdParameter in class ResourceParser

Parameters:

method - The Method to be inspected

Returns:

A list of parameters that are exposed in the API

getHttpMethodAndName

protected Map<RamlActionType,String> getHttpMethodAndName(Class<?> clazz,
                                                          Method method)

Description copied from class: ResourceParser

Extracts the http method (verb) as well as the name of the api call

Specified by:

getHttpMethodAndName in class ResourceParser

Parameters:

clazz - The controller class

method - The Method to inspect

Returns:

The Verb and Name (partial url if a resource needs to be created) of this method

isActionOnResourceWithoutCommand

protected boolean isActionOnResourceWithoutCommand(Method method)

Description copied from class: ResourceParser

Checks is this api call is made directly on a resource without a trailing command in the URL. eg: POST on /myResource/

Specified by:

isActionOnResourceWithoutCommand in class ResourceParser

Parameters:

method - The method to check

Returns:

If true then this is an Action/Verb on a resource collection

getResourceName

protected String getResourceName(Class<?> clazz)

Description copied from class: ResourceParser

Extracts the name of the resource that this class manages

Specified by:

getResourceName in class ResourceParser

Parameters:

clazz - The Class to inspect

Returns:

The name of the resource this class maps to

extractAndAppendResourceInfo

protected void extractAndAppendResourceInfo(Class<?> clazz,
                                            Method method,
                                            JavaDocEntry docEntry,
                                            RamlResource parentResource)

Description copied from class: ResourceParser

Extracts relevant info from a Java method and converts it into a RAML resource

Specified by:

extractAndAppendResourceInfo in class ResourceParser

Parameters:

clazz - The controller class

method - The Java method to introspect

docEntry - The associated JavaDoc (may be null)

parentResource - The Resource which contains this method

addHeadersForMethod

protected void addHeadersForMethod(RamlAction action,
                                   RamlActionType actionType,
                                   Method method)

Description copied from class: ResourceParser

Allows children to add common headers to API methods (eg CSRF, Authorization)

Specified by:

addHeadersForMethod in class ResourceParser

Parameters:

action - The action to be modified

actionType - The verb of the Action

method - The method to inspect for headers