Package org.apache.unomi.groovy.actions.annotations

Annotation Type Action

  • @Retention(RUNTIME)
@Target(METHOD)
public @interface Action
    This annotation is designed to describe the groovy actions which are created from groovy file, the informations added with this annotation will be processed to create an action type entry in elastic search.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String actionExecutor
      Action Executor to allow to define which action will be called by the action dispatcher The groovy action have to be prefixed by groovy:
      String id  

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String description  
      boolean hidden  
      String name  
      Parameter[] parameters
      Parameters specific to the action The value of the parameters can be retrieved in the action like the following: action.getParameterValues().get(parameterName);
      String[] systemTags
      List of tags that help to classify the action

    • Element Detail

      • id

        String id
        Returns:
        id of the action

      • actionExecutor

        String actionExecutor
        Action Executor to allow to define which action will be called by the action dispatcher The groovy action have to be prefixed by groovy:
        Returns:
        actionExecutor of the action

      • name

        String name
        Returns:
        name of the action
        Default:
        ""

      • description

        String description
        Returns:
        description of the action
        Default:
        ""

      • hidden

        boolean hidden
        Returns:
        action is hidden
        Default:
        false

      • parameters

        Parameter[] parameters
        Parameters specific to the action The value of the parameters can be retrieved in the action like the following: action.getParameterValues().get(parameterName);
        Returns:
        list of parameters
        Default:
        {}

      • systemTags

        String[] systemTags
        List of tags that help to classify the action
        Returns:
        list of system tags
        Default:
        {}