注釈インタフェース Result
public @interface Result
ResultDefinitionを定義するアノテーションです。
typeがJSPの場合は、Template定義も作成されます。
複数のResult定義で同一のJSP(またはテンプレート名で指定した名前)を指定した場合は、
解析順により最後の設定が有効になります。
もし複数のResult定義で同一のTemplate定義を利用したい場合は、
Template
で定義を行い、
Result側はtypeをTEMPLATEにすることで対応可能です。
- 関連項目:
-
ネストされたクラスの概要
修飾子とタイプクラス説明static enum
ResultDefinitionの種別です。static class
exceptionのマッピングで未指定を表すための例外クラスです(実際にこのクラスがスローされることはありません) -
任意要素の概要
修飾子とタイプ任意要素説明boolean
type=STREAMの場合のみ有効です。boolean
type=REDIRECTの場合のみ有効です。type=JSP,TEMPLATE,STREAM,DYNAMICの場合のみ有効です。type=STREAMの場合のみ有効です。type=JSPの場合のcontentType指定です。type=STREAMの場合のみ有効です。マッピング対象のCommand実行時の例外クラス(サブクラスも含む)を指定します。type=JSP,TEMPLATE,STREAM,DYNAMICの場合のみ有効です。type=DYNAMICの場合のみ有効です。type=JSP,TEMPLATEの場合のみ有効です。boolean
type=TEMPLATEの場合、valueに指定する値をIDのみで解決する場合はfalseを設定します。マッピング対象のCommandの実行結果ステータスを指定します。type=JSPの場合のtemplate名を指定可能です。ResultDefinitionのタイプを指定します。boolean
type=JSP,TEMPLATE,STREAM,DYNAMICの場合に有効です。type別に次のいずれかを指定します。
-
要素の詳細
-
status
String statusマッピング対象のCommandの実行結果ステータスを指定します。 *指定の場合は、すべてのステータス(但し例外発生時除く)を表します。 未指定の場合(かつ、exceptionが未指定の場合)は、*が指定されたとみなされます。- 戻り値:
- デフォルト:
"##default"
-
exception
マッピング対象のCommand実行時の例外クラス(サブクラスも含む)を指定します。- 戻り値:
- デフォルト:
org.iplass.mtp.command.annotation.action.Result.UNSPECIFIED.class
-
type
Result.Type typeResultDefinitionのタイプを指定します。 デフォルト値はType.JSPです。- デフォルト:
JSP
-
value
String valuetype別に次のいずれかを指定します。
JSP->JSPのパス。必須。
TEMPLATE->Templateの名前もしくはID。必須。
STREAM->RequestContextにセットされたInputStream or byte[] or BinaryReferenceのattribute名。未指定の場合は"streamData"
REDIRECT->RequestContextにセットされた、redirect先パスのattribute名。必須。 DYNAMIC->RequestContextにセットされたテンプレート名を指定するattribute名。未指定の場合は"templateName"- デフォルト:
"##default"
-
resolveByName
boolean resolveByNametype=TEMPLATEの場合、valueに指定する値をIDのみで解決する場合はfalseを設定します。
デフォルトはtrueです。
trueが指定された場合、テンプレートを次の順で解決します。- 名前で検索
- 名前で解決できなかった場合、IDで検索
- 戻り値:
- デフォルト:
true
-
contentType
String contentTypetype=JSPの場合のcontentType指定です。- デフォルト:
"##default"
-
templateName
String templateNametype=JSPの場合のtemplate名を指定可能です。未指定の場合、名前はjspファイルのパス(valueに設定した値)になります。- 戻り値:
- デフォルト:
"##default"
-
contentTypeAttributeName
String contentTypeAttributeNametype=STREAMの場合のみ有効です。streamのContentTypeが設定されたAttributeキーを指定します。- デフォルト:
"##default"
-
contentLengthAttributeName
String contentLengthAttributeNametype=STREAMの場合のみ有効です。streamのContentLengthが設定されたAttributeキーを指定します。- デフォルト:
"##default"
-
useContentDisposition
boolean useContentDispositiontype=JSP,TEMPLATE,STREAM,DYNAMICの場合に有効です。 ContentDispositionを設定するかどうかのフラグです。- デフォルト:
false
-
contentDispositionType
ContentDispositionType contentDispositionTypetype=JSP,TEMPLATE,STREAM,DYNAMICの場合のみ有効です。 ContentDispositionのタイプを指定します。- デフォルト:
ATTACHMENT
-
fileNameAttributeName
String fileNameAttributeNametype=JSP,TEMPLATE,STREAM,DYNAMICの場合のみ有効です。 ファイル名が設定されたAttributeキーを指定します。- デフォルト:
"fileName"
-
acceptRanges
boolean acceptRangestype=STREAMの場合のみ有効です。Rangeヘッダーに対応するか否かを指定します。- 戻り値:
- デフォルト:
false
-
allowExternalLocation
boolean allowExternalLocationtype=REDIRECTの場合のみ有効です。 外部サイトへのリダイレクトを許可するかどうかのフラグです。 trueで外部サイトへリダイレクト許可となります。 デフォルトはfalseです。- デフォルト:
false
-
layoutActionName
String layoutActionNametype=JSP,TEMPLATEの場合のみ有効です。LayoutAction名を指定します。- デフォルト:
""
-
layoutActionAttributeName
String layoutActionAttributeNametype=DYNAMICの場合のみ有効です。LayoutAction名が設定されたAttributeキーを指定します。 未指定の場合は、"layoutActionName"が適用されます。- デフォルト:
"##default"
-