com.phoenixnap.oss.ramlapisync.naming

Class SchemaHelper

java.lang.Object

com.phoenixnap.oss.ramlapisync.naming.SchemaHelper

public class SchemaHelper
extends Object

Class containing convenience methods relating to the extracting of information from Java types for use as Parameters. These can either be decomposed into RAML Simple Types (Similar to Java primitives) or JSON Schema for more complex objects

Since:

0.0.1

Author:

Kurt Paris

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
SchemaHelper()

Method Summary

Modifier and Type	Method and Description
static com.sun.codemodel.JCodeModel	buildBodyJCodeModel(String basePackage, String schemaLocation, String name, String schema, org.jsonschema2pojo.GenerationConfig config, org.jsonschema2pojo.Annotator annotator) Builds a JCodeModel for classes that will be used as Request or Response bodies
static boolean	containsBodySchema(Map<String,RamlMimeType> body, RamlRoot document, boolean checkForValidSchema) Checks if a Map of mime types contains at least 1 valid JsonSchema.
static String	convertClassToJsonSchema(ApiParameterMetadata clazz, String responseDescription, JavaDocStore javaDocStore) Uses Jackson object mappers to convert an ajaxcommandparameter annotated type into its JSONSchema representation.
static String	convertClassToJsonSchema(Type clazz, String responseDescription, JavaDocStore javaDocStore) Uses Jackson object mappers to convert a Pojo into its JSONSchema representation.
static Map<String,RamlQueryParameter>	convertClassToQueryParameters(Parameter param, JavaDocStore javaDocStore) Breaks down a class into component fields which are mapped as Query Parameters.
static Map<String,RamlQueryParameter>	convertParameterToQueryParameter(Parameter param, String paramComment) Converts a simple parameter, ie String, or Boxed Primitive into
static String	extractNameFromSchema(String schema, String schemaName, String fallbackName) Extracts the name from a schema in this order of precedence: 1.
static org.jsonschema2pojo.GenerationConfig	getDefaultGenerationConfig() Returns a configuration for the JSON Schema 2 POJO that is in line with the defaults used in the plugin so far
static org.jsonschema2pojo.GenerationConfig	getGenerationConfig(Boolean generateBuilders, Boolean includeAdditionalProperties, Boolean includeDynamicAccessors, Boolean useLongIntegers) Returns a generation config with the supplied parameters.
static ApiBodyMetadata	mapSchemaToPojo(RamlRoot document, String schema, String basePackage, String name, String schemaLocation) Maps a JSON Schema to a JCodeModel using JSONSchema2Pojo and encapsulates it along with some metadata into an ApiBodyMetadata object.
static RamlParamType	mapSimpleType(Class<?> clazz) Maps primitives and other simple Java types into simple types supported by RAML
static Class<?>	mapSimpleType(RamlParamType param) Maps simple types supported by RAML into primitives and other simple Java types
static String	resolveSchema(String schema, RamlRoot document) Utility method that will return a schema if the identifier is valid and exists in the raml file definition.

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

Constructor Detail

SchemaHelper

public SchemaHelper()

Method Detail

convertParameterToQueryParameter

public static Map<String,RamlQueryParameter> convertParameterToQueryParameter(Parameter param,
                                                                              String paramComment)

Converts a simple parameter, ie String, or Boxed Primitive into

Parameters:

param - The Java Parameter to convert

paramComment - The associated Javadoc if any

Returns:

A map of query parameters that map into the supplied type

resolveSchema

public static String resolveSchema(String schema,
                                   RamlRoot document)

Utility method that will return a schema if the identifier is valid and exists in the raml file definition.

Parameters:

schema - The name of the schema to resolve

document - The Parent Raml Document

Returns:

The full schema if contained in the raml document or null if not found

convertClassToQueryParameters

public static Map<String,RamlQueryParameter> convertClassToQueryParameters(Parameter param,
                                                                           JavaDocStore javaDocStore)

Breaks down a class into component fields which are mapped as Query Parameters. If Javadoc is supplied, this will be injected as comments

Parameters:

param - The Parameter representing the class to be converted into query parameters

javaDocStore - The associated JavaDoc (if any)

Returns:

a Map of Parameter RAML models keyed by parameter name

convertClassToJsonSchema

public static String convertClassToJsonSchema(ApiParameterMetadata clazz,
                                              String responseDescription,
                                              JavaDocStore javaDocStore)

Uses Jackson object mappers to convert an ajaxcommandparameter annotated type into its JSONSchema representation. If Javadoc is supplied, this will be injected as comments

Parameters:

clazz - The Class to convert

responseDescription - The javadoc description supplied if available

javaDocStore - The Entire java doc store available

Returns:

A string containing the Json Schema

convertClassToJsonSchema

public static String convertClassToJsonSchema(Type clazz,
                                              String responseDescription,
                                              JavaDocStore javaDocStore)

Uses Jackson object mappers to convert a Pojo into its JSONSchema representation. If Javadoc is supplied, this will be injected as comments

Parameters:

clazz - The Class to be inspected

responseDescription - The description to be embedded in the response

javaDocStore - Associated JavaDoc for this class that can be embedded in the schema

Returns:

Json Schema representing the class in string format

mapSimpleType

public static RamlParamType mapSimpleType(Class<?> clazz)

Maps primitives and other simple Java types into simple types supported by RAML

Parameters:

clazz - The Class to map

Returns:

The Simple RAML ParamType which maps to this class or null if one is not found

mapSimpleType

public static Class<?> mapSimpleType(RamlParamType param)

Maps simple types supported by RAML into primitives and other simple Java types

Parameters:

param - The Type to map

Returns:

The Java Class which maps to this Simple RAML ParamType or string if one is not found

extractNameFromSchema

public static String extractNameFromSchema(String schema,
                                           String schemaName,
                                           String fallbackName)

Extracts the name from a schema in this order of precedence: 1. If the schema contains an ID element 2. The name of the schema within the RAML document 3. The autogenerated name based on the enclosing method

Parameters:

schema - The Actual JSON Schema

schemaName - The name of the schema within the document

fallbackName - any arbitrary name

Returns:

The Name for this Class (POJO)

mapSchemaToPojo

public static ApiBodyMetadata mapSchemaToPojo(RamlRoot document,
                                              String schema,
                                              String basePackage,
                                              String name,
                                              String schemaLocation)

Maps a JSON Schema to a JCodeModel using JSONSchema2Pojo and encapsulates it along with some metadata into an ApiBodyMetadata object.

Parameters:

document - The Raml document being parsed

schema - The Schema (full schema or schema name to be resolved)

basePackage - The base package for the classes we are generating

name - The suggested name of the class based on the api call and whether it's a request/response. This will only be used if no suitable alternative is found in the schema

schemaLocation - Base location of this schema, will be used to create absolute URIs for $ref tags eg "classpath:/"

Returns:

Object representing this Body

buildBodyJCodeModel

public static com.sun.codemodel.JCodeModel buildBodyJCodeModel(String basePackage,
                                                               String schemaLocation,
                                                               String name,
                                                               String schema,
                                                               org.jsonschema2pojo.GenerationConfig config,
                                                               org.jsonschema2pojo.Annotator annotator)

Builds a JCodeModel for classes that will be used as Request or Response bodies

Parameters:

basePackage - The package we will be using for the domain objects

schemaLocation - The location of this schema, will be used to create absolute URIs for $ref tags eg "classpath:/"

name - The class name

schema - The JSON Schema representing this class

config - JsonSchema2Pojo configuration. if null a default config will be used

annotator - JsonSchema2Pojo annotator. if null a default annotator will be used

Returns:

built JCodeModel

getDefaultGenerationConfig

public static org.jsonschema2pojo.GenerationConfig getDefaultGenerationConfig()

Returns a configuration for the JSON Schema 2 POJO that is in line with the defaults used in the plugin so far

Returns:

Default Generation Config

getGenerationConfig

public static org.jsonschema2pojo.GenerationConfig getGenerationConfig(Boolean generateBuilders,
                                                                       Boolean includeAdditionalProperties,
                                                                       Boolean includeDynamicAccessors,
                                                                       Boolean useLongIntegers)

Returns a generation config with the supplied parameters. If any of these parameters are supplied null, it will use the value defined in the default configuration

Parameters:

generateBuilders - Enables or disables GenerationConfig.isGenerateBuilders()

includeAdditionalProperties - Enables or disables GenerationConfig.isIncludeAdditionalProperties()

includeDynamicAccessors - Enables or disables GenerationConfig.isIncludeDynamicAccessors()

useLongIntegers - Enables or disables GenerationConfig.isUseLongIntegers()

Returns:

The GenerationConfig

containsBodySchema

public static boolean containsBodySchema(Map<String,RamlMimeType> body,
                                         RamlRoot document,
                                         boolean checkForValidSchema)

Checks if a Map of mime types contains at least 1 valid JsonSchema.

Parameters:

body - The request/response body

document - the RAML document being checked

checkForValidSchema - if false, we will omit checks to see if the schema is valid

Returns:

true if at least 1 valid schema exists