パッケージ com.handywedge.rest

クラス FWRESTController

  • 直系の既知のサブクラス:
    FWRESTNoTokenController
    @RequestScoped
public abstract class FWRESTController
extends Object
    RESTインターフェースで公開するための抽象クラスです。
    HTTPのGET、POST、PUT、DELETEメソッドをサポートします。
    それぞれdoXXXメソッドをオーバーライドし処理を実装して下さい。
    GET以外は引数にJSONをアンマーシャルしたDTOクラスが渡されます。
    メソッドにFWRESTRequestClassアノテーションを修飾し、JSONをマッピングするFWRESTRequestを継承したクラスを指定します。
    GETメソッドについてはURLのパスパラメータが渡されます。
    各メソッドとも、戻り値はFWRESTResponseを継承したFWRESTResponseを継承したクラスを返却するとJSONにマーシャルしてクライアントに応答します。
    RESTインターフェースを使用する場合はweb.xmlにフィルターの設定が必要です。
     
 <filter-mapping>
   <filter-name>handywedge_rest_filter</filter-name>
   <url-pattern>/fw/rest/*</url-pattern>
 </filter-mapping>
    RESTインターフェースではAPIトークン認証が行われます。
    クライアントは、予めFWLoginManagerでトークンを発行し、リクエスト時にHTTPヘッダー(Authorization)でトークンを送信する必要があります。
    Authorization: Bearer APIトークン
    関連項目:
    FWLoginManager

    • コンストラクタの詳細

      • FWRESTController

        public FWRESTController()

    • メソッドの詳細

      • doPost

        public FWRESTResponse doPost​(FWRESTRequest request)
        HTTPのPOSTメソッドのリクエストで実行されます。
        パラメータ:
        request - JSONをアンマーシャルしたDTO
        戻り値:
        クライアントに応答するJSONにマーシャルするためのDTO

      • doGet

        public FWRESTResponse doGet​(String param)
        HTTPのGETメソッドのリクエストで実行されます。
        パラメータ:
        param - URLのパスパラメータ。
        戻り値:
        クライアントに応答するJSONにマーシャルするためのDTO

      • doPut

        public FWRESTResponse doPut​(FWRESTRequest request)
        HTTPのPUTメソッドのリクエストで実行されます。
        パラメータ:
        request - JSONをアンマーシャルしたDTO
        戻り値:
        クライアントに応答するJSONにマーシャルするためのDTO

      • doDelete

        public FWRESTResponse doDelete​(FWRESTRequest request)
        HTTPのDELETEメソッドのリクエストで実行されます。
        パラメータ:
        request - JSONをアンマーシャルしたDTO
        戻り値:
        クライアントに応答するJSONにマーシャルするためのDTO