Package com.esri.arcgis.enterprise.interceptor

Interface IInterceptorConfig

public interface IInterceptorConfig
The IInterceptorConfig interface defines the configuration contract for an interceptor in the ArcGIS Enterprise framework. It provides methods to access metadata, operational state, URL patterns, custom properties, and chaining order for an interceptor implementation.

Implementations of this interface supply configuration details that control how and when an interceptor is applied to HTTP requests, as well as its behavior and integration with the system.

Typical usage includes:

  • Retrieving the name, display name, and description of the interceptor
  • Accessing the class name and version of the interceptor implementation
  • Checking if the interceptor is enabled
  • Obtaining URL patterns that determine which requests are intercepted
  • Getting custom properties for runtime configuration
  • Determining the chaining order for execution precedence

  • Method Details

    • getInterceptorName

      String getInterceptorName()
      Get name of the interceptor

    • getDisplayName

      String getDisplayName()
      Get display name of the interceptor

    • getDescription

      String getDescription()
      Get description of the interceptor

    • getInterceptorClass

      String getInterceptorClass()
      Get interceptor class

    • getInterceptorVersion

      String getInterceptorVersion()
      Get interceptor version

    • isEnabled

      boolean isEnabled()
      Check if interceptor is enabled

    • getUrlPatterns

      String[] getUrlPatterns()
      Get URL pattern configuration of the interceptor. Requests matching the URL pattern will be intercepted by this interceptor
      Returns:
      Array of URL pattern

    • getProperties

      Map<String,String> getProperties()
      Get custom properties of the interceptor. These properties can be changed through the Admin API and passed to the interceptor init method
      Returns:
      Map of custom interceptor properties

    • getChainingOrder

      int getChainingOrder()
      Get chaining order of the interceptor. Chaining order controls the order of execution when there are more interceptors matching a given URL. This order can be updated using Admin API
      Returns:
      Configured chaining order of the interceptor