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

Direct Known Subclasses:

AbstractSdkPaginationOperation, SdkNativeOperation, SdkOperation

public abstract class AbstractSdkOperation
extends JavaTemplateEntity

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSdkOperation.MessageOutputType

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_MULTIPLE_URI_PARAM_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
static String	INTERCEPTOR_METHOD_NAME
protected com.mulesoft.connectivity.rest.sdk.internal.connectormodel.ConnectorOperation	operation
static String	OPERATION_PATH_FIELD
protected SdkOutputMetadataResolver	outputMetadataResolver
static String	PARAM_DOC_NAME_DESCRIPTION
protected AbstractSdkResolverProvider	sampleDataProvider

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

BASE_CLASSNAME_SUFFIX, BASE_PACKAGE_SUFFIX, connectorModel, INTERCEPTOR_CLASSNAME_SUFFIX, INTERCEPTOR_PACKAGE_SUFFIX, 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, boolean withAnnotations, List<com.squareup.javapoet.ParameterSpec> parameterSpecs)
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)
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 void	generateCatchStatement(Class exception, String codeBlock, com.squareup.javapoet.CodeBlock.Builder methodBody, Object... args)
com.squareup.javapoet.CodeBlock.Builder	generateCommonOperationMethodBody()
void	generateCommonOperationMethodBody(com.squareup.javapoet.CodeBlock.Builder methodBody)
com.squareup.javapoet.CodeBlock	generateInterceptorCall()
abstract com.squareup.javapoet.TypeName	generateMethodReturn()
protected void	generateOperationBaseLayer()
com.squareup.javapoet.MethodSpec	generateOperationBaseMethod()
protected void	generateOperationClass()
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 void	generateOperationInterceptorLayer()
com.squareup.javapoet.MethodSpec	generateOperationInterceptorMethod()
com.squareup.javapoet.CodeBlock	generateOperationInterceptorMethodBody()
com.squareup.javapoet.MethodSpec	generateOperationMethod()
abstract com.squareup.javapoet.CodeBlock	generateOperationMethodBody()
protected void	generateRestRequestBuilderInitialization(com.squareup.javapoet.CodeBlock.Builder methodBody, String baseUriString)
protected void	generateTryStatement(com.squareup.javapoet.CodeBlock.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.ConnectorOperation	getConnectorOperation()
String	getInterceptorPackage()
String	getJavaBaseClassName()
String	getJavaClassName()
String	getJavaInterceptorClassName()
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.ConnectorOperation	getOperation()
String	getPackage()
protected Class<? extends com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation>	getSuperclass()
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

generateOptionalGetter, getArgumentsFromValueProvider, getArgumentsFromValueProviderDefinition, 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

ADD_MULTIPLE_URI_PARAM_METHOD_NAME

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

OPERATION_PATH_FIELD

public static final String OPERATION_PATH_FIELD

See Also:

Constant Field Values

INTERCEPTOR_METHOD_NAME

public static final String INTERCEPTOR_METHOD_NAME

See Also:

Constant Field Values

operation

protected final com.mulesoft.connectivity.rest.sdk.internal.connectormodel.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 AbstractSdkResolverProvider 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

generateMethodReturn

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

generateOperationMethodBody

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

Throws:

TemplatingException

getOperation

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

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()

getJavaBaseClassName

public String getJavaBaseClassName()

getJavaInterceptorClassName

public String getJavaInterceptorClassName()

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

generateOperationClass

protected void generateOperationClass()
                               throws TemplatingException

Throws:

TemplatingException

generateOperationImplementationLayer

protected void generateOperationImplementationLayer()
                                             throws TemplatingException

Throws:

TemplatingException

generateOperationInterceptorLayer

protected void generateOperationInterceptorLayer()
                                          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()

generateOperationMethod

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

Throws:

TemplatingException

generateOperationImplementationMethod

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

Throws:

TemplatingException

generateOperationBaseMethod

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

Throws:

TemplatingException

generateOperationInterceptorMethod

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

Throws:

TemplatingException

addContentParameters

protected void addContentParameters(com.squareup.javapoet.CodeBlock.Builder javaDoc,
                                    boolean withAnnotations,
                                    List<com.squareup.javapoet.ParameterSpec> parameterSpecs)

generateCommonOperationMethodBody

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

generateOperationImplementationMethodBody

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

Throws:

TemplatingException

generateOperationInterceptorMethodBody

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

Throws:

TemplatingException

generateTryStatement

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

generateCatchStatement

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

generateCommonOperationMethodBody

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

generateInterceptorCall

public com.squareup.javapoet.CodeBlock generateInterceptorCall()

generateRestRequestBuilderInitialization

protected void generateRestRequestBuilderInitialization(com.squareup.javapoet.CodeBlock.Builder methodBody,
                                                        String baseUriString)

addSetBodyMethod

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

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()

requiresConnectionParameter

protected boolean requiresConnectionParameter()

requiresCallbackParameter

protected boolean requiresCallbackParameter()

requiresMediaTypeAnnotation

protected boolean requiresMediaTypeAnnotation()

getAllParameters

public List<SdkParameter> getAllParameters()

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

getAllBodyFields

public List<SdkField> getAllBodyFields()

getConnectorOperation

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

generateAuxParameterBindings

protected com.squareup.javapoet.CodeBlock generateAuxParameterBindings()