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

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.operation.AbstractSdkOperation

All Implemented Interfaces:

SdkValueProvidable

Direct Known Subclasses:

AbstractSdkPaginationOperation, SdkNativeOperation, SdkOperation

public abstract class AbstractSdkOperation
extends JavaTemplateEntity
implements SdkValueProvidable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSdkOperation.MessageOutputType
static class	AbstractSdkOperation.ParametersBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPT_HEADER_NAME
static String	ADD_HEADER_METHOD_NAME
static String	ADD_QUERY_PARAM_METHOD_NAME
static String	ADD_URI_PARAM_METHOD_NAME
protected List<SdkField>	allBodyFields
protected List<SdkParameter>	allHeaders
protected List<SdkParameter>	allQueryParameters
protected List<SdkParameter>	allUriParameters
protected List<SdkParameter>	auxParameters
protected SdkContent	content
static String	CONTENT_TYPE_HEADER_NAME
protected static String	CUSTOM_PARAMETER_BINDINGS_NAME
protected com.mulesoft.connectivity.rest.sdk.internal.connectormodel.operation.ConnectorOperation	operation
static String	OPERATION_CLASSNAME_SUFFIX
static String	OPERATION_PATH_FIELD
protected SdkOutputMetadataResolver	outputMetadataResolver
static String	PARAM_DOC_NAME_DESCRIPTION
protected static String	PARAMETER_BINDINGS_NAME
protected SdkResolverTemplate	sampleDataProvider

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, REFINEMENT_CLASSNAME_SUFFIX, REFINEMENT_PACKAGE_SUFFIX, 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.operation.ConnectorOperation operation, RestSdkRunConfiguration runConfiguration)

Method Summary

Modifier and Type	Method and Description
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.operation.ConnectorOperation operation)
protected static AbstractSdkOperation.ParametersBuilder	builder()
protected void	configureClassBuilder(com.squareup.javapoet.TypeSpec.Builder operationClassBuilder)
protected void	configureJavaFileBuilder(com.squareup.javapoet.JavaFile.Builder javaFileBuilder)
protected com.squareup.javapoet.CodeBlock	generateAuxParameterBindings()
protected com.squareup.javapoet.MethodSpec	generateBaseMainMethod()
protected AbstractSdkOperation.ParametersBuilder	generateBaseMainMethodParameters()
protected void	generateCatchStatement(Class exception, String codeBlock, com.squareup.javapoet.MethodSpec.Builder methodBody, Object... args)
protected org.apache.commons.lang3.tuple.Pair<List<com.squareup.javapoet.ParameterSpec>,com.squareup.javapoet.CodeBlock.Builder>	generateContentParameters(boolean withAnnotations)
abstract com.squareup.javapoet.TypeName	generateMethodReturn()
protected void	generateOperationBaseLayer()
protected com.squareup.javapoet.MethodSpec	generateOperationBaseMethod()
protected void	generateOperationImplementationLayer()
com.squareup.javapoet.MethodSpec	generateOperationImplementationMethod()
com.squareup.javapoet.CodeBlock	generateOperationImplementationMethodBody(List<com.squareup.javapoet.ParameterSpec> parameters, com.squareup.javapoet.TypeName typeName)
protected org.apache.commons.lang3.tuple.Pair<List<com.squareup.javapoet.ParameterSpec>,com.squareup.javapoet.CodeBlock.Builder>	generateOperationImplementationMethodParameters()
protected void	generateOperationInterceptorLayer()
com.squareup.javapoet.CodeBlock	generateOperationMainCall(com.squareup.javapoet.TypeName returnType)
protected List<String>	generateOperationMainCallParameters()
abstract com.squareup.javapoet.CodeBlock	generateOperationMethodBaseMainBody()
protected void	generateOperationMethodsFlow(com.squareup.javapoet.TypeSpec.Builder operationClassBuilder)
protected List<SdkParameter>	generateQueryParameters()
com.squareup.javapoet.CodeBlock	generateRestRequestBuilder()
protected void	generateTryStatement(com.squareup.javapoet.MethodSpec.Builder methodBody, boolean start)
List<SdkField>	getAllBodyFields()
List<SdkParameter>	getAllParameters() Returns all the parameters of this operation (URI + QUERY + HEADER)
String	getBasePackage()
com.mulesoft.connectivity.rest.sdk.internal.connectormodel.operation.ConnectorOperation	getConnectorOperation()
String	getInterceptorPackage()
String	getJavaBaseClassName()
String	getJavaClassName()
String	getJavaInterceptorClassName()
protected String	getJavaMethodName()
protected AbstractSdkOperation.MessageOutputType	getMessageOutputType() Utility method to encapsulate how the "return" type (or the output of the current operation's types) is calculated
com.mulesoft.connectivity.rest.sdk.internal.connectormodel.operation.ConnectorOperation	getOperation()
String	getPackage()
protected com.squareup.javapoet.CodeBlock	getParameterValueStatement(SdkParameter parameter)
protected Class<? extends com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation>	getSuperclass()
protected boolean	hasOutput()
protected boolean	isQueryParamDefinedInPagination(String paramName)
protected boolean	isVoidOperation()
protected boolean	operationMethodRequiresBody()
protected boolean	requiresMediaTypeAnnotation()
protected boolean	returnNullOnNotFoundError()
protected com.squareup.javapoet.CodeBlock	toCursorProviderMapCodeBlock(String... localVariables)

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

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_URI_PARAM_METHOD_NAME

public static final String ADD_URI_PARAM_METHOD_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

OPERATION_PATH_FIELD

public static final String OPERATION_PATH_FIELD

See Also:

Constant Field Values

PARAMETER_BINDINGS_NAME

protected static final String PARAMETER_BINDINGS_NAME

See Also:

Constant Field Values

CUSTOM_PARAMETER_BINDINGS_NAME

protected static final String CUSTOM_PARAMETER_BINDINGS_NAME

See Also:

Constant Field Values

OPERATION_CLASSNAME_SUFFIX

public static final String OPERATION_CLASSNAME_SUFFIX

See Also:

Constant Field Values

operation

protected final com.mulesoft.connectivity.rest.sdk.internal.connectormodel.operation.ConnectorOperation operation

allUriParameters

protected final List<SdkParameter> allUriParameters

allQueryParameters

protected final List<SdkParameter> allQueryParameters

allHeaders

protected final List<SdkParameter> allHeaders

auxParameters

protected final List<SdkParameter> auxParameters

allBodyFields

protected final List<SdkField> allBodyFields

content

protected final SdkContent content

outputMetadataResolver

protected final SdkOutputMetadataResolver outputMetadataResolver

sampleDataProvider

protected final SdkResolverTemplate 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.operation.ConnectorOperation operation,
                            RestSdkRunConfiguration runConfiguration)
                     throws TemplatingException

Throws:

TemplatingException

Method Detail

generateMethodReturn

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

generateOperationMethodBaseMainBody

public abstract com.squareup.javapoet.CodeBlock generateOperationMethodBaseMainBody()
                                                                             throws TemplatingException

Throws:

TemplatingException

getOperation

public com.mulesoft.connectivity.rest.sdk.internal.connectormodel.operation.ConnectorOperation getOperation()

toCursorProviderMapCodeBlock

protected com.squareup.javapoet.CodeBlock toCursorProviderMapCodeBlock(String... localVariables)

buildContent

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

Throws:

TemplatingException

getJavaClassName

public String getJavaClassName()

Specified by:

getJavaClassName in interface SdkValueProvidable

getJavaBaseClassName

public String getJavaBaseClassName()

getJavaInterceptorClassName

public String getJavaInterceptorClassName()

getJavaMethodName

protected String getJavaMethodName()

getPackage

public String getPackage()

getInterceptorPackage

public String getInterceptorPackage()

getBasePackage

public String getBasePackage()

applyTemplates

public void applyTemplates()
                    throws TemplatingException

Specified by:

applyTemplates in class TemplateEntity

Throws:

TemplatingException

generateOperationImplementationLayer

protected void generateOperationImplementationLayer()
                                             throws TemplatingException

Throws:

TemplatingException

generateOperationInterceptorLayer

protected void generateOperationInterceptorLayer()
                                          throws TemplatingException

Throws:

TemplatingException

generateOperationMethodsFlow

protected void generateOperationMethodsFlow(com.squareup.javapoet.TypeSpec.Builder operationClassBuilder)
                                     throws TemplatingException

Throws:

TemplatingException

generateOperationBaseLayer

protected void generateOperationBaseLayer()
                                   throws TemplatingException

Throws:

TemplatingException

configureJavaFileBuilder

protected void configureJavaFileBuilder(com.squareup.javapoet.JavaFile.Builder javaFileBuilder)

configureClassBuilder

protected void configureClassBuilder(com.squareup.javapoet.TypeSpec.Builder operationClassBuilder)

getSuperclass

protected Class<? extends com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation> getSuperclass()

generateOperationImplementationMethodParameters

protected org.apache.commons.lang3.tuple.Pair<List<com.squareup.javapoet.ParameterSpec>,com.squareup.javapoet.CodeBlock.Builder> generateOperationImplementationMethodParameters()

generateOperationImplementationMethod

public com.squareup.javapoet.MethodSpec generateOperationImplementationMethod()
                                                                       throws TemplatingException

Throws:

TemplatingException

generateOperationMainCallParameters

protected List<String> generateOperationMainCallParameters()

generateOperationMainCall

public com.squareup.javapoet.CodeBlock generateOperationMainCall(com.squareup.javapoet.TypeName returnType)

generateOperationBaseMethod

protected com.squareup.javapoet.MethodSpec generateOperationBaseMethod()
                                                                throws TemplatingException

Throws:

TemplatingException

generateContentParameters

protected org.apache.commons.lang3.tuple.Pair<List<com.squareup.javapoet.ParameterSpec>,com.squareup.javapoet.CodeBlock.Builder> generateContentParameters(boolean withAnnotations)

isQueryParamDefinedInPagination

protected boolean isQueryParamDefinedInPagination(String paramName)

generateOperationImplementationMethodBody

public com.squareup.javapoet.CodeBlock generateOperationImplementationMethodBody(List<com.squareup.javapoet.ParameterSpec> parameters,
                                                                                 com.squareup.javapoet.TypeName typeName)
                                                                          throws TemplatingException

Throws:

TemplatingException

generateTryStatement

protected void generateTryStatement(com.squareup.javapoet.MethodSpec.Builder methodBody,
                                    boolean start)

generateCatchStatement

protected void generateCatchStatement(Class exception,
                                      String codeBlock,
                                      com.squareup.javapoet.MethodSpec.Builder methodBody,
                                      Object... args)

generateRestRequestBuilder

public com.squareup.javapoet.CodeBlock generateRestRequestBuilder()

addSetBodyMethod

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

getParameterValueStatement

protected com.squareup.javapoet.CodeBlock getParameterValueStatement(SdkParameter parameter)

returnNullOnNotFoundError

protected boolean returnNullOnNotFoundError()

getMessageOutputType

protected AbstractSdkOperation.MessageOutputType getMessageOutputType()

Utility method to encapsulate how the "return" type (or the output of the current operation's types) is calculated

operationMethodRequiresBody

protected boolean operationMethodRequiresBody()

isVoidOperation

protected boolean isVoidOperation()

requiresMediaTypeAnnotation

protected boolean requiresMediaTypeAnnotation()

hasOutput

protected boolean hasOutput()

getAllParameters

public List<SdkParameter> getAllParameters()

Returns all the parameters of this operation (URI + QUERY + HEADER)

Specified by:

getAllParameters in interface SdkValueProvidable

getAllBodyFields

public List<SdkField> getAllBodyFields()

getConnectorOperation

public com.mulesoft.connectivity.rest.sdk.internal.connectormodel.operation.ConnectorOperation getConnectorOperation()

generateQueryParameters

protected List<SdkParameter> generateQueryParameters()

generateAuxParameterBindings

protected com.squareup.javapoet.CodeBlock generateAuxParameterBindings()

generateBaseMainMethodParameters

protected AbstractSdkOperation.ParametersBuilder generateBaseMainMethodParameters()

generateBaseMainMethod

protected com.squareup.javapoet.MethodSpec generateBaseMainMethod()
                                                           throws TemplatingException

Throws:

TemplatingException

builder

protected static AbstractSdkOperation.ParametersBuilder builder()