org.mule.runtime.connectivity.api.platform.schema.builder

Interface ConnectivitySchemaBuilder

All Known Implementing Classes:

DefaultConnectivitySchemaBuilder

@NoImplement
public interface ConnectivitySchemaBuilder

Builder for creating instnaces of ConnectivitySchema

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConnectivitySchemaBuilder.ConnectionParameterConfigurer A configurer for describing a parameter
static interface	ConnectivitySchemaBuilder.CustomRangeConfigurer A configurer for describing a custom Range

Method Summary

Modifier and Type	Method and Description
ConnectivitySchemaBuilder	addAsset(ExchangeAssetDescriptor assetDescriptor) Adds a dependant assert declaration
ConnectivitySchemaBuilder	authenticationType(String authenticationType) Specifies an identifier for the authentication type modeled by this schema.
ConnectivitySchema	build()
ConnectivitySchemaBuilder	connectionClassTerm(String classTerm) Specifies the connection class term as defined in the Connectivity AML Vocabulary
ConnectivitySchemaBuilder	connectionProviderName(String connectionProviderName) Specifies the name of a Mule connector's ConnectionProvider which implements this schema
ConnectivitySchemaBuilder	gav(String groupId, String artifactId, String version) Sets the schema's GAV
static ConnectivitySchemaBuilder	newInstance()
ConnectivitySchemaBuilder	system(String system) Specifies the name of the system targeted by this connection
ConnectivitySchemaBuilder	uses(String ns, String url) Specifies a dependant vocabulary referenced in the produced schema
ConnectivitySchemaBuilder	usesExternal(String ns, String url) Specifies an external dependant vocabulary referenced in the produced schema
ConnectivitySchemaBuilder	withCustomRange(String name, Consumer<ConnectivitySchemaBuilder.CustomRangeConfigurer> configurerConsumer) Specifies a schema specific custom range through the use of a ConnectivitySchemaBuilder.CustomRangeConfigurer
ConnectivitySchemaBuilder	withLabel(String key, String value) Adds a label
ConnectivitySchemaBuilder	withParameter(String name, Consumer<ConnectivitySchemaBuilder.ConnectionParameterConfigurer> configurerConsumer) Adds a parameter into the range through the use of a ConnectivitySchemaBuilder.ConnectionParameterConfigurer

Method Detail

newInstance

static ConnectivitySchemaBuilder newInstance()

Returns:

a new builder instance

gav

ConnectivitySchemaBuilder gav(String groupId,
                              String artifactId,
                              String version)

Sets the schema's GAV

Parameters:

groupId - a valid Maven groupId

artifactId - a valid Maven artifactId

version - a valid Maven version

Returns:

this builder

authenticationType

ConnectivitySchemaBuilder authenticationType(String authenticationType)

Specifies an identifier for the authentication type modeled by this schema.

This identifier should ideally be defined in the connectivity AML vocabulary.

Parameters:

authenticationType - the authentication type id

Returns:

this builder

system

ConnectivitySchemaBuilder system(String system)

Specifies the name of the system targeted by this connection

Parameters:

system - the system name

Returns:

this builder

connectionProviderName

ConnectivitySchemaBuilder connectionProviderName(String connectionProviderName)

Specifies the name of a Mule connector's ConnectionProvider which implements this schema

Parameters:

connectionProviderName - a ConnectionProvider name

Returns:

this builder

withLabel

ConnectivitySchemaBuilder withLabel(String key,
                                    String value)

Adds a label

Parameters:

key - the label key

value - the label value

Returns:

this builder

addAsset

ConnectivitySchemaBuilder addAsset(ExchangeAssetDescriptor assetDescriptor)

Adds a dependant assert declaration

Parameters:

assetDescriptor - the asset descriptor

Returns:

this builder

uses

ConnectivitySchemaBuilder uses(String ns,
                               String url)

Specifies a dependant vocabulary referenced in the produced schema

Parameters:

ns - the vocabulary namespace

url - the vocabulary url

Returns:

this builder

usesExternal

ConnectivitySchemaBuilder usesExternal(String ns,
                                       String url)

Specifies an external dependant vocabulary referenced in the produced schema

Parameters:

ns - the vocabulary namespace

url - the vocabulary url

Returns:

this builder

connectionClassTerm

ConnectivitySchemaBuilder connectionClassTerm(String classTerm)

Specifies the connection class term as defined in the Connectivity AML Vocabulary

Parameters:

classTerm - the connectivity class term

Returns:

this builder

withParameter

ConnectivitySchemaBuilder withParameter(String name,
                                        Consumer<ConnectivitySchemaBuilder.ConnectionParameterConfigurer> configurerConsumer)

Adds a parameter into the range through the use of a ConnectivitySchemaBuilder.ConnectionParameterConfigurer

Parameters:

name - the parameter name

configurerConsumer - a Consumer for a ConnectivitySchemaBuilder.ConnectionParameterConfigurer on which the parameter is described

Returns:

this builder

withCustomRange

ConnectivitySchemaBuilder withCustomRange(String name,
                                          Consumer<ConnectivitySchemaBuilder.CustomRangeConfigurer> configurerConsumer)

Specifies a schema specific custom range through the use of a ConnectivitySchemaBuilder.CustomRangeConfigurer

Parameters:

name - the range name

configurerConsumer - a Consumer for a ConnectivitySchemaBuilder.CustomRangeConfigurer on which the range is described

Returns:

this builder

build

ConnectivitySchema build()

Returns:

The produced in