Module org.mule.runtime.extensions.api
Package org.mule.runtime.extension.api.annotation.license

Annotation Interface RequiresEntitlement

@MinMuleVersion("4.1") @Target(TYPE) @Retention(RUNTIME) @Documented public @interface RequiresEntitlement
Defines if the extension license requires a custom entitlement.

This annotation can be used by connector developers to require a custom entitlement defined by the name() attribute.

Usually defining an entitlement also requires the connector developer to get a license generator from MuleSoft that can later be used to create license for users of the connector. When requesting MuleSoft for a license generator a provider name must be supplied which is usually the name of the company developing the connector. Such value must be also set as the extension vendor in the Extension.vendor() annotation attribute.

Since:
1.0

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
     

  • Element Details

    • name

      String name
      Returns:
      identifier of the required entitlement in the license

    • description

      String description
      Returns:
      a description for the entitlement.
      Default:
      ""