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

Class DefaultConnectivitySchemaBuilder

java.lang.Object

org.mule.runtime.connectivity.internal.platform.schema.builder.DefaultConnectivitySchemaBuilder

All Implemented Interfaces:

ConnectivitySchemaBuilder

public class DefaultConnectivitySchemaBuilder
extends Object
implements ConnectivitySchemaBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.connectivity.api.platform.schema.builder.ConnectivitySchemaBuilder

ConnectivitySchemaBuilder.ConnectionParameterConfigurer, ConnectivitySchemaBuilder.CustomRangeConfigurer

Constructor Summary

Constructors

Constructor and Description
DefaultConnectivitySchemaBuilder()

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.connectivity.api.platform.schema.builder.ConnectivitySchemaBuilder

newInstance

Constructor Detail

DefaultConnectivitySchemaBuilder

public DefaultConnectivitySchemaBuilder()

Method Detail

gav

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

Sets the schema's GAV

Specified by:

gav in interface ConnectivitySchemaBuilder

Parameters:

groupId - a valid Maven groupId

artifactId - a valid Maven artifactId

version - a valid Maven version

Returns:

this builder

authenticationType

public 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.

Specified by:

authenticationType in interface ConnectivitySchemaBuilder

Parameters:

authenticationType - the authentication type id

Returns:

this builder

system

public ConnectivitySchemaBuilder system(String system)

Specifies the name of the system targeted by this connection

Specified by:

system in interface ConnectivitySchemaBuilder

Parameters:

system - the system name

Returns:

this builder

connectionProviderName

public ConnectivitySchemaBuilder connectionProviderName(String connectionProviderName)

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

Specified by:

connectionProviderName in interface ConnectivitySchemaBuilder

Parameters:

connectionProviderName - a ConnectionProvider name

Returns:

this builder

withLabel

public ConnectivitySchemaBuilder withLabel(String key,
                                           String value)

Adds a label

Specified by:

withLabel in interface ConnectivitySchemaBuilder

Parameters:

key - the label key

value - the label value

Returns:

this builder

addAsset

public ConnectivitySchemaBuilder addAsset(ExchangeAssetDescriptor assetDescriptor)

Adds a dependant assert declaration

Specified by:

addAsset in interface ConnectivitySchemaBuilder

Parameters:

assetDescriptor - the asset descriptor

Returns:

this builder

uses

public ConnectivitySchemaBuilder uses(String ns,
                                      String url)

Specifies a dependant vocabulary referenced in the produced schema

Specified by:

uses in interface ConnectivitySchemaBuilder

Parameters:

ns - the vocabulary namespace

url - the vocabulary url

Returns:

this builder

usesExternal

public ConnectivitySchemaBuilder usesExternal(String ns,
                                              String url)

Specifies an external dependant vocabulary referenced in the produced schema

Specified by:

usesExternal in interface ConnectivitySchemaBuilder

Parameters:

ns - the vocabulary namespace

url - the vocabulary url

Returns:

this builder

connectionClassTerm

public ConnectivitySchemaBuilder connectionClassTerm(String classTerm)

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

Specified by:

connectionClassTerm in interface ConnectivitySchemaBuilder

Parameters:

classTerm - the connectivity class term

Returns:

this builder

withParameter

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

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

Specified by:

withParameter in interface ConnectivitySchemaBuilder

Parameters:

name - the parameter name

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

Returns:

this builder

withCustomRange

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

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

Specified by:

withCustomRange in interface ConnectivitySchemaBuilder

Parameters:

name - the range name

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

Returns:

this builder

build

public ConnectivitySchema build()

Specified by:

build in interface ConnectivitySchemaBuilder

Returns:

The produced in