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

Class AbstractSdkPaginationOperation

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

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

All Implemented Interfaces:

SdkPaginationStrategy, SdkValueProvidable

Direct Known Subclasses:

SdkHypermediaPaginationOperation, SdkMarkerPaginationOperation, SdkOffsetPaginationOperation, SdkPageNumberPaginationOperation

public abstract class AbstractSdkPaginationOperation
extends AbstractSdkOperation
implements SdkPaginationStrategy

Nested Class Summary

Nested classes/interfaces inherited from class com.mulesoft.connectivity.rest.sdk.templating.sdk.operation.AbstractSdkOperation

AbstractSdkOperation.MessageOutputType, AbstractSdkOperation.ParametersBuilder

Field Summary

Fields inherited from class com.mulesoft.connectivity.rest.sdk.templating.sdk.operation.AbstractSdkOperation

ACCEPT_HEADER_NAME, ADD_HEADER_METHOD_NAME, ADD_QUERY_PARAM_METHOD_NAME, ADD_URI_PARAM_METHOD_NAME, allBodyFields, allHeaders, allQueryParameters, allUriParameters, auxParameters, content, CONTENT_TYPE_HEADER_NAME, CUSTOM_PARAMETER_BINDINGS_NAME, operation, OPERATION_CLASSNAME_SUFFIX, OPERATION_PATH_FIELD, outputMetadataResolver, PARAM_DOC_NAME_DESCRIPTION, PARAMETER_BINDINGS_NAME, 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
AbstractSdkPaginationOperation(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	addResponseBindings(com.squareup.javapoet.CodeBlock.Builder block)
protected AbstractSdkOperation.ParametersBuilder	generateBaseMainMethodParameters()
com.squareup.javapoet.TypeName	generateMethodReturn()
protected com.squareup.javapoet.MethodSpec	generateOperationBaseMethod()
protected org.apache.commons.lang3.tuple.Pair<List<com.squareup.javapoet.ParameterSpec>,com.squareup.javapoet.CodeBlock.Builder>	generateOperationImplementationMethodParameters()
protected List<String>	generateOperationMainCallParameters()
com.squareup.javapoet.CodeBlock	generateOperationMethodBaseMainBody()
protected void	generateOperationMethodsFlow(com.squareup.javapoet.TypeSpec.Builder operationClassBuilder)
com.squareup.javapoet.MethodSpec	generatePagingProviderMainMethod()
protected List<SdkParameter>	generateQueryParametersNoPaginated()
com.squareup.javapoet.MethodSpec	generateRequestBuilderMainMethod()
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.pagination.Pagination	getPagination()
com.squareup.javapoet.CodeBlock	getPagingMethodOperation()
protected SdkParameter	getPagingParameter()
protected abstract List<com.squareup.javapoet.ParameterSpec>	getPagingParametersAsParameterSpecs()
String	getPayloadExpression()
protected boolean	requiresMediaTypeAnnotation()

Methods inherited from class com.mulesoft.connectivity.rest.sdk.templating.sdk.operation.AbstractSdkOperation

addSetBodyMethod, applyTemplates, buildContent, builder, configureClassBuilder, configureJavaFileBuilder, generateAuxParameterBindings, generateBaseMainMethod, generateCatchStatement, generateContentParameters, generateOperationBaseLayer, generateOperationImplementationLayer, generateOperationImplementationMethod, generateOperationImplementationMethodBody, generateOperationInterceptorLayer, generateOperationMainCall, generateQueryParameters, generateRestRequestBuilder, generateTryStatement, getAllBodyFields, getAllParameters, getBasePackage, getConnectorOperation, getInterceptorPackage, getJavaBaseClassName, getJavaClassName, getJavaInterceptorClassName, getJavaMethodName, getOperation, getPackage, getParameterValueStatement, getSuperclass, hasOutput, isQueryParamDefinedInPagination, isVoidOperation, operationMethodRequiresBody, returnNullOnNotFoundError, toCursorProviderMapCodeBlock

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

Methods inherited from interface com.mulesoft.connectivity.rest.sdk.templating.sdk.operation.SdkPaginationStrategy

getPagingProviderClass

Constructor Detail

AbstractSdkPaginationOperation

public AbstractSdkPaginationOperation(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

getPagination

public com.mulesoft.connectivity.rest.sdk.internal.connectormodel.pagination.Pagination getPagination()

getPagingParametersAsParameterSpecs

protected abstract List<com.squareup.javapoet.ParameterSpec> getPagingParametersAsParameterSpecs()
                                                                                          throws TemplatingException

Throws:

TemplatingException

generateOperationMethodsFlow

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

Overrides:

generateOperationMethodsFlow in class AbstractSdkOperation

Throws:

TemplatingException

addResponseBindings

protected void addResponseBindings(com.squareup.javapoet.CodeBlock.Builder block)

getPagingMethodOperation

public com.squareup.javapoet.CodeBlock getPagingMethodOperation()
                                                         throws TemplatingException

Specified by:

getPagingMethodOperation in interface SdkPaginationStrategy

Throws:

TemplatingException

getPagingParameter

protected SdkParameter getPagingParameter()
                                   throws TemplatingException

Throws:

TemplatingException

generateMethodReturn

public com.squareup.javapoet.TypeName generateMethodReturn()

Specified by:

generateMethodReturn in class AbstractSdkOperation

getMessageOutputType

protected AbstractSdkOperation.MessageOutputType getMessageOutputType()

Description copied from class: AbstractSdkOperation

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

Overrides:

getMessageOutputType in class AbstractSdkOperation

generateBaseMainMethodParameters

protected AbstractSdkOperation.ParametersBuilder generateBaseMainMethodParameters()

Overrides:

generateBaseMainMethodParameters in class AbstractSdkOperation

generateOperationImplementationMethodParameters

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

Overrides:

generateOperationImplementationMethodParameters in class AbstractSdkOperation

generateOperationMethodBaseMainBody

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

Specified by:

generateOperationMethodBaseMainBody in class AbstractSdkOperation

Throws:

TemplatingException

generateOperationMainCallParameters

protected List<String> generateOperationMainCallParameters()

Overrides:

generateOperationMainCallParameters in class AbstractSdkOperation

generateOperationBaseMethod

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

Overrides:

generateOperationBaseMethod in class AbstractSdkOperation

Throws:

TemplatingException

generateRequestBuilderMainMethod

public com.squareup.javapoet.MethodSpec generateRequestBuilderMainMethod()

generatePagingProviderMainMethod

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

Throws:

TemplatingException

generateQueryParametersNoPaginated

protected List<SdkParameter> generateQueryParametersNoPaginated()

getPayloadExpression

public String getPayloadExpression()

Specified by:

getPayloadExpression in interface SdkPaginationStrategy

requiresMediaTypeAnnotation

protected boolean requiresMediaTypeAnnotation()

Overrides:

requiresMediaTypeAnnotation in class AbstractSdkOperation