ActionMappingDefinition (iplass-web 3.1.24 API)

java.lang.Object
- org.iplass.mtp.web.actionmapping.definition.ActionMappingDefinition

```
public class ActionMappingDefinition
extends java.lang.Object
```
ActionMappingの定義です。 ActionMappingは、当該name（URLのパス）を呼び出された際の、処理内容を規定します。実行するCommandと、その実行結果による表示内容（template）を定義します。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

ActionMappingDefinition()

コンストラクタ
コンストラクタと説明
`ActionMappingDefinition()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addLocalizedDisplayName(LocalizedStringDefinition localizedDisplayName)`
`HttpMethodType[]`	`getAllowMethod()`
`java.lang.String[]`	`getAllowRequestContentTypes()`
`CacheCriteriaDefinition`	`getCacheCriteria()`
`long`	`getClientCacheMaxAge()`
`ClientCacheType`	`getClientCacheType()`
`CommandConfig`	`getCommandConfig()`
`java.lang.String`	`getDescription()`
`java.lang.String`	`getDisplayName()`
`java.util.List<LocalizedStringDefinition>`	`getLocalizedDisplayNameList()`
`java.lang.Long`	`getMaxFileSize()`
`java.lang.Long`	`getMaxRequestBodySize()`
`java.lang.String`	`getName()`
`ParamMapDefinition[]`	`getParamMap()`
`ResultDefinition[]`	`getResult()`
`TokenCheck`	`getTokenCheck()`
`boolean`	`isNeedTrustedAuthenticate()`
`boolean`	`isParts()`
`boolean`	`isPrivilaged()`
`boolean`	`isPublicAction()`
`boolean`	`isSynchronizeOnSession()`
`void`	`setAllowMethod(HttpMethodType[] allowMethod)` 許可するHTTP Methodを指定。
`void`	`setAllowRequestContentTypes(java.lang.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(java.lang.String description)`
`void`	`setDisplayName(java.lang.String displayName)`
`void`	`setLocalizedDisplayNameList(java.util.List<LocalizedStringDefinition> localizedDisplayNameList)`
`void`	`setMaxFileSize(java.lang.Long maxFileSize)` multipart/form-data時のアップロードファイルの最大サイズ。
`void`	`setMaxRequestBodySize(java.lang.Long maxRequestBodySize)` リクエストボディの最大サイズ。
`void`	`setName(java.lang.String name)`
`void`	`setNeedTrustedAuthenticate(boolean needTrustedAuthenticate)` 当該Action呼び出しに信頼された認証が必要な場合、trueをセット。
`void`	`setParamMap(ParamMapDefinition[] paramMap)`
`void`	`setParts(boolean isParts)` このActionMappingで指定される表示処理が部品かどうかを設定。
`void`	`setPrivilaged(boolean isPrivilaged)` このActionMappingで処理されるCommand,Templateを特権（セキュリティ制約を受けない）にて処理するかどうかを設定。
`void`	`setPublicAction(boolean isPublicAction)` このActionの呼び出しをセキュリティ設定によらず呼び出し可能にする場合は、trueを設定。
`void`	`setResult(ResultDefinition[] result)`
`void`	`setSynchronizeOnSession(boolean synchronizeOnSession)` このActionを実行する際、自動的にsessionオブジェクトにて同期を行うか否かを設定。
`void`	`setTokenCheck(TokenCheck tokenCheck)`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - ActionMappingDefinition
```
public ActionMappingDefinition()
```
- メソッドの詳細
  - getMaxFileSize
```
public java.lang.Long getMaxFileSize()
```
  - setMaxFileSize
```
public void setMaxFileSize(java.lang.Long maxFileSize)
```
    multipart/form-data時のアップロードファイルの最大サイズ。-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
```
public HttpMethodType[] getAllowMethod()
```
    戻り値:
    
    関連項目:
    
    setAllowMethod(HttpMethodType[])
  - setAllowMethod
```
public void setAllowMethod(HttpMethodType[] allowMethod)
```
    許可するHTTP Methodを指定。未指定の場合は、すべて許可。
    
    パラメータ:
    
    allowMethod -
  - isPublicAction
```
public boolean isPublicAction()
```
    戻り値:
    
    関連項目:
    
    setPublicAction(boolean)
  - setPublicAction
```
public void setPublicAction(boolean isPublicAction)
```
    このActionの呼び出しをセキュリティ設定によらず呼び出し可能にする場合は、trueを設定。 isPrivilagedとの違いは、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()
```
    戻り値:
    
    name
  - setName
```
public void setName(java.lang.String name)
```
    パラメータ:
    
    name - セットする name
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    戻り値:
    
    displayName
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    パラメータ:
    
    displayName - セットする displayName
  - getLocalizedDisplayNameList
```
public java.util.List<LocalizedStringDefinition> getLocalizedDisplayNameList()
```
  - setLocalizedDisplayNameList
```
public void setLocalizedDisplayNameList(java.util.List<LocalizedStringDefinition> localizedDisplayNameList)
```
  - addLocalizedDisplayName
```
public void addLocalizedDisplayName(LocalizedStringDefinition localizedDisplayName)
```
  - getDescription
```
public java.lang.String getDescription()
```
    戻り値:
    
    description
  - setDescription
```
public void setDescription(java.lang.String description)
```
    パラメータ:
    
    description - セットする description
  - getClientCacheType
```
public ClientCacheType getClientCacheType()
```
    戻り値:
    
    clientCacheType
    
    関連項目:
    
    setClientCacheType(ClientCacheType)
  - setClientCacheType
```
public void setClientCacheType(ClientCacheType clientCacheType)
```
    クライアントでのキャッシュ指定（Cache-Controlヘッダの制御）。未指定の場合はキャッシュを許す（service-config設定ファイルのデフォルト設定が適用）。ブラウザ種別によらず、キャッシュを有効化するためには、合わせてclientCacheMaxAgeの設定も必要。
    
    パラメータ:
    
    clientCacheType -
    
    関連項目:
    
    setClientCacheMaxAge(long)
  - isParts
```
public boolean isParts()
```
    戻り値:
    
    関連項目:
    
    setParts(boolean)
  - setParts
```
public void setParts(boolean isParts)
```
    このActionMappingで指定される表示処理が部品かどうかを設定。 trueをセットした場合、クライアントからの直接呼出しが不可となる。
    
    パラメータ:
    
    isParts -
  - isPrivilaged
```
public boolean isPrivilaged()
```
    戻り値:
    
    関連項目:
    
    setPrivilaged(boolean)
  - setPrivilaged
```
public void setPrivilaged(boolean isPrivilaged)
```
    このActionMappingで処理されるCommand,Templateを特権（セキュリティ制約を受けない）にて処理するかどうかを設定。デフォルトはfalse。
    
    パラメータ:
    
    isPrivilaged -
  - getCommandConfig
```
public CommandConfig getCommandConfig()
```
    戻り値:
    
    commandConfig
  - setCommandConfig
```
public void setCommandConfig(CommandConfig commandConfig)
```
    パラメータ:
    
    commandConfig - セットする commandConfig
  - getParamMap
```
public ParamMapDefinition[] getParamMap()
```
    戻り値:
    
    paramMap
  - setParamMap
```
public void setParamMap(ParamMapDefinition[] paramMap)
```
    パラメータ:
    
    paramMap - セットする paramMap
  - getResult
```
public ResultDefinition[] getResult()
```
    戻り値:
    
    result
  - setResult
```
public void setResult(ResultDefinition[] result)
```
    パラメータ:
    
    result - セットする result
  - getTokenCheck
```
public TokenCheck getTokenCheck()
```
    戻り値:
    
    tokenCheck
  - setTokenCheck
```
public void setTokenCheck(TokenCheck tokenCheck)
```
    パラメータ:
    
    tokenCheck - セットする tokenCheck
  - getCacheCriteria
```
public CacheCriteriaDefinition getCacheCriteria()
```
    戻り値:
    
    cacheCriteria
  - setCacheCriteria
```
public void setCacheCriteria(CacheCriteriaDefinition cacheCriteria)
```
    パラメータ:
    
    cacheCriteria - セットする cacheCriteria

クラス ActionMappingDefinition

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

ActionMappingDefinition

メソッドの詳細

getMaxFileSize

setMaxFileSize

getMaxRequestBodySize

setMaxRequestBodySize

getAllowRequestContentTypes

setAllowRequestContentTypes

isNeedTrustedAuthenticate

setNeedTrustedAuthenticate

getAllowMethod

setAllowMethod

isPublicAction

setPublicAction

getClientCacheMaxAge

setClientCacheMaxAge

isSynchronizeOnSession

setSynchronizeOnSession

getName

setName

getDisplayName

setDisplayName

getLocalizedDisplayNameList

setLocalizedDisplayNameList

addLocalizedDisplayName

getDescription

setDescription

getClientCacheType

setClientCacheType

isParts

setParts

isPrivilaged

setPrivilaged

getCommandConfig

setCommandConfig

getParamMap

setParamMap

getResult

setResult

getTokenCheck

setTokenCheck

getCacheCriteria

setCacheCriteria