クラス ActionMappingDefinition
java.lang.Object
org.iplass.mtp.web.actionmapping.definition.ActionMappingDefinition
- すべての実装されたインタフェース:
Serializable
,Definition
ActionMappingの定義です。
ActionMappingは、当該name(URLのパス)を呼び出された際の、処理内容を規定します。
実行するCommandと、その実行結果による表示内容(template)を定義します。
- 関連項目:
-
コンストラクタの概要
-
メソッドの概要
修飾子とタイプメソッド説明void
addLocalizedDisplayName
(LocalizedStringDefinition localizedDisplayName) String[]
long
概要を取得します。表示名を取得します。getName()
名前を取得します。boolean
boolean
isParts()
boolean
推奨されていません。boolean
boolean
boolean
void
setAllowMethod
(HttpMethodType[] allowMethod) 許可するHTTP Methodを指定。void
setAllowRequestContentTypes
(String[] allowRequestContentTypes) 許可するリクエストボディのContentTypeを指定。void
setCacheCriteria
(CacheCriteriaDefinition cacheCriteria) void
setClientCacheMaxAge
(long clientCacheMaxAge) clientCacheType=ClientCacheType.CACHEを指定した場合の クライアントキャッシュのmax-age(秒)を指定。void
setClientCacheType
(ClientCacheType clientCacheType) クライアントでのキャッシュ指定(Cache-Controlヘッダの制御)。void
setCommandConfig
(CommandConfig commandConfig) void
setDescription
(String description) 概要を設定します。void
setDisplayName
(String displayName) 表示名を設定します。void
setLocalizedDisplayNameList
(List<LocalizedStringDefinition> localizedDisplayNameList) void
setMaxFileSize
(Long maxFileSize) multipart/form-data時のアップロードファイルの最大サイズ。void
setMaxRequestBodySize
(Long maxRequestBodySize) リクエストボディの最大サイズ。void
名前を設定します。void
setNeedTrustedAuthenticate
(boolean needTrustedAuthenticate) 当該Action呼び出しに信頼された認証が必要な場合、trueをセット。void
setParamMap
(ParamMapDefinition[] paramMap) void
setParts
(boolean isParts) このActionMappingで指定される表示処理が部品かどうかを設定。void
setPrivilaged
(boolean isPrivileged) 推奨されていません。setPrivileged(boolean)
を使用してください。void
setPrivileged
(boolean isPrivileged) このActionMappingで処理されるCommand,Templateを特権(セキュリティ制約を受けない)にて処理するかどうかを設定。void
setPublicAction
(boolean isPublicAction) このActionの呼び出しをセキュリティ設定によらず呼び出し可能にする場合は、trueを設定。void
setResult
(ResultDefinition[] result) void
setSynchronizeOnSession
(boolean synchronizeOnSession) このActionを実行する際、自動的にsessionオブジェクトにて同期を行うか否かを設定。void
setTokenCheck
(TokenCheck tokenCheck)
-
コンストラクタの詳細
-
ActionMappingDefinition
public ActionMappingDefinition()
-
-
メソッドの詳細
-
getMaxFileSize
-
setMaxFileSize
multipart/form-data時のアップロードファイルの最大サイズ。-1の場合は無制限。 1つのファイルに対する最大サイズなので、複数のファイルの合計サイズを制限したい場合は、 maxRequestBodySizeを設定します。- パラメータ:
maxFileSize
-
-
getMaxRequestBodySize
-
setMaxRequestBodySize
リクエストボディの最大サイズ。-1の場合は無制限。- パラメータ:
maxRequestBodySize
-
-
getAllowRequestContentTypes
-
setAllowRequestContentTypes
許可するリクエストボディのContentTypeを指定。未指定の場合はすべて許可。- パラメータ:
allowRequestContentTypes
-
-
isNeedTrustedAuthenticate
public boolean isNeedTrustedAuthenticate()- 戻り値:
- 関連項目:
-
setNeedTrustedAuthenticate
public void setNeedTrustedAuthenticate(boolean needTrustedAuthenticate) 当該Action呼び出しに信頼された認証が必要な場合、trueをセット。 デフォルトfalse。- パラメータ:
needTrustedAuthenticate
-
-
getAllowMethod
- 戻り値:
- 関連項目:
-
setAllowMethod
許可するHTTP Methodを指定。未指定の場合は、すべて許可。- パラメータ:
allowMethod
-
-
isPublicAction
public boolean isPublicAction()- 戻り値:
- 関連項目:
-
setPublicAction
public void setPublicAction(boolean isPublicAction) このActionの呼び出しをセキュリティ設定によらず呼び出し可能にする場合は、trueを設定。 isPrivilegedとの違いは、Entityの操作などにおいては、セキュリティ制約を受ける。 デフォルトはfalse。- パラメータ:
isPublicAction
-
-
getClientCacheMaxAge
public long getClientCacheMaxAge()- 戻り値:
- 関連項目:
-
setClientCacheMaxAge
public void setClientCacheMaxAge(long clientCacheMaxAge) clientCacheType=ClientCacheType.CACHEを指定した場合の クライアントキャッシュのmax-age(秒)を指定。 デフォルト値は-1でこの場合はmax-ageは未指定となる。
注意:max-age未指定の場合、FF、Chromeでは実際はキャッシュが利用されない- パラメータ:
clientCacheMaxAge
-
-
isSynchronizeOnSession
public boolean isSynchronizeOnSession()- 戻り値:
- 関連項目:
-
setSynchronizeOnSession
public void setSynchronizeOnSession(boolean synchronizeOnSession) このActionを実行する際、自動的にsessionオブジェクトにて同期を行うか否かを設定。 同一セッションIDにて並列実行された場合に不整合が発生しうる場合にtrueをセットすることにより、 自動的にsession単位にsynchronizedされる。 ただ、Actionの処理全体でsynchronizedされるので、オーバーヘッドが大きい。 このフラグを利用するよりは、実際のCommandのコード内で、同期化が必要な処理部分のみ コード上でsynchronizedする方が望ましい。 デフォルトfalse。- パラメータ:
synchronizeOnSession
-
-
getName
インタフェースからコピーされた説明:Definition
名前を取得します。- 定義:
getName
インタフェース内Definition
- 戻り値:
- name
-
setName
インタフェースからコピーされた説明:Definition
名前を設定します。- 定義:
setName
インタフェース内Definition
- パラメータ:
name
- セットする name
-
getDisplayName
インタフェースからコピーされた説明:Definition
表示名を取得します。- 定義:
getDisplayName
インタフェース内Definition
- 戻り値:
- displayName
-
setDisplayName
インタフェースからコピーされた説明:Definition
表示名を設定します。- 定義:
setDisplayName
インタフェース内Definition
- パラメータ:
displayName
- セットする displayName
-
getLocalizedDisplayNameList
-
setLocalizedDisplayNameList
-
addLocalizedDisplayName
-
getDescription
インタフェースからコピーされた説明:Definition
概要を取得します。- 定義:
getDescription
インタフェース内Definition
- 戻り値:
- description
-
setDescription
インタフェースからコピーされた説明:Definition
概要を設定します。- 定義:
setDescription
インタフェース内Definition
- パラメータ:
description
- セットする description
-
getClientCacheType
- 戻り値:
- clientCacheType
- 関連項目:
-
setClientCacheType
クライアントでのキャッシュ指定(Cache-Controlヘッダの制御)。 未指定の場合はキャッシュを許す(service-config設定ファイルのデフォルト設定が適用)。 ブラウザ種別によらず、キャッシュを有効化するためには、合わせてclientCacheMaxAgeの設定も必要。- パラメータ:
clientCacheType
-- 関連項目:
-
isParts
public boolean isParts()- 戻り値:
- 関連項目:
-
setParts
public void setParts(boolean isParts) このActionMappingで指定される表示処理が部品かどうかを設定。 trueをセットした場合、クライアントからの直接呼出しが不可となる。- パラメータ:
isParts
-
-
isPrivilaged
推奨されていません。isPrivileged()
を使用してください。- 戻り値:
- 関連項目:
-
setPrivilaged
推奨されていません。setPrivileged(boolean)
を使用してください。このActionMappingで処理されるCommand,Templateを特権(セキュリティ制約を受けない)にて処理するかどうかを設定。 デフォルトはfalse。- パラメータ:
isPrivileged
-
-
isPrivileged
public boolean isPrivileged()- 戻り値:
- 関連項目:
-
setPrivileged
public void setPrivileged(boolean isPrivileged) このActionMappingで処理されるCommand,Templateを特権(セキュリティ制約を受けない)にて処理するかどうかを設定。 デフォルトはfalse。- パラメータ:
isPrivileged
-
-
getCommandConfig
- 戻り値:
- commandConfig
-
setCommandConfig
- パラメータ:
commandConfig
- セットする commandConfig
-
getParamMap
- 戻り値:
- paramMap
-
setParamMap
- パラメータ:
paramMap
- セットする paramMap
-
getResult
- 戻り値:
- result
-
setResult
- パラメータ:
result
- セットする result
-
getTokenCheck
- 戻り値:
- tokenCheck
-
setTokenCheck
- パラメータ:
tokenCheck
- セットする tokenCheck
-
getCacheCriteria
- 戻り値:
- cacheCriteria
-
setCacheCriteria
- パラメータ:
cacheCriteria
- セットする cacheCriteria
-
isPrivileged()
を使用してください。