com.mulesoft.connectivity.rest.sdk.descgen.extensions

Class VendorExtension

java.lang.Object

com.mulesoft.connectivity.rest.sdk.descgen.extensions.VendorExtension

Direct Known Subclasses:

CapabilitiesVendorExtension, DynamicListVendorExtension, DynamicSchemaVendorExtension, IncludeVendorExtension, PaginationVendorExtension, TriggerVendorExtension

public abstract class VendorExtension
extends Object

A vendor extension.

Constructor Summary

Constructors

Constructor and Description
VendorExtension()

Method Summary

Modifier and Type	Method and Description
void	apply(com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFAPIModel apiModel, ConnectorDescriptorBuilder connectorDescriptor, CreateMetaDescriptor cmd) Applies this extension to the connector descriptor being created.
void	apply(com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFOperationModel apiOperationModel, com.mulesoft.connectivity.rest.sdk.internal.descriptor.model.OperationAdapterDescriptor operationAdapterDescriptor, ConnectorDescriptorBuilder connectorDescriptor, CreateMetaDescriptor cmd) Applies operation related things specified by this extension to the connector descriptor being created.
String	getDialectUrl() An AML dialect with the extension.
void	prepare(com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFAPIModel apiModel, CreateMetaDescriptor cmd) This gets called before everything else.
boolean	vetoOperation(com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFOperationModel apiOperationModel) Return if the generation of a given operation should be blocked.

Methods inherited from class java.lang.Object

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

Constructor Detail

VendorExtension

public VendorExtension()

Method Detail

getDialectUrl

public String getDialectUrl()

An AML dialect with the extension.

Returns:

the URL to the dialect or null if this extension doesn't need to contribute one

prepare

public void prepare(com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFAPIModel apiModel,
                    CreateMetaDescriptor cmd)
             throws InvalidVendorExtension

This gets called before everything else.

Extensions should use this just to get information about newly created operations that are based on real existing ones.

Parameters:

apiModel - the parsed api-spec, including the extension data

Throws:

InvalidVendorExtension

apply

public void apply(com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFAPIModel apiModel,
                  ConnectorDescriptorBuilder connectorDescriptor,
                  CreateMetaDescriptor cmd)
           throws InvalidVendorExtension

Applies this extension to the connector descriptor being created.

This is called once.

Parameters:

apiModel - the parsed api-spec, including the extension data

connectorDescriptor - the descriptor to modify

cmd - used to add resources

Throws:

InvalidVendorExtension

vetoOperation

public boolean vetoOperation(com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFOperationModel apiOperationModel)
                      throws InvalidVendorExtension

Return if the generation of a given operation should be blocked.

If a single vendor extension returns true from this method, the operation won't be included in the generated connector.

Parameters:

apiOperationModel - the operation to decide upon

Returns:

whether to block the generation of an operation

Throws:

InvalidVendorExtension

apply

public void apply(com.mulesoft.connectivity.rest.sdk.internal.webapi.parser.amf.AMFOperationModel apiOperationModel,
                  com.mulesoft.connectivity.rest.sdk.internal.descriptor.model.OperationAdapterDescriptor operationAdapterDescriptor,
                  ConnectorDescriptorBuilder connectorDescriptor,
                  CreateMetaDescriptor cmd)
           throws InvalidVendorExtension

Applies operation related things specified by this extension to the connector descriptor being created.

This is called once per operation after the operation has been created.

Parameters:

apiOperationModel - the parsed operation data

operationAdapterDescriptor - the new operation descriptor object that has just been created for this operation

connectorDescriptor - the descriptor to modify

cmd - used to add resources

Throws:

InvalidVendorExtension