Annotation Type Result


  • public @interface Result
    ResultDefinitionを定義するアノテーションです。

    typeがJSPの場合は、Template定義も作成されます。
    複数のResult定義で同一のJSP(またはテンプレート名で指定した名前)を指定した場合は、 解析順により最後の設定が有効になります。
    もし複数のResult定義で同一のTemplate定義を利用したい場合は、 Templateで定義を行い、 Result側はtypeをTEMPLATEにすることで対応可能です。

    See Also:
    ResultDefinition
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean acceptRanges
      type=STREAMの場合のみ有効です。Rangeヘッダーに対応するか否かを指定します。
      boolean allowExternalLocation
      type=REDIRECTの場合のみ有効です。 外部サイトへのリダイレクトを許可するかどうかのフラグです。 trueで外部サイトへリダイレクト許可となります。 デフォルトはfalseです。
      ContentDispositionType contentDispositionType
      type=JSP,TEMPLATE,STREAM,DYNAMICの場合のみ有効です。 ContentDispositionのタイプを指定します。
      java.lang.String contentLengthAttributeName
      type=STREAMの場合のみ有効です。streamのContentLengthが設定されたAttributeキーを指定します。
      java.lang.String contentType
      type=JSPの場合のcontentType指定です。
      java.lang.String contentTypeAttributeName
      type=STREAMの場合のみ有効です。streamのContentTypeが設定されたAttributeキーを指定します。
      java.lang.Class<? extends java.lang.Throwable> exception
      マッピング対象のCommand実行時の例外クラス(サブクラスも含む)を指定します。
      java.lang.String fileNameAttributeName
      type=JSP,TEMPLATE,STREAM,DYNAMICの場合のみ有効です。 ファイル名が設定されたAttributeキーを指定します。
      java.lang.String layoutActionAttributeName
      type=DYNAMICの場合のみ有効です。LayoutAction名が設定されたAttributeキーを指定します。 未指定の場合は、"layoutActionName"が適用されます。
      java.lang.String layoutActionName
      type=JSP,TEMPLATEの場合のみ有効です。LayoutAction名を指定します。
      boolean resolveByName
      type=TEMPLATEの場合、valueに指定する値をIDのみで解決する場合はfalseを設定します。
      デフォルトはtrueです。
      trueが指定された場合、テンプレートを次の順で解決します。 名前で検索 名前で解決できなかった場合、IDで検索
      java.lang.String status
      マッピング対象のCommandの実行結果ステータスを指定します。 *指定の場合は、すべてのステータス(但し例外発生時除く)を表します。 未指定の場合(かつ、exceptionが未指定の場合)は、*が指定されたとみなされます。
      java.lang.String templateName
      type=JSPの場合のtemplate名を指定可能です。未指定の場合、名前はjspファイルのパス(valueに設定した値)になります。
      Result.Type type
      ResultDefinitionのタイプを指定します。 デフォルト値はType.JSPです。
      boolean useContentDisposition
      type=JSP,TEMPLATE,STREAM,DYNAMICの場合に有効です。 ContentDispositionを設定するかどうかのフラグです。
      java.lang.String value
      type別に次のいずれかを指定します。
      JSP->JSPのパス。必須。
      TEMPLATE->Templateの名前もしくはID。必須。
      STREAM->RequestContextにセットされたInputStream or byte[] or BinaryReferenceのattribute名。未指定の場合は"streamData"
      REDIRECT->RequestContextにセットされた、redirect先パスのattribute名。必須。 DYNAMIC->RequestContextにセットされたテンプレート名を指定するattribute名。未指定の場合は"templateName"
    • Element Detail

      • status

        java.lang.String status
        マッピング対象のCommandの実行結果ステータスを指定します。 *指定の場合は、すべてのステータス(但し例外発生時除く)を表します。 未指定の場合(かつ、exceptionが未指定の場合)は、*が指定されたとみなされます。
        Returns:
        Default:
        "##default"
      • exception

        java.lang.Class<? extends java.lang.Throwable> exception
        マッピング対象のCommand実行時の例外クラス(サブクラスも含む)を指定します。
        Returns:
        Default:
        org.iplass.mtp.command.annotation.action.Result.UNSPECIFIED.class
      • type

        Result.Type type
        ResultDefinitionのタイプを指定します。 デフォルト値はType.JSPです。
        Default:
        org.iplass.mtp.command.annotation.action.Result.Type.JSP
      • value

        java.lang.String value
        type別に次のいずれかを指定します。
        JSP->JSPのパス。必須。
        TEMPLATE->Templateの名前もしくはID。必須。
        STREAM->RequestContextにセットされたInputStream or byte[] or BinaryReferenceのattribute名。未指定の場合は"streamData"
        REDIRECT->RequestContextにセットされた、redirect先パスのattribute名。必須。 DYNAMIC->RequestContextにセットされたテンプレート名を指定するattribute名。未指定の場合は"templateName"
        Default:
        "##default"
      • resolveByName

        boolean resolveByName
        type=TEMPLATEの場合、valueに指定する値をIDのみで解決する場合はfalseを設定します。
        デフォルトはtrueです。
        trueが指定された場合、テンプレートを次の順で解決します。
        1. 名前で検索
        2. 名前で解決できなかった場合、IDで検索
        Returns:
        Default:
        true
      • contentType

        java.lang.String contentType
        type=JSPの場合のcontentType指定です。
        Default:
        "##default"
      • templateName

        java.lang.String templateName
        type=JSPの場合のtemplate名を指定可能です。未指定の場合、名前はjspファイルのパス(valueに設定した値)になります。
        Returns:
        Default:
        "##default"
      • contentTypeAttributeName

        java.lang.String contentTypeAttributeName
        type=STREAMの場合のみ有効です。streamのContentTypeが設定されたAttributeキーを指定します。
        Default:
        "##default"
      • contentLengthAttributeName

        java.lang.String contentLengthAttributeName
        type=STREAMの場合のみ有効です。streamのContentLengthが設定されたAttributeキーを指定します。
        Default:
        "##default"
      • useContentDisposition

        boolean useContentDisposition
        type=JSP,TEMPLATE,STREAM,DYNAMICの場合に有効です。 ContentDispositionを設定するかどうかのフラグです。
        Default:
        false
      • contentDispositionType

        ContentDispositionType contentDispositionType
        type=JSP,TEMPLATE,STREAM,DYNAMICの場合のみ有効です。 ContentDispositionのタイプを指定します。
        Default:
        org.iplass.mtp.web.actionmapping.definition.result.ContentDispositionType.ATTACHMENT
      • fileNameAttributeName

        java.lang.String fileNameAttributeName
        type=JSP,TEMPLATE,STREAM,DYNAMICの場合のみ有効です。 ファイル名が設定されたAttributeキーを指定します。
        Default:
        "fileName"
      • acceptRanges

        boolean acceptRanges
        type=STREAMの場合のみ有効です。Rangeヘッダーに対応するか否かを指定します。
        Returns:
        Default:
        false
      • allowExternalLocation

        boolean allowExternalLocation
        type=REDIRECTの場合のみ有効です。 外部サイトへのリダイレクトを許可するかどうかのフラグです。 trueで外部サイトへリダイレクト許可となります。 デフォルトはfalseです。
        Default:
        false
      • layoutActionName

        java.lang.String layoutActionName
        type=JSP,TEMPLATEの場合のみ有効です。LayoutAction名を指定します。
        Default:
        ""
      • layoutActionAttributeName

        java.lang.String layoutActionAttributeName
        type=DYNAMICの場合のみ有効です。LayoutAction名が設定されたAttributeキーを指定します。 未指定の場合は、"layoutActionName"が適用されます。
        Default:
        "##default"