Package org.apache.polaris.service.context

Interface RealmContextConfiguration

public interface RealmContextConfiguration

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    defaultRealm()
    The default realm to use when no realm is specified.
    String
    headerName()
    The header name that contains the realm identifier.
    @Size(min=1) List<String>
    realms()
    The set of realms that are supported by the realm context resolver.
    boolean
    requireHeader()
    Whether to require the realm header to be present in the request.

  • Method Details

    • realms

      @Size(min=1) @Size(min=1) List<String> realms()
      The set of realms that are supported by the realm context resolver. The first realm is considered the default realm.

    • headerName

      String headerName()
      The header name that contains the realm identifier.

    • requireHeader

      boolean requireHeader()
      Whether to require the realm header to be present in the request. If this is true and the realm header is not present, the request will be rejected. If this is false and the realm header is not present, the default realm will be used.

      Note: this is actually only enforced in production setups.

    • defaultRealm

      default String defaultRealm()
      The default realm to use when no realm is specified.