Package com.github.dynamicextensionsalfresco.webscripts.annotations

Annotation Type WebScript

  • @Target(TYPE)
@Retention(RUNTIME)
public @interface WebScript
    Indicates a class acts as a Web Script.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String baseUri  
      java.lang.String defaultFormat
      Indicates the default format to use for Uri handlers.
      java.lang.String description
      The Web Script description.
      java.lang.String[] families
      Web Script families
      Lifecycle lifecycle
      API lifecycle status
      java.lang.String value
      The short name.

    • Element Detail

      • value

        java.lang.String value
        The short name. If not provided, the framework will use the handler's fully-qualified class name.
        Default:
        ""

      • description

        java.lang.String description
        The Web Script description.
        Returns:
        Default:
        ""

      • families

        java.lang.String[] families
        Web Script families
        Returns:
        Default:
        {}

      • lifecycle

        Lifecycle lifecycle
        API lifecycle status
        Default:
        com.github.dynamicextensionsalfresco.webscripts.annotations.Lifecycle.NONE

      • baseUri

        java.lang.String baseUri
        Default:
        ""

      • defaultFormat

        java.lang.String defaultFormat
        Indicates the default format to use for Uri handlers. A Web Script typically uses the same default format.
        Returns:
        See Also:
        Uri.defaultFormat()
        Default:
        ""