AbstractAbstract ReadonlyCapabilitiesWhat this driver can do. Declared by the class, never read from the database.
ProtectedconfigConfiguration from the metadata record, set during Initialize.
Why this driver is unavailable, for diagnostics. Null when it is available.
AbstractCheckDetermine whether this driver can serve requests, calling MarkAvailable or MarkUnavailable exactly once.
Must not throw for the ordinary "not configured here" case — see the class note.
AbstractExecuteExecute a search. Called only when IsAvailable is true.
ProtectedGetRead a non-secret setting from the record's ProviderConfig JSON.
ProtectedGetRead a credential value, preferring the decrypted MJ: Credentials record and falling back
to an environment variable.
The fallback exists because the web search actions this engine supersedes read their keys
from mj.config.cjs / the environment, and a host upgrading should not have to migrate its
secrets into the Credential store on the same day it gains the engine.
key within the credential record's decrypted values, e.g. apiKey
environment variable consulted when no credential value is present
Receive configuration from the provider's metadata record.
The default stores it; override to do additional setup, and call super.Initialize(...).
Whether this driver may participate in searches. False until CheckAvailability says otherwise.
ProtectedMarkMark this driver operational. Call from CheckAvailability.
ProtectedMarkMark this driver unusable, with a reason an administrator can act on.
ProtectedResolveThe effective result cap: the caller's request, bounded by the metadata override (when set) and then by the vendor's own hard cap.
Clamped rather than rejected — a caller asking for 50 wants as many as possible, and most vendors reject the whole request when asked for more than they serve.
StaticGetEnumerate every registered driver with its capabilities, for admin UI dropdowns.
Instantiates each registration to read Capabilities, so a driver's constructor must stay
side-effect free.
Abstract base for a web search driver.
Subclasses register with
@RegisterClass(BaseWebSearchProvider, 'DriverClassName')to become discoverable by WebSearchEngine.Lifecycle, per provider record, at engine config time:
WebSearchEngineloads ActiveMJ: Web Search ProvidersrecordsDriverClassA driver that cannot work — no API key, missing optional dependency — must self-disable in
CheckAvailabilityrather than throw. An unconfigured vendor is a normal state in a product shipped to many hosts, not an error, and the engine simply routes around it.