com.mulesoft.connectivity.rest.sdk.descgen

Class CreateMetaDescriptor

java.lang.Object

com.mulesoft.connectivity.rest.sdk.descgen.CreateMetaDescriptor

public class CreateMetaDescriptor
extends Object

Constructor Summary

Constructors

Constructor and Description
CreateMetaDescriptor(Path resolvedApiSpec, Path descriptorFilePath)

Method Summary

Modifier and Type	Method and Description
void	addGeneratedSchemaPath(Path shemaPath)
com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFAPIModel	getApiModel()
Path	getDescriptorFilePath()
List<Path>	getGeneratedJsonSchemas()
@NotNull OperationInfo	getOperationInfo(@NotNull String operationId, Location operationIdLocation) Finds info about an operation including those that are being created by other extensions.
void	load()
com.mulesoft.connectivity.rest.sdk.internal.webapi.model.APIModel	parseAPISpec()
void	registerDerivedOperation(@NotNull String operationId, @NotNull String baseOperationId, Location operationIdLocation, boolean providesItems) This is for a vendor extension to notify the generator that a derived operation will be created.
void	setApiModel(com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFAPIModel apiModel)
void	writeTo(Writer writer, boolean writeLocation)

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateMetaDescriptor

public CreateMetaDescriptor(Path resolvedApiSpec,
                            Path descriptorFilePath)

Method Detail

parseAPISpec

public com.mulesoft.connectivity.rest.sdk.internal.webapi.model.APIModel parseAPISpec()
                                                                               throws com.mulesoft.connectivity.rest.sdk.internal.webapi.exception.ModelGenerationException

Throws:

com.mulesoft.connectivity.rest.sdk.internal.webapi.exception.ModelGenerationException

setApiModel

public void setApiModel(com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFAPIModel apiModel)

getApiModel

public com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFAPIModel getApiModel()

load

public void load()

writeTo

public void writeTo(Writer writer,
                    boolean writeLocation)
             throws IOException

Throws:

IOException

getDescriptorFilePath

public Path getDescriptorFilePath()

addGeneratedSchemaPath

public void addGeneratedSchemaPath(Path shemaPath)

getGeneratedJsonSchemas

public List<Path> getGeneratedJsonSchemas()

getOperationInfo

@NotNull
public @NotNull OperationInfo getOperationInfo(@NotNull
                                                        @NotNull String operationId,
                                                        Location operationIdLocation)

Finds info about an operation including those that are being created by other extensions.

This method fails with an exception if the operation is not found.

Parameters:

operationId - the operationId, possibly derived

operationIdLocation - source location of the operationId, for traceability

Returns:

the real operation.

registerDerivedOperation

public void registerDerivedOperation(@NotNull
                                     @NotNull String operationId,
                                     @NotNull
                                     @NotNull String baseOperationId,
                                     Location operationIdLocation,
                                     boolean providesItems)

This is for a vendor extension to notify the generator that a derived operation will be created.

Parameters:

operationId - the operationId of the operation being created

baseOperationId - the operationId of the base operation

operationIdLocation - the location of the operationId in the source spec

providesItems - whether the operation already provides items (e.g. a paginated operation)