Package com.esri.arcgis.enterprise.interceptor

Annotation Interface Interceptor

@Retention(RUNTIME) @Target(TYPE) public @interface Interceptor
The Interceptor annotation is used to mark implementations of the IServerServicesInterceptor interface. It provides metadata about the interceptor, such as its name, display name, description, URL patterns it applies to, and configurable properties.

This annotation should be applied at the type level to register an interceptor with the framework.

Elements:

  • name - The unique name of the interceptor.
  • displayName - A human-readable display name for the interceptor.
  • description - A brief description of the interceptor's purpose.
  • urlPatterns - The URL patterns to which the interceptor applies.
  • properties - The configurable properties for the interceptor.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
    Description of the interceptor
    String
    displayName
    Display name of the interceptor
    String
    name
    Name of the interceptor
    String[]
    properties
    Configurable properties for the interceptor
    String[]
    urlPatterns
    URL patterns to which the interceptor applies

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    chainingOrder
    Configurable chaining order for the interceptor

  • Element Details

    • name

      String name
      Name of the interceptor

    • displayName

      String displayName
      Display name of the interceptor

    • description

      String description
      Description of the interceptor

    • urlPatterns

      String[] urlPatterns
      URL patterns to which the interceptor applies

    • properties

      String[] properties
      Configurable properties for the interceptor

    • chainingOrder

      int chainingOrder
      Configurable chaining order for the interceptor
      Default:
      1