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