com.mulesoft.connectivity.rest.sdk.templating.sdk.metadata

Class SdkAbstractStaticMetadataResolver

java.lang.Object

com.mulesoft.connectivity.rest.sdk.templating.TemplateEntity

com.mulesoft.connectivity.rest.sdk.templating.JavaTemplateEntity

com.mulesoft.connectivity.rest.sdk.templating.sdk.metadata.SdkAbstractStaticMetadataResolver

All Implemented Interfaces:

SdkMetadataResolver

Direct Known Subclasses:

SdkInputMetadataResolver, SdkOutputMetadataResolver

public abstract class SdkAbstractStaticMetadataResolver
extends JavaTemplateEntity
implements SdkMetadataResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>	superclass

Fields inherited from class com.mulesoft.connectivity.rest.sdk.templating.JavaTemplateEntity

BASE_CLASSNAME_SUFFIX, BASE_PACKAGE_SUFFIX, connectorModel, FIRST_GENERATION_TEMPLATE, IGNORED_OVERRIDE_TEMPLATE, IGNORED_REFINEMENT_TEMPLATE, NAME_MEMBER, outputDir, PAYLOAD_BINDING, PAYLOAD_DOT_BINDING, REFINEMENT_CLASSNAME_SUFFIX, REFINEMENT_PACKAGE_SUFFIX, runConfiguration, VALUE_MEMBER

Constructor Summary

Constructors

Constructor and Description

SdkAbstractStaticMetadataResolver(Path outputDir, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel, SdkConnector sdkConnector, String internalName, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.type.TypeDefinition typeDefinition, FileGenerationUtil.SchemaNameType schemaNameType, String partName, String classNameOverride, RestSdkRunConfiguration runConfiguration) Creates a type resolver that will generate a schema file in the resources directory if needed.

Method Summary

Modifier and Type	Method and Description
void	applyTemplates()
protected abstract String	buildGetResolverName(String internalName)
protected boolean	buildRequiresMetadataResolver()
protected abstract Class<?>	buildSuperclass(com.mulesoft.connectivity.rest.sdk.internal.connectormodel.type.TypeDefinition typeDefinition)
protected void	generateMethods(com.squareup.javapoet.TypeSpec.Builder typeResolverClassBuilder)
String	getClassName()
protected abstract String	getClassNameSuffix()
String	getPackage()
protected abstract String	getQName()
boolean	getRequiresMetadataResolver()
String	getSchemaName()
protected String	getSchemaName(String internalName, FileGenerationUtil.SchemaNameType schemaNameType, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.type.schema.TypeSchema source, String partName)
com.mulesoft.connectivity.rest.sdk.internal.connectormodel.type.TypeDefinition	getTypeDefinition()
protected abstract boolean	requiresFormatMethod()
protected abstract boolean	requiresQNameMethod()
protected abstract boolean	requiresToWriteSchema()

Methods inherited from class com.mulesoft.connectivity.rest.sdk.templating.JavaTemplateEntity

generateOptionalGetter, getArgumentsFromValueProvider, getArgumentsFromValueProviderDefinition, getConstantStringField, getConstantStringField, getJavaFileBuilderForClass, getJavaType, getResourcesPath, getSourcesPath, getValueProviderAnnotation, writeClassToFile, writeClassToFile, writeJavaFile, writeJavaFile

Methods inherited from class com.mulesoft.connectivity.rest.sdk.templating.TemplateEntity

getTemplateEngine

Methods inherited from class java.lang.Object

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

Field Detail

superclass

protected Class<?> superclass

Constructor Detail

SdkAbstractStaticMetadataResolver

public SdkAbstractStaticMetadataResolver(Path outputDir,
                                         com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel,
                                         SdkConnector sdkConnector,
                                         String internalName,
                                         com.mulesoft.connectivity.rest.sdk.internal.connectormodel.type.TypeDefinition typeDefinition,
                                         FileGenerationUtil.SchemaNameType schemaNameType,
                                         String partName,
                                         String classNameOverride,
                                         RestSdkRunConfiguration runConfiguration)
                                  throws TemplatingException

Creates a type resolver that will generate a schema file in the resources directory if needed.

Parameters:

sdkConnector - the parent SdkConnector for this type

typeDefinition - The type definition which this metadata will be created for

internalName - The internal name of the container. It will be used to generate the schema name.

schemaNameType - The type of name that this schema will get.

partName - When this schema corresponds to a multipart part, this part name will be used to generate the schema name. Must be an empty string if it he type definition does not correspond to a part.

classNameOverride - When specified forces the class name to be generated based on this instead of using the operation and part names.

runConfiguration - The configuration for this execution of the connector generation.

Throws:

TemplatingException

Method Detail

buildGetResolverName

protected abstract String buildGetResolverName(String internalName)

getSchemaName

protected String getSchemaName(String internalName,
                               FileGenerationUtil.SchemaNameType schemaNameType,
                               com.mulesoft.connectivity.rest.sdk.internal.connectormodel.type.schema.TypeSchema source,
                               String partName)

buildSuperclass

protected abstract Class<?> buildSuperclass(com.mulesoft.connectivity.rest.sdk.internal.connectormodel.type.TypeDefinition typeDefinition)
                                     throws TemplatingException

Throws:

TemplatingException

getClassNameSuffix

protected abstract String getClassNameSuffix()

getClassName

public String getClassName()

Specified by:

getClassName in interface SdkMetadataResolver

getPackage

public String getPackage()

Specified by:

getPackage in interface SdkMetadataResolver

applyTemplates

public void applyTemplates()
                    throws TemplatingException

Specified by:

applyTemplates in interface SdkMetadataResolver

Specified by:

applyTemplates in class TemplateEntity

Throws:

TemplatingException

generateMethods

protected void generateMethods(com.squareup.javapoet.TypeSpec.Builder typeResolverClassBuilder)

requiresQNameMethod

protected abstract boolean requiresQNameMethod()

requiresFormatMethod

protected abstract boolean requiresFormatMethod()

getQName

protected abstract String getQName()

buildRequiresMetadataResolver

protected boolean buildRequiresMetadataResolver()

getRequiresMetadataResolver

public boolean getRequiresMetadataResolver()

Specified by:

getRequiresMetadataResolver in interface SdkMetadataResolver

requiresToWriteSchema

protected abstract boolean requiresToWriteSchema()

getSchemaName

public String getSchemaName()

Specified by:

getSchemaName in interface SdkMetadataResolver

getTypeDefinition

public com.mulesoft.connectivity.rest.sdk.internal.connectormodel.type.TypeDefinition getTypeDefinition()

Specified by:

getTypeDefinition in interface SdkMetadataResolver