org.mule.devkit.generation.studio.editor.globalcloudconnector

Class GlobalCloudConnectorTypeBuilder

java.lang.Object

org.mule.devkit.generation.studio.editor.BaseStudioXmlBuilder

org.mule.devkit.generation.studio.editor.GlobalTypeBuilder

org.mule.devkit.generation.studio.editor.globalcloudconnector.GlobalCloudConnectorTypeBuilder

Direct Known Subclasses:

GlobalCloudConnectorConfigurationBuilder, GlobalCloudConnectorConnectionManagementBuilder, GlobalCloudConnectorHttpBasicAuthBuilder, GlobalCloudConnectorModuleBuilder, GlobalCloudConnectorOAuthBuilder, ParentCloudConnectorTypeBuilder

public abstract class GlobalCloudConnectorTypeBuilder
extends GlobalTypeBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUIRED_LIBS_DIR
static String	REQUIRED_LIBS_SUFFIX
static String	STUDIO_CACHE_CONFIGURATION_PERSISTANT_VALUE
static String	STUDIO_FULL_QUALIFIED_PACKAGE_VALUE_PERSISTANT
static String	STUDIO_HTTP_TRANSACTION_PERSISTANT_VALUE
static String	STUDIO_POOLING_PROFILE_PERSISTANT_VALUE

Fields inherited from class org.mule.devkit.generation.studio.editor.BaseStudioXmlBuilder

ADVANCED_CONNECTION_GROUP_NAME, CONNECTION_GROUP_NAME, context, GENERAL_GROUP_NAME, helper, method, module, moduleName, objectFactory

Constructor Summary

Constructors

Constructor and Description
GlobalCloudConnectorTypeBuilder(Context context, org.mule.devkit.model.module.Module module, boolean abstrac7, String globalRefId)

Method Summary

Methods

Modifier and Type	Method and Description
org.mule.devkit.model.studio.GlobalType	build() Overriding the build behaviour to specify each global-cloud-connector element.
protected abstract void	buildConnectivityTestingAttr(org.mule.devkit.model.studio.GlobalType globalCloudConnector) Determines weather the current global element supports connectivity testing on Studio, or not
protected void	buildMetaDataAttr(org.mule.devkit.model.studio.GlobalType globalCloudConnector, boolean dynamicMetadata) Determines weather the current global element supports static or dynamic DataSense in Studio
protected void	buildOAuthConfig(Map<String,org.mule.devkit.model.studio.Group> groupsByName, Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName) For the given element, this method will create the OAuth tab in the studio configuration properties.
protected void	buildRequiredLibsAttr(org.mule.devkit.model.studio.GlobalType globalCloudConnector) Populate the GlobalType with the required libraries described in the xml with the same configElementName under path /META-INF
protected abstract org.mule.devkit.model.module.connectivity.ConnectMethod	connectMethod()
protected void	createCacheConfigAttributes(Map<String,org.mule.devkit.model.studio.Group> groupsByName, Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)
protected void	createHttpCallbackConfig(Map<String,org.mule.devkit.model.studio.Group> groupsByName, Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)
protected void	createMetaDataAttributes(Map<String,org.mule.devkit.model.studio.Group> groupsByName, Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)
protected void	createPoolingProfileAttributes(Map<String,org.mule.devkit.model.studio.Group> groupsByName, Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)
protected void	createReconnectionAttributes(Map<String,org.mule.devkit.model.studio.Group> groupsByName, Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)
protected List<org.mule.devkit.model.studio.AttributeCategory>	getAttributeCategories()
protected org.mule.devkit.model.studio.AttributeType	getAttributeType(org.mule.devkit.model.Variable variable) We override this at global element, as each type of connection strategy might have to specify if the current element is required.
protected abstract List<org.mule.devkit.model.Field>	getConfigurableFieldsSorted()
protected abstract List<org.mule.devkit.model.studio.AttributeType>	getConnectionAttributes() Returns the list of elements that should be within the CONNECTION_GROUP_NAME
protected List<org.mule.devkit.model.studio.AttributeType>	getConnectionAttributes(List<org.mule.devkit.model.Field> configurableFields)
protected String	getExtendsBasedOnType()
protected String	getIcon()
protected String	getImage()
protected String	getNameDescriptionBasedOnType()
protected abstract boolean	hasConnectionMethod()
protected Boolean	isAbstract()
protected List<org.mule.devkit.model.studio.AttributeCategory>	processConfigurableFields(org.mule.devkit.model.studio.Group defaultGroup)
protected void	processConnectionAttributes(Map<String,org.mule.devkit.model.studio.Group> groupsByName, Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)
protected void	setConnectivityTestingAttribute(org.mule.devkit.model.studio.GlobalType globalCloudConnector, com.google.common.base.Optional<org.mule.devkit.model.Method> methodOptional)
protected void	setMetadataAttributes(org.mule.devkit.model.Variable<?> variable, org.mule.devkit.model.studio.AttributeType attributeType)
protected void	setRequiredConnectionParameter(org.mule.devkit.model.studio.AttributeType attributeType, org.mule.devkit.model.Variable variable) Useful to mark in Studio that the current parameter should be written in the global element

Methods inherited from class org.mule.devkit.generation.studio.editor.GlobalTypeBuilder

createNameAttributeType, getCaptionBasedOnType, getDescriptionBasedOnType, getLocalIdBasedOnType

Methods inherited from class org.mule.devkit.generation.studio.editor.BaseStudioXmlBuilder

buildVersionsString, createGroupWithModeSwitch, createGroupWithNoOperationModeSwitch, createGroupWithNoOperationModeSwitchForProcessors, createGroupWithNoOperationModeSwitchForSources, createJaxbElement, createOAuthConfig, createQueryType, createTextType, getConnectionAttributes, getModes, isConfigurableVariable, processMethodParameters, processVariableElements

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED_LIBS_DIR

public static final String REQUIRED_LIBS_DIR

See Also:

Constant Field Values

REQUIRED_LIBS_SUFFIX

public static final String REQUIRED_LIBS_SUFFIX

See Also:

Constant Field Values

STUDIO_FULL_QUALIFIED_PACKAGE_VALUE_PERSISTANT

public static final String STUDIO_FULL_QUALIFIED_PACKAGE_VALUE_PERSISTANT

See Also:

Constant Field Values

STUDIO_POOLING_PROFILE_PERSISTANT_VALUE

public static final String STUDIO_POOLING_PROFILE_PERSISTANT_VALUE

See Also:

Constant Field Values

STUDIO_CACHE_CONFIGURATION_PERSISTANT_VALUE

public static final String STUDIO_CACHE_CONFIGURATION_PERSISTANT_VALUE

See Also:

Constant Field Values

STUDIO_HTTP_TRANSACTION_PERSISTANT_VALUE

public static final String STUDIO_HTTP_TRANSACTION_PERSISTANT_VALUE

See Also:

Constant Field Values

Constructor Detail

GlobalCloudConnectorTypeBuilder

public GlobalCloudConnectorTypeBuilder(Context context,
                               org.mule.devkit.model.module.Module module,
                               boolean abstrac7,
                               String globalRefId)

Method Detail

build

public org.mule.devkit.model.studio.GlobalType build()

Overriding the build behaviour to specify each global-cloud-connector element.

Overrides:

build in class GlobalTypeBuilder

Returns:

buildRequiredLibsAttr

protected void buildRequiredLibsAttr(org.mule.devkit.model.studio.GlobalType globalCloudConnector)

Populate the GlobalType with the required libraries described in the xml with the same configElementName under path /META-INF

Parameters:

globalCloudConnector - to set required libraries to

buildConnectivityTestingAttr

protected abstract void buildConnectivityTestingAttr(org.mule.devkit.model.studio.GlobalType globalCloudConnector)

Determines weather the current global element supports connectivity testing on Studio, or not

Parameters:

globalCloudConnector - to set the connectivity testing to

buildMetaDataAttr

protected void buildMetaDataAttr(org.mule.devkit.model.studio.GlobalType globalCloudConnector,
                     boolean dynamicMetadata)

Determines weather the current global element supports static or dynamic DataSense in Studio

Parameters:

globalCloudConnector -

dynamicMetadata - indicates if the current module supports dynamic metadata ( check Module.hasDynamicMetadata())

setConnectivityTestingAttribute

protected void setConnectivityTestingAttribute(org.mule.devkit.model.studio.GlobalType globalCloudConnector,
                                   com.google.common.base.Optional<org.mule.devkit.model.Method> methodOptional)

getAttributeCategories

protected List<org.mule.devkit.model.studio.AttributeCategory> getAttributeCategories()

Specified by:

getAttributeCategories in class GlobalTypeBuilder

createMetaDataAttributes

protected void createMetaDataAttributes(Map<String,org.mule.devkit.model.studio.Group> groupsByName,
                            Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)

Overrides:

createMetaDataAttributes in class BaseStudioXmlBuilder

processConnectionAttributes

protected void processConnectionAttributes(Map<String,org.mule.devkit.model.studio.Group> groupsByName,
                               Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)

Overrides:

processConnectionAttributes in class BaseStudioXmlBuilder

getConnectionAttributes

protected abstract List<org.mule.devkit.model.studio.AttributeType> getConnectionAttributes()

Returns the list of elements that should be within the CONNECTION_GROUP_NAME

Returns:

createPoolingProfileAttributes

protected void createPoolingProfileAttributes(Map<String,org.mule.devkit.model.studio.Group> groupsByName,
                                  Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)

Overrides:

createPoolingProfileAttributes in class BaseStudioXmlBuilder

createCacheConfigAttributes

protected void createCacheConfigAttributes(Map<String,org.mule.devkit.model.studio.Group> groupsByName,
                               Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)

Overrides:

createCacheConfigAttributes in class BaseStudioXmlBuilder

createReconnectionAttributes

protected void createReconnectionAttributes(Map<String,org.mule.devkit.model.studio.Group> groupsByName,
                                Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)

Overrides:

createReconnectionAttributes in class BaseStudioXmlBuilder

buildOAuthConfig

protected void buildOAuthConfig(Map<String,org.mule.devkit.model.studio.Group> groupsByName,
                    Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)

For the given element, this method will create the OAuth tab in the studio configuration properties. It should be called iff the current global element is working on a org.mule.api.annotations.oauth.OAuth2

Parameters:

groupsByName -

attributeCategoriesByName -

getExtendsBasedOnType

protected String getExtendsBasedOnType()

Specified by:

getExtendsBasedOnType in class GlobalTypeBuilder

getNameDescriptionBasedOnType

protected String getNameDescriptionBasedOnType()

Specified by:

getNameDescriptionBasedOnType in class GlobalTypeBuilder

getImage

protected String getImage()

Specified by:

getImage in class GlobalTypeBuilder

getIcon

protected String getIcon()

Specified by:

getIcon in class GlobalTypeBuilder

isAbstract

protected Boolean isAbstract()

Specified by:

isAbstract in class GlobalTypeBuilder

setMetadataAttributes

protected void setMetadataAttributes(org.mule.devkit.model.Variable<?> variable,
                         org.mule.devkit.model.studio.AttributeType attributeType)

Overrides:

setMetadataAttributes in class BaseStudioXmlBuilder

getConnectionAttributes

protected List<org.mule.devkit.model.studio.AttributeType> getConnectionAttributes(List<org.mule.devkit.model.Field> configurableFields)

getAttributeType

protected org.mule.devkit.model.studio.AttributeType getAttributeType(org.mule.devkit.model.Variable variable)

We override this at global element, as each type of connection strategy might have to specify if the current element is required. The only change here is that each global element might have the required to true.

Overrides:

getAttributeType in class BaseStudioXmlBuilder

Parameters:

variable -

Returns:

processConfigurableFields

protected List<org.mule.devkit.model.studio.AttributeCategory> processConfigurableFields(org.mule.devkit.model.studio.Group defaultGroup)

Parameters:

defaultGroup -

Returns:

createHttpCallbackConfig

protected void createHttpCallbackConfig(Map<String,org.mule.devkit.model.studio.Group> groupsByName,
                            Map<String,org.mule.devkit.model.studio.AttributeCategory> attributeCategoriesByName)

Overrides:

createHttpCallbackConfig in class BaseStudioXmlBuilder

setRequiredConnectionParameter

protected void setRequiredConnectionParameter(org.mule.devkit.model.studio.AttributeType attributeType,
                                  org.mule.devkit.model.Variable variable)

Useful to mark in Studio that the current parameter should be written in the global element

Parameters:

attributeType -

variable -

getConfigurableFieldsSorted

protected abstract List<org.mule.devkit.model.Field> getConfigurableFieldsSorted()

hasConnectionMethod

protected abstract boolean hasConnectionMethod()

connectMethod

protected abstract org.mule.devkit.model.module.connectivity.ConnectMethod connectMethod()