パッケージ org.iplass.mtp.webhook.endpoint

クラス WebhookEndpoint

java.lang.Object
org.iplass.mtp.webhook.endpoint.WebhookEndpoint
public class WebhookEndpoint extends Object
Webhookの宛先、エンドポイントを表するクラス。

  • コンストラクタの詳細

    • WebhookEndpoint

      public WebhookEndpoint(String url)
      Webhookに付けるエンドポイントを生成する。
      パラメータ:
      url - 宛先のURL

    • WebhookEndpoint

      public WebhookEndpoint(String url, String hmacKey)
      Webhookに付けるエンドポイントを生成する。
      パラメータ:
      url - 宛先のURL
      hmacKey - HMACハッシュに使う秘密キー

    • WebhookEndpoint

      public WebhookEndpoint(String url, WebhookAuthenticationType headerAuthorizationType, String headerAuthorizationContent)
      Webhookに付けるエンドポイントを生成する。
      パラメータ:
      url - 宛先のURL
      headerAuthorizationType - Authorizationヘッダーに付ける内容のタイプ
      headerAuthorizationContent - Authorizationヘッダーに付ける内容、BASICの場合username:passwordの形にしてください

    • WebhookEndpoint

      public WebhookEndpoint(String url, WebhookAuthenticationType headerAuthorizationType, String headerAuthorizationContent, String hmacKey)
      Webhookに付けるエンドポイントを生成する。
      パラメータ:
      url - 宛先のURL
      headerAuthorizationType - Authorizationヘッダーに付ける内容のタイプ
      headerAuthorizationContent - Authorizationヘッダーに付ける内容、BASICの場合username:passwordの形にしてください
      hmacKey - HMACハッシュに使う秘密キー

  • メソッドの詳細

    • setBasicAuthorization

      public void setBasicAuthorization(String userName, String password)
      BASIC認証を設置する。既に設置したAuthorization内容は破棄される。
      パラメータ:
      userName - ユーザー名
      password - パスワード

    • setBearerAuthorization

      public void setBearerAuthorization(String bearerToken)
      BEARER認証を設置する。既に設置したAuthorization内容は破棄される。
      パラメータ:
      bearerToken - BEARERトークン

    • setCustomAuthorization

      public void setCustomAuthorization(String schemeName, String customToken)
      カスタム認証を設置する。既に設置したAuthorization内容は破棄される。
      パラメータ:
      schemeName - Authorizationヘッダーの内容に使うスキーム名
      customToken - カスタムトークン

    • getUrl

      public String getUrl()
      Urlを取得する。

    • setUrl

      public void setUrl(String url)
      Urlを設置する。
      パラメータ:
      url - URL

    • getHeaderAuthorizationType

      public WebhookAuthenticationType getHeaderAuthorizationType()
      Authorizationヘッダーのタイプを取得する。

    • setHeaderAuthorizationType

      public void setHeaderAuthorizationType(WebhookAuthenticationType headerAuthorizationType)
      Authorizationヘッダーのタイプを設置する。
      パラメータ:
      headerAuthorizationType - タイプ

    • getHeaderAuthorizationContent

      public String getHeaderAuthorizationContent()
      Authorizationヘッダーの内容を取得する。BASICの場合はusername:passwordの形になります。

    • setHeaderAuthorizationContent

      public void setHeaderAuthorizationContent(String headerAuthorizationContent)
      Authorizationヘッダーの内容を設置する。BASICの場合はusername:passwordの形にしてください。
      パラメータ:
      headerAuthorizationContent - 内容

    • getHmacKey

      public String getHmacKey()
      HMAC 秘密キーを取得する。

    • setHmacKey

      public void setHmacKey(String hmacKey)
      HMAC 秘密キーを設置する。
      パラメータ:
      hmacKey - 秘密キー

    • getHmacHashHeader

      public String getHmacHashHeader()
      HMAC 認証を置くヘッダーの名前を取得する。

    • setHmacHashHeader

      public void setHmacHashHeader(String hmacHashHeader)
      HMAC 認証を置くヘッダーの名前を設置する。
      パラメータ:
      hmacHashHeader - ヘッダー名

    • getHeaderAuthCustomTypeName

      public String getHeaderAuthCustomTypeName()
      カスタムトークンを使用する場合のスキーム名を取得する。

    • setHeaderAuthCustomTypeName

      public void setHeaderAuthCustomTypeName(String headerAuthCustomTypeName)
      カスタムトークンを使用する場合のスキーム名を設置する。例:BASIC username:passwordの「BASIC」部分をカスタマイズする時に使う
      パラメータ:
      headerAuthCustomTypeName - Authorizationヘッダーの内容に使うスキーム名