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