query/me.ahoo.wow.query.policy/QueryEntryPolicy

QueryEntryPolicy

class QueryEntryPolicy @InternalWowApi constructor(val requireExplicitEntry: Boolean = false, val requireAuthenticatedScope: Boolean = false, val http: QueryBudget = QueryBudget.HTTP_DEFAULT, val inProcess: QueryBudget? = null, val inProcessTimeout: Duration? = QueryBudget.DEFAULT_TIMEOUT)

What a gateway requires of a query's QueryEntry before admitting it, and the budget each entry runs under.

Constructors

QueryEntryPolicy

@InternalWowApi

constructor(requireExplicitEntry: Boolean = false, requireAuthenticatedScope: Boolean = false, http: QueryBudget = QueryBudget.HTTP_DEFAULT, inProcess: QueryBudget? = null, inProcessTimeout: Duration? = QueryBudget.DEFAULT_TIMEOUT)

Types

Companion

object Companion

Properties

http

val http: QueryBudget

the budget of QueryEntry.HTTP queries.

inProcess

val inProcess: QueryBudget?

the budget of QueryEntry.IN_PROCESS and QueryEntry.UNSPECIFIED queries; null, the default, checks nothing. A host gives it QueryBudget.IN_PROCESS_DEFAULT by default (wow.query.budgets.in-process.*), so in-process code is bounded as a request is.

inProcessTimeout

val inProcessTimeout: Duration?

the execution timeout of a query whose entry has no budget (QueryEntry.UNBOUNDED, or every in-process query when inProcess is null: every query has one); null runs such a query without one.

requireAuthenticatedScope

val requireAuthenticatedScope: Boolean

rejects an QueryEntry.HTTP query on a built-in model whose QueryScope.authenticated does not pin the model's required scope. A declared scope (a tenant header, say) still filters the query but never satisfies this check. Off by default: the declared scope is trusted.

requireExplicitEntry

val requireExplicitEntry: Boolean

rejects QueryEntry.UNSPECIFIED queries, so every caller must say whether it is HTTP or in-process. Off by default: an unspecified entry is treated as in-process, which keeps existing QueryGateway callers working unchanged.

Functions

admit

fun admit(entry: QueryEntry): QueryEntry

The entry the query runs under, after this policy accepted it.

budget

fun budget(entry: QueryEntry): QueryBudget?

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

timeout

fun timeout(entry: QueryEntry): Duration?

The execution timeout of entry's queries: its budget's, or inProcessTimeout for an entry without one.

toString

open override fun toString(): String