Class ApiKeyCredentials

java.lang.Object

io.leandev.appfuse.almanac.ApiKeyCredentials

All Implemented Interfaces:

AlmanacCredentials

public class ApiKeyCredentials
extends Object
implements AlmanacCredentials

以 API Key 認證 almanac

在每個請求加上 X-Almanac-Api-Key 標頭。API Key 由消費端提供，可為固定字串 或 Supplier（支援動態輪替 / 從 secret store 取得）。

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HEADER	almanac 接受 API Key 的 HTTP 標頭名稱

Constructor Summary

Constructors

Constructor	Description
ApiKeyCredentials(String apiKey)	以固定 API Key 建立
ApiKeyCredentials(Supplier<String> apiKeySupplier)	以動態 API Key 來源建立

Method Summary

Modifier and Type	Method	Description
void	apply(org.apache.hc.core5.http.ClassicHttpRequest request)	套用認證到請求（通常是設定一個或多個 HTTP 標頭）

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

HEADER

public static final String HEADER

almanac 接受 API Key 的 HTTP 標頭名稱

See Also:

• Constant Field Values

Constructor Details

ApiKeyCredentials

public ApiKeyCredentials(String apiKey)

以固定 API Key 建立

Parameters:

apiKey - API Key

ApiKeyCredentials

public ApiKeyCredentials(Supplier<String> apiKeySupplier)

以動態 API Key 來源建立

Parameters:

apiKeySupplier - 每次請求時取得 API Key 的供應器

Method Details

apply

public void apply(org.apache.hc.core5.http.ClassicHttpRequest request)

Description copied from interface: AlmanacCredentials

套用認證到請求（通常是設定一個或多個 HTTP 標頭）

Specified by:

apply in interface AlmanacCredentials

Parameters:

request - 即將送出的 HTTP 請求