Package org.restheart.plugins

Annotation Type RegisterPlugin

  • @Retention(RUNTIME)
public @interface RegisterPlugin
    Annotation to register a Plugin
    Author:
    Andrea Di Cesare

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String description
      Describes the plugin
      String name
      Defines the name of the plugin.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String defaultURI
      Only used by Services Sets the default URI of the Service.
      InterceptPoint[] dontIntercept
      Set to true to avoid interceptors to be executed on requests handled by this plugin.
      boolean enabledByDefault
      Set to true to enable the plugin by default.Otherwise it can be enabled setting the configuration argument 'enabled'
      InitPoint initPoint
      Only used by Initializers
      InterceptPoint interceptPoint
      Only used by Interceptors
      int priority
      Set the order of execution (less is higher priority)
      boolean requiresContent
      Only used by Interceptors of proxied resources (the content is always available to Interceptor of Services) Set it to true to make available the content of the request (if interceptPoint is REQUEST_BEFORE_AUTH or REQUEST_AFTER_AUTH) or of the response (if interceptPoint is RESPONSE or RESPONSE_ASYNC)

    • Element Detail

      • name

        String name
        Defines the name of the plugin. The name can be used in the configuration file to pass confArgs
        Returns:
        the name of the plugin

      • description

        String description
        Describes the plugin
        Returns:
        the description of the plugin

      • priority

        int priority
        Set the order of execution (less is higher priority)
        Returns:
        the execution priority (less is higher priority)
        Default:
        10

      • enabledByDefault

        boolean enabledByDefault
        Set to true to enable the plugin by default.Otherwise it can be enabled setting the configuration argument 'enabled'
        Returns:
        true if enabled by default
        Default:
        true

      • defaultURI

        String defaultURI
        Only used by Services Sets the default URI of the Service. If not specified the Service default URI is /<name>
        Returns:
        the URI of the Service
        Default:
        ""

      • interceptPoint

        InterceptPoint interceptPoint
        Only used by Interceptors
        Returns:
        the intercept point of the Interceptor
        Default:
        org.restheart.plugins.InterceptPoint.REQUEST_AFTER_AUTH

      • initPoint

        InitPoint initPoint
        Only used by Initializers
        Returns:
        the init point of the Intitialier
        Default:
        org.restheart.plugins.InitPoint.AFTER_STARTUP

      • requiresContent

        boolean requiresContent
        Only used by Interceptors of proxied resources (the content is always available to Interceptor of Services) Set it to true to make available the content of the request (if interceptPoint is REQUEST_BEFORE_AUTH or REQUEST_AFTER_AUTH) or of the response (if interceptPoint is RESPONSE or RESPONSE_ASYNC)
        Returns:
        true if the Interceptor requires the content
        Default:
        false

      • dontIntercept

        InterceptPoint[] dontIntercept
        Set to true to avoid interceptors to be executed on requests handled by this plugin. Interceptor with interceptPoint=BEFORE_AUTH
        Returns:
        an array containing the InterceptPoints of the Interceptors to not execute
        Default:
        {}