クラス WebhookEndpoint
java.lang.Object
org.iplass.mtp.webhook.endpoint.WebhookEndpoint
Webhookの宛先、エンドポイントを表するクラス。
-
コンストラクタの概要
コンストラクタ説明WebhookEndpoint
(String url) Webhookに付けるエンドポイントを生成する。WebhookEndpoint
(String url, String hmacKey) Webhookに付けるエンドポイントを生成する。WebhookEndpoint
(String url, WebhookAuthenticationType headerAuthorizationType, String headerAuthorizationContent) Webhookに付けるエンドポイントを生成する。WebhookEndpoint
(String url, WebhookAuthenticationType headerAuthorizationType, String headerAuthorizationContent, String hmacKey) Webhookに付けるエンドポイントを生成する。 -
メソッドの概要
修飾子とタイプメソッド説明カスタムトークンを使用する場合のスキーム名を取得する。Authorizationヘッダーの内容を取得する。Authorizationヘッダーのタイプを取得する。HMAC 認証を置くヘッダーの名前を取得する。HMAC 秘密キーを取得する。getUrl()
Urlを取得する。void
setBasicAuthorization
(String userName, String password) BASIC認証を設置する。void
setBearerAuthorization
(String bearerToken) BEARER認証を設置する。void
setCustomAuthorization
(String schemeName, String customToken) カスタム認証を設置する。void
setHeaderAuthCustomTypeName
(String headerAuthCustomTypeName) カスタムトークンを使用する場合のスキーム名を設置する。void
setHeaderAuthorizationContent
(String headerAuthorizationContent) Authorizationヘッダーの内容を設置する。void
setHeaderAuthorizationType
(WebhookAuthenticationType headerAuthorizationType) Authorizationヘッダーのタイプを設置する。void
setHmacHashHeader
(String hmacHashHeader) HMAC 認証を置くヘッダーの名前を設置する。void
setHmacKey
(String hmacKey) HMAC 秘密キーを設置する。void
Urlを設置する。
-
コンストラクタの詳細
-
WebhookEndpoint
Webhookに付けるエンドポイントを生成する。- パラメータ:
url
- 宛先のURL
-
WebhookEndpoint
Webhookに付けるエンドポイントを生成する。- パラメータ:
url
- 宛先のURLhmacKey
- HMACハッシュに使う秘密キー
-
WebhookEndpoint
public WebhookEndpoint(String url, WebhookAuthenticationType headerAuthorizationType, String headerAuthorizationContent) Webhookに付けるエンドポイントを生成する。- パラメータ:
url
- 宛先のURLheaderAuthorizationType
- Authorizationヘッダーに付ける内容のタイプheaderAuthorizationContent
- Authorizationヘッダーに付ける内容、BASICの場合username:passwordの形にしてください
-
WebhookEndpoint
public WebhookEndpoint(String url, WebhookAuthenticationType headerAuthorizationType, String headerAuthorizationContent, String hmacKey) Webhookに付けるエンドポイントを生成する。- パラメータ:
url
- 宛先のURLheaderAuthorizationType
- Authorizationヘッダーに付ける内容のタイプheaderAuthorizationContent
- Authorizationヘッダーに付ける内容、BASICの場合username:passwordの形にしてくださいhmacKey
- HMACハッシュに使う秘密キー
-
-
メソッドの詳細
-
setBasicAuthorization
BASIC認証を設置する。既に設置したAuthorization内容は破棄される。- パラメータ:
userName
- ユーザー名password
- パスワード
-
setBearerAuthorization
BEARER認証を設置する。既に設置したAuthorization内容は破棄される。- パラメータ:
bearerToken
- BEARERトークン
-
setCustomAuthorization
カスタム認証を設置する。既に設置したAuthorization内容は破棄される。- パラメータ:
schemeName
- Authorizationヘッダーの内容に使うスキーム名customToken
- カスタムトークン
-
getUrl
Urlを取得する。 -
setUrl
Urlを設置する。- パラメータ:
url
- URL
-
getHeaderAuthorizationType
Authorizationヘッダーのタイプを取得する。 -
setHeaderAuthorizationType
Authorizationヘッダーのタイプを設置する。- パラメータ:
headerAuthorizationType
- タイプ
-
getHeaderAuthorizationContent
Authorizationヘッダーの内容を取得する。BASICの場合はusername:passwordの形になります。 -
setHeaderAuthorizationContent
Authorizationヘッダーの内容を設置する。BASICの場合はusername:passwordの形にしてください。- パラメータ:
headerAuthorizationContent
- 内容
-
getHmacKey
HMAC 秘密キーを取得する。 -
setHmacKey
HMAC 秘密キーを設置する。- パラメータ:
hmacKey
- 秘密キー
-
getHmacHashHeader
HMAC 認証を置くヘッダーの名前を取得する。 -
setHmacHashHeader
HMAC 認証を置くヘッダーの名前を設置する。- パラメータ:
hmacHashHeader
- ヘッダー名
-
getHeaderAuthCustomTypeName
カスタムトークンを使用する場合のスキーム名を取得する。 -
setHeaderAuthCustomTypeName
カスタムトークンを使用する場合のスキーム名を設置する。例:BASIC username:passwordの「BASIC」部分をカスタマイズする時に使う- パラメータ:
headerAuthCustomTypeName
- Authorizationヘッダーの内容に使うスキーム名
-