Package org.apache.nifi.annotation.behavior

Annotation Interface Restricted

@Documented @Target(TYPE) @Retention(RUNTIME) @Inherited public @interface Restricted

Marks the usage of a component as restricted to users with elevated privileges.

A Restricted component is one that can be used to execute arbitrary unsanitized code provided by the operator through the NiFi REST API/UI or can be used to obtain or alter data on the NiFi host system using the NiFi OS credentials. These components could be used by an otherwise authorized NiFi user to go beyond the intended use of the application, escalate privilege, or could expose data about the internals of the NiFi process or the host system. All of these capabilities should be considered privileged, and admins should be aware of these capabilities and explicitly enable them for a subset of trusted users.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Restriction[]
    restrictions
    Provides a listing of specific Restrictions.
    String
    value
    Provides a description of why the component usage is restricted.

  • Element Details

    • value

      String value
      Provides a description of why the component usage is restricted. If using granular restrictions, specific explanations should be set in the Restriction.
      Default:
      ""

    • restrictions

      Restriction[] restrictions
      Provides a listing of specific Restrictions. If unspecified, this component will require access to restricted components regardless of restrictions.
      Default:
      {}