Module org.mule.runtime.extensions.api
Package org.mule.runtime.extension.privileged.util

Class ComponentDeclarationUtils

java.lang.Object
org.mule.runtime.extension.privileged.util.ComponentDeclarationUtils
public final class ComponentDeclarationUtils extends Object
Provides a way to access the functionality on internal model properties when declaring components on crafted extensions.

Being privileged, this is not intended to be used outside of the scope of crafted extension declarations.

Since:
1.8

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    asPagedOperation(org.mule.runtime.api.meta.model.declaration.fluent.ComponentDeclarer declarer)
    Marks that the component being declared by the declarer is paged.
    static boolean
    isConnectionProvisioningRequired(org.mule.runtime.api.meta.model.ConnectableComponentModel componentModel)
     
    static boolean
    isConnectivityErrorSupported(org.mule.runtime.api.meta.model.declaration.fluent.ExecutableComponentDeclaration<?> declaration)
     
    static boolean
    isNoErrorMapping(org.mule.runtime.api.meta.model.operation.OperationModel componentModel)
     
    static boolean
    isNoTransactionalAction(org.mule.runtime.api.meta.model.ComponentModel componentModel)
     
    static boolean
    isPagedOperation(org.mule.runtime.api.meta.model.ComponentModel componentModel)
     
    static boolean
    isReconnectionStrategySupported(org.mule.runtime.api.meta.model.ConnectableComponentModel componentModel)
     
    static boolean
    isReconnectionStrategySupported(org.mule.runtime.api.meta.model.declaration.fluent.ExecutableComponentDeclaration<?> declaration)
     
    static boolean
    isReconnectionStrategySupported(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclaration declaration)
     
    static boolean
    isTargetParameter(Set<org.mule.runtime.api.meta.model.ModelProperty> paramModelProperties)
     
    static boolean
    isTargetParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel)
     
    static boolean
    isTransactionalAction(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel)
     
    static boolean
    isTransactionalType(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel)
     
    static void
    withNoConnectivityError(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclarer declarer)
    Marks that the operation being declared by the declarer will avoid propagating connectivity errors from operations, regardless of being connected.
    static void
    withNoErrorMapping(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclarer declarer)
    Marks that the operation being declared by the declarer may not contain errorMappings.
    static void
    withNoReconnectionStrategy(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclarer declarer)
    Marks that the operations of the extension being declared by the declarer may not have a ExtensionConstants.RECONNECTION_CONFIG_PARAMETER_NAME parameter, regardless of them being connected.
    static void
    withNoReconnectionStrategy(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclarer declarer)
    Marks that the operation being declared by the declarer may not have a ExtensionConstants.RECONNECTION_CONFIG_PARAMETER_NAME parameter, regardless of being connected.
    static void
    withNoStreamingConfiguration(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclarer declarer)
    Marks that the operation being declared by the declarer may not have a configuring streaming strategy, regardless of it being a streaming operation.
    static void
    withNoTransactionalAction(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclarer declarer)
    Marks that the operation being declared by the declarer may not have a configuring transactionalAction, regardless of being transactional.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • withNoStreamingConfiguration

      public static void withNoStreamingConfiguration(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclarer declarer)
      Marks that the operation being declared by the declarer may not have a configuring streaming strategy, regardless of it being a streaming operation.
      Parameters:
      declarer - the declarer of the operation to mark.

    • withNoTransactionalAction

      public static void withNoTransactionalAction(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclarer declarer)
      Marks that the operation being declared by the declarer may not have a configuring transactionalAction, regardless of being transactional.
      Parameters:
      declarer - the declarer of the operation to mark.

    • withNoReconnectionStrategy

      public static void withNoReconnectionStrategy(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclarer declarer)
      Marks that the operation being declared by the declarer may not have a ExtensionConstants.RECONNECTION_CONFIG_PARAMETER_NAME parameter, regardless of being connected.
      Parameters:
      declarer - the declarer of the operation to mark.

    • withNoReconnectionStrategy

      public static void withNoReconnectionStrategy(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclarer declarer)
      Marks that the operations of the extension being declared by the declarer may not have a ExtensionConstants.RECONNECTION_CONFIG_PARAMETER_NAME parameter, regardless of them being connected.
      Parameters:
      declarer - the declarer of the extension to mark.

    • withNoConnectivityError

      public static void withNoConnectivityError(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclarer declarer)
      Marks that the operation being declared by the declarer will avoid propagating connectivity errors from operations, regardless of being connected.
      Parameters:
      declarer - the declarer of the operation to mark.

    • withNoErrorMapping

      public static void withNoErrorMapping(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclarer declarer)
      Marks that the operation being declared by the declarer may not contain errorMappings.
      Parameters:
      declarer - the declarer of the operation to mark.

    • asPagedOperation

      public static void asPagedOperation(org.mule.runtime.api.meta.model.declaration.fluent.ComponentDeclarer declarer)
      Marks that the component being declared by the declarer is paged.
      Parameters:
      declarer - the declarer of the component to mark.

    • isNoTransactionalAction

      public static boolean isNoTransactionalAction(org.mule.runtime.api.meta.model.ComponentModel componentModel)
      Parameters:
      componentModel - the component to check for.
      Returns:
      whether componentModel may not have a configuring transactionalAction.

    • isNoErrorMapping

      public static boolean isNoErrorMapping(org.mule.runtime.api.meta.model.operation.OperationModel componentModel)
      Parameters:
      componentModel - the operation to check for.
      Returns:
      whether componentModel may not contain errorMappings.

    • isPagedOperation

      public static boolean isPagedOperation(org.mule.runtime.api.meta.model.ComponentModel componentModel)
      Parameters:
      componentModel - the component to check for.
      Returns:
      whether componentModel is paged.

    • isTransactionalAction

      public static boolean isTransactionalAction(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel)
      Parameters:
      paramModel - the parameter to check for.
      Returns:
      whether paramModel is the parameter considered to inject the value of the Transactional Action.

    • isTransactionalType

      public static boolean isTransactionalType(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel)
      Parameters:
      paramModel - the parameter to check for.
      Returns:
      whether paramModel is the parameter is a TransactionType.

    • isTargetParameter

      public static boolean isTargetParameter(Set<org.mule.runtime.api.meta.model.ModelProperty> paramModelProperties)
      Parameters:
      paramModelProperties - the parameter to check for.
      Returns:
      whether the paramModel owning the provided paramModelProperties is the parameter considered as a Target type.

    • isTargetParameter

      public static boolean isTargetParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel paramModel)
      Parameters:
      paramModel - the parameter to check for.
      Returns:
      whether paramModel is the parameter considered as a Target type.

    • isConnectionProvisioningRequired

      public static boolean isConnectionProvisioningRequired(org.mule.runtime.api.meta.model.ConnectableComponentModel componentModel)
      Parameters:
      componentModel - a ConnectableComponentModel
      Returns:
      Whether a component modeled by the given componentModel would need a connection to be provided in order to function.

    • isReconnectionStrategySupported

      public static boolean isReconnectionStrategySupported(org.mule.runtime.api.meta.model.ConnectableComponentModel componentModel)
      Parameters:
      componentModel - an ConnectableComponentModel
      Returns:
      Whether the component modeled by the given componentModel supports having a reconnection strategy.

    • isReconnectionStrategySupported

      public static boolean isReconnectionStrategySupported(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclaration declaration)
      Parameters:
      declaration - an ExtensionDeclaration.
      Returns:
      Whether the components belonging to the extension declared by the given declaration support having a reconnection strategy.

    • isReconnectionStrategySupported

      public static boolean isReconnectionStrategySupported(org.mule.runtime.api.meta.model.declaration.fluent.ExecutableComponentDeclaration<?> declaration)
      Parameters:
      declaration - an ExecutableComponentDeclaration.
      Returns:
      Whether the component declared by the given declaration supports having a reconnection strategy.

    • isConnectivityErrorSupported

      public static boolean isConnectivityErrorSupported(org.mule.runtime.api.meta.model.declaration.fluent.ExecutableComponentDeclaration<?> declaration)
      Parameters:
      declaration - an ExecutableComponentDeclaration.
      Returns:
      Whether the componentModel supports propagating connectivity errors from operations.