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