Package org.restheart.plugins

Annotation Interface RegisterPlugin

@Retention(RUNTIME) public @interface RegisterPlugin
Annotation to register a Plugin
Author:
Andrea Di Cesare <andrea@softinstigate.com>

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    RegisterPlugin.MATCH_POLICY
     

  • 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
    Authorizer.TYPE
    authorizerType
    Only used by Authorizers A request is allowed when no VETOER denies it and any ALLOWER allows it
    boolean
    blocking
    Set to true to have the service dispached to the working thread pool, false to be executed directly by the IO thread
    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.
    InitPoint
    initPoint
    Only used by Initializers
    InterceptPoint
    interceptPoint
    Only used by Interceptors
    int
    priority
    Set the order of execution (less is higher priority).
    boolean
    requiredinterceptor
    Only used by Interceptors Indicates that the interceptor should always intercept a service, regardless of its dontIntercept settings.
    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)
    boolean
    secure
    Only used by Services Set to true to execute the service only if authentication and authorization succeed.
    RegisterPlugin.MATCH_POLICY
    uriMatchPolicy
    Only used by Services Sets the URI match policy of the Service.

  • Element Details

    • 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). Default value is 10
      Returns:
      the execution priority (less is higher priority)
      Default:
      10

    • secure

      boolean secure
      Only used by Services Set to true to execute the service only if authentication and authorization succeed. The value can be overridden setting the configuration argument 'secure'
      Returns:
      true if secured
      Default:
      false

    • 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:
      ""

    • uriMatchPolicy

      RegisterPlugin.MATCH_POLICY uriMatchPolicy
      Only used by Services Sets the URI match policy of the Service.
      Returns:
      the URI match policy of the Service.
      Default:
      PREFIX

    • interceptPoint

      InterceptPoint interceptPoint
      Only used by Interceptors
      Returns:
      the intercept point of the Interceptor
      Default:
      REQUEST_AFTER_AUTH

    • requiredinterceptor

      boolean requiredinterceptor
      Only used by Interceptors Indicates that the interceptor should always intercept a service, regardless of its dontIntercept settings. This attribute is exclusively used by interceptors to ensure they are applied even when other interceptors are disabled via the dontIntercept attribute.
      Returns:
      true if the interceptor should always intercept, false otherwise
      Default:
      false

    • initPoint

      InitPoint initPoint
      Only used by Initializers
      Returns:
      the init point of the Intitialier
      Default:
      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:
      {}

    • authorizerType

      Authorizer.TYPE authorizerType
      Only used by Authorizers A request is allowed when no VETOER denies it and any ALLOWER allows it
      Returns:
      the authorizer type
      Default:
      ALLOWER

    • blocking

      boolean blocking
      Set to true to have the service dispached to the working thread pool, false to be executed directly by the IO thread
      Returns:
      true if the service executes blocking calls
      Default:
      true