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

Class AbstractSdkOperation

java.lang.Object

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

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

com.mulesoft.connectivity.rest.sdk.templating.sdk.AbstractSdkOperation

Direct Known Subclasses:

AbstractSdkPaginationOperation, SdkOperation

public abstract class AbstractSdkOperation
extends JavaTemplateEntity

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPT_HEADER_NAME
static String	ADD_HEADER_METHOD_NAME
static String	ADD_MULTIPLE_HEADER_METHOD_NAME
static String	ADD_MULTIPLE_QUERY_PARAM_METHOD_NAME
static String	ADD_QUERY_PARAM_METHOD_NAME
protected List<SdkParameter>	allHeaders
protected List<SdkParameter>	allPathParameters
protected List<SdkParameter>	allQueryParameters
protected SdkContent	content
static String	CONTENT_TYPE_HEADER_NAME
protected SdkOutputMetadataResolver	outputMetadataResolver
static String	PARAM_DOC_NAME_DESCRIPTION
protected SdkSampleDataProvider	sampleDataProvider

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

connectorModel, NAME_MEMBER, outputDir, runConfiguration, VALUE_MEMBER

Constructor Summary

Constructors

Constructor and Description
AbstractSdkOperation(Path outputDir, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel, SdkConnector sdkConnector, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorOperation operation, RestSdkRunConfiguration runConfiguration)

Method Summary

Modifier and Type	Method and Description
protected void	addContentParameters(com.squareup.javapoet.CodeBlock.Builder javaDoc, com.squareup.javapoet.MethodSpec.Builder methodBuilder)
protected void	addSetBodyMethod(com.squareup.javapoet.CodeBlock.Builder methodBody)
void	applyTemplates()
protected SdkContent	buildContent(Path outputDir, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel, SdkConnector sdkConnector, com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorOperation operation)
com.squareup.javapoet.CodeBlock.Builder	generateCommonOperationMethodBody()
abstract com.squareup.javapoet.FieldSpec	generateExpressionLanguageField()
abstract com.squareup.javapoet.ParameterSpec	generateInitialPagingParameter()
abstract com.squareup.javapoet.TypeName	generateMethodReturn()
protected void	generateOperationClass()
com.squareup.javapoet.MethodSpec	generateOperationMethod()
abstract com.squareup.javapoet.CodeBlock	generateOperationMethodBody()
String	getJavaClassName()
String	getPackage()
SdkParameter	getSdkParameter(com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.ParameterType parameterType, String parameterName)
protected boolean	isVoidOperation()
protected boolean	operationMethodRequiresBody()
protected boolean	requiresCallbackParameter()
protected boolean	requiresConnectionParameter()
protected boolean	requiresMediaTypeAnnotation()

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

generateGetter, generateOptionalGetter, getConstantStringField, getJavaFileBuilderForClass, getJavaType, getResourcesPath, getSourcesPath, writeClassToFile, 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

PARAM_DOC_NAME_DESCRIPTION

public static final String PARAM_DOC_NAME_DESCRIPTION

See Also:

Constant Field Values

CONTENT_TYPE_HEADER_NAME

public static final String CONTENT_TYPE_HEADER_NAME

See Also:

Constant Field Values

ACCEPT_HEADER_NAME

public static final String ACCEPT_HEADER_NAME

See Also:

Constant Field Values

ADD_QUERY_PARAM_METHOD_NAME

public static final String ADD_QUERY_PARAM_METHOD_NAME

See Also:

Constant Field Values

ADD_HEADER_METHOD_NAME

public static final String ADD_HEADER_METHOD_NAME

See Also:

Constant Field Values

ADD_MULTIPLE_QUERY_PARAM_METHOD_NAME

public static final String ADD_MULTIPLE_QUERY_PARAM_METHOD_NAME

See Also:

Constant Field Values

ADD_MULTIPLE_HEADER_METHOD_NAME

public static final String ADD_MULTIPLE_HEADER_METHOD_NAME

See Also:

Constant Field Values

allPathParameters

protected final List<SdkParameter> allPathParameters

allQueryParameters

protected final List<SdkParameter> allQueryParameters

allHeaders

protected final List<SdkParameter> allHeaders

content

protected final SdkContent content

outputMetadataResolver

protected final SdkOutputMetadataResolver outputMetadataResolver

sampleDataProvider

protected final SdkSampleDataProvider sampleDataProvider

Constructor Detail

AbstractSdkOperation

public AbstractSdkOperation(Path outputDir,
                            com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel,
                            SdkConnector sdkConnector,
                            com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorOperation operation,
                            RestSdkRunConfiguration runConfiguration)
                     throws TemplatingException

Throws:

TemplatingException

Method Detail

generateExpressionLanguageField

public abstract com.squareup.javapoet.FieldSpec generateExpressionLanguageField()

generateInitialPagingParameter

public abstract com.squareup.javapoet.ParameterSpec generateInitialPagingParameter()

generateMethodReturn

public abstract com.squareup.javapoet.TypeName generateMethodReturn()

generateOperationMethodBody

public abstract com.squareup.javapoet.CodeBlock generateOperationMethodBody()

buildContent

protected SdkContent buildContent(Path outputDir,
                                  com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorModel connectorModel,
                                  SdkConnector sdkConnector,
                                  com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorOperation operation)
                           throws TemplatingException

Throws:

TemplatingException

getJavaClassName

public String getJavaClassName()

getPackage

public String getPackage()

applyTemplates

public void applyTemplates()
                    throws TemplatingException

Specified by:

applyTemplates in class TemplateEntity

Throws:

TemplatingException

generateOperationClass

protected void generateOperationClass()
                               throws TemplatingException

Throws:

TemplatingException

generateOperationMethod

public com.squareup.javapoet.MethodSpec generateOperationMethod()

addContentParameters

protected void addContentParameters(com.squareup.javapoet.CodeBlock.Builder javaDoc,
                                    com.squareup.javapoet.MethodSpec.Builder methodBuilder)

generateCommonOperationMethodBody

public com.squareup.javapoet.CodeBlock.Builder generateCommonOperationMethodBody()

addSetBodyMethod

protected void addSetBodyMethod(com.squareup.javapoet.CodeBlock.Builder methodBody)

operationMethodRequiresBody

protected boolean operationMethodRequiresBody()

isVoidOperation

protected boolean isVoidOperation()

requiresConnectionParameter

protected boolean requiresConnectionParameter()

requiresCallbackParameter

protected boolean requiresCallbackParameter()

requiresMediaTypeAnnotation

protected boolean requiresMediaTypeAnnotation()

getSdkParameter

public SdkParameter getSdkParameter(com.mulesoft.connectivity.rest.sdk.internal.connectormodel.parameter.ParameterType parameterType,
                                    String parameterName)