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