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

クラス Webhook

java.lang.Object
org.iplass.mtp.webhook.Webhook

public class Webhook
extends java.lang.Object
送るウェッブフックを表します。
  • コンストラクタの概要

    コンストラクタ 
    コンストラクタ 説明
    Webhook()  
  • メソッドの概要

    修飾子とタイプ メソッド 説明
    void addHeader​(WebhookHeader header)
    カスタムヘッダーを追加する。
    java.lang.String getContentType()
    送る内容のタイプを取得する。
    WebhookEndpoint getEndpoint()
    宛先クラスWebhookEndpointオブジェクトを取得する。
    java.util.List<WebhookHeader> getHeaders()
    カスタムヘッダーを取得する。
    java.lang.String getHttpMethod()
    設定したHTTP接続メソッド名を取得する。
    java.lang.String getPathAndQuery()
    Urlのパスとクエリ―を取得します。
    java.lang.String getPayloadContent()
    送る内容を取得する。
    WebhookResponseHandler getResponseHandler()
    返事結果処理のオブジェクトを取得する。
    void setContentType​(java.lang.String contentType)
    送る内容のタイプを設定する。
    void setEndpoint​(WebhookEndpoint endpoint)
    宛先を設置する。
    void setHeaders​(java.util.List<WebhookHeader> headers)
    カスタムヘッダーを設置する。
    void setHttpMethod​(java.lang.String httpMethod)
    HTTP connectionのメソッドをセットする、未設定ならPOSTになります。
    void setPathAndQuery​(java.lang.String pathAndQuery)
    Urlのパスとクエリ―を設置します。"?"
    void setPayloadContent​(java.lang.String payloadContent)
    送る内容を設置する。
    void setResponseHandler​(WebhookResponseHandler responseHandler)
    返事結果処理のオブジェクトを設置する。

    クラスから継承されたメソッド java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • コンストラクタの詳細

  • メソッドの詳細

    • getHeaders

      public java.util.List<WebhookHeader> getHeaders()
      カスタムヘッダーを取得する。
    • setHeaders

      public void setHeaders​(java.util.List<WebhookHeader> headers)
      カスタムヘッダーを設置する。
      パラメータ:
      headers - WebhookHeaderのリスト
    • addHeader

      public void addHeader​(WebhookHeader header)
      カスタムヘッダーを追加する。
      パラメータ:
      headers - WebhookHeader object
    • getHttpMethod

      public java.lang.String getHttpMethod()
      設定したHTTP接続メソッド名を取得する。
    • setHttpMethod

      public void setHttpMethod​(java.lang.String httpMethod)
      HTTP connectionのメソッドをセットする、未設定ならPOSTになります。
      パラメータ:
      httpMethod - 大文字でメソッド名を設定する。例:POST、GETなと
    • getContentType

      public java.lang.String getContentType()
      送る内容のタイプを取得する。
    • setContentType

      public void setContentType​(java.lang.String contentType)
      送る内容のタイプを設定する。
      パラメータ:
      contentType - Content-Typeヘッダに置く内容
    • getPathAndQuery

      public java.lang.String getPathAndQuery()
      Urlのパスとクエリ―を取得します。
    • setPathAndQuery

      public void setPathAndQuery​(java.lang.String pathAndQuery)
      Urlのパスとクエリ―を設置します。"?"の付けをご注意ください。
      パラメータ:
      pathAndQuery - クエリ―内容
    • getResponseHandler

      public WebhookResponseHandler getResponseHandler()
      返事結果処理のオブジェクトを取得する。
    • setResponseHandler

      public void setResponseHandler​(WebhookResponseHandler responseHandler)
      返事結果処理のオブジェクトを設置する。
      パラメータ:
      responseHandler - WebhookResponseHandlerオブジェクト
    • getPayloadContent

      public java.lang.String getPayloadContent()
      送る内容を取得する。
    • setPayloadContent

      public void setPayloadContent​(java.lang.String payloadContent)
      送る内容を設置する。
      パラメータ:
      payloadContent - Content-Typeフォーマットに応じた内容
    • getEndpoint

      public WebhookEndpoint getEndpoint()
      宛先クラスWebhookEndpointオブジェクトを取得する。
    • setEndpoint

      public void setEndpoint​(WebhookEndpoint endpoint)
      宛先を設置する。
      パラメータ:
      endpoint - WebhookEndpoint オブジェクト