WebApiDefinition (iplass-web 3.1.0 API)

java.lang.Object
- org.iplass.mtp.webapi.definition.WebApiDefinition

public class WebApiDefinition
extends java.lang.Object

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

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

WebApiDefinition()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`RequestType[]`	`getAccepts()`
`java.lang.String`	`getAccessControlAllowOrigin()`
`java.lang.String[]`	`getAllowRequestContentTypes()`
`long`	`getCacheControlMaxAge()`
`CacheControlType`	`getCacheControlType()`
`CommandConfig`	`getCommandConfig()`
`java.lang.String`	`getDescription()`
`java.lang.String`	`getDisplayName()`
`java.lang.Long`	`getMaxFileSize()`
`java.lang.Long`	`getMaxRequestBodySize()`
`MethodType[]`	`getMethods()`
`java.lang.String`	`getName()`
`java.lang.String[]`	`getOauthScopes()`
`java.lang.String`	`getResponseType()`
`java.lang.String`	`getRestJsonParameterName()`
`java.lang.String`	`getRestJsonParameterType()`
`java.lang.String`	`getRestXmlParameterName()`
`java.lang.String[]`	`getResults()`
`StateType`	`getState()`
`WebApiTokenCheck`	`getTokenCheck()`
`WebApiParamMapDefinition[]`	`getWebApiParamMap()`
`boolean`	`isAccessControlAllowCredentials()`
`boolean`	`isCheckXRequestedWithHeader()` XMLHttpRequestがセットされていることを確認するかを取得します。
`boolean`	`isNeedTrustedAuthenticate()`
`boolean`	`isPrivilaged()`
`boolean`	`isPublicWebApi()`
`boolean`	`isSupportBearerToken()`
`boolean`	`isSynchronizeOnSession()`
`void`	`setAccepts(RequestType[] accepts)`
`void`	`setAccessControlAllowCredentials(boolean accessControlAllowCredentials)`
`void`	`setAccessControlAllowOrigin(java.lang.String accessControlAllowOrigin)`
`void`	`setAllowRequestContentTypes(java.lang.String[] allowRequestContentTypes)` 許可するリクエストボディのContentTypeを指定。
`void`	`setCacheControlMaxAge(long cacheControlMaxAge)` cacheControlMaxAge=CacheControlType.CACHEを指定した場合の WebAPIキャッシュのmax-age（秒）を指定。
`void`	`setCacheControlType(CacheControlType cacheControlType)` WebAPIキャッシュ指定（Cache-Controlヘッダの制御）。
`void`	`setCheckXRequestedWithHeader(boolean isCheckXRequestedWithHeader)` XMLHttpRequestチェック可否を設定します。
`void`	`setCommandConfig(CommandConfig commandConfig)`
`void`	`setDescription(java.lang.String description)`
`void`	`setDisplayName(java.lang.String displayName)`
`void`	`setMaxFileSize(java.lang.Long maxFileSize)` multipart/form-data時のアップロードファイルの最大サイズ。
`void`	`setMaxRequestBodySize(java.lang.Long maxRequestBodySize)` リクエストボディの最大サイズ。
`void`	`setMethods(MethodType[] methods)`
`void`	`setName(java.lang.String name)`
`void`	`setNeedTrustedAuthenticate(boolean needTrustedAuthenticate)`
`void`	`setOauthScopes(java.lang.String[] oauthScopes)`
`void`	`setPrivilaged(boolean isPrivilaged)`
`void`	`setPublicWebApi(boolean isPublicWebApi)` このWebApiの呼び出しをセキュリティ設定によらず呼び出し可能にする場合は、trueを設定します。
`void`	`setResponseType(java.lang.String responseType)`
`void`	`setRestJsonParameterName(java.lang.String restJsonParameterName)`
`void`	`setRestJsonParameterType(java.lang.String restJsonParameterType)`
`void`	`setRestXmlParameterName(java.lang.String restXmlParameterName)`
`void`	`setResults(java.lang.String[] results)`
`void`	`setState(StateType state)` WebApiをStatelessとして呼び出すか否かを設定します。
`void`	`setSupportBearerToken(boolean supportBearerToken)`
`void`	`setSynchronizeOnSession(boolean synchronizeOnSession)`
`void`	`setTokenCheck(WebApiTokenCheck tokenCheck)`
`void`	`setWebApiParamMap(WebApiParamMapDefinition[] webApiParamMap)`

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

- コンストラクタの詳細
  - WebApiDefinition
```
public WebApiDefinition()
```
- メソッドの詳細
  - 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を指定。未指定の場合はすべて許可。
    accepts指定より、allowRequestContentTypesの指定による制限が優先されます。
    例えば、 accepts指定によりJSON形式の処理が有効化されている場合において、 allowRequestContentTypesに"application/json"が含まれない場合は、 JSON形式によるリクエストは処理されません。
    
    パラメータ:
    
    allowRequestContentTypes -
  - getOauthScopes
```
public java.lang.String[] getOauthScopes()
```
  - setOauthScopes
```
public void setOauthScopes(java.lang.String[] oauthScopes)
```
  - isSupportBearerToken
```
public boolean isSupportBearerToken()
```
  - setSupportBearerToken
```
public void setSupportBearerToken(boolean supportBearerToken)
```
  - getState
```
public StateType getState()
```
  - setState
```
public void setState(StateType state)
```
    WebApiをStatelessとして呼び出すか否かを設定します。デフォルトは、StateType.STATEFULです。
    
    パラメータ:
    
    state -
  - isNeedTrustedAuthenticate
```
public boolean isNeedTrustedAuthenticate()
```
  - setNeedTrustedAuthenticate
```
public void setNeedTrustedAuthenticate(boolean needTrustedAuthenticate)
```
  - getAccessControlAllowOrigin
```
public java.lang.String getAccessControlAllowOrigin()
```
  - setAccessControlAllowOrigin
```
public void setAccessControlAllowOrigin(java.lang.String accessControlAllowOrigin)
```
  - isAccessControlAllowCredentials
```
public boolean isAccessControlAllowCredentials()
```
  - setAccessControlAllowCredentials
```
public void setAccessControlAllowCredentials(boolean accessControlAllowCredentials)
```
  - getResponseType
```
public java.lang.String getResponseType()
```
  - setResponseType
```
public void setResponseType(java.lang.String responseType)
```
  - isSynchronizeOnSession
```
public boolean isSynchronizeOnSession()
```
  - setSynchronizeOnSession
```
public void setSynchronizeOnSession(boolean synchronizeOnSession)
```
  - getTokenCheck
```
public WebApiTokenCheck getTokenCheck()
```
  - setTokenCheck
```
public void setTokenCheck(WebApiTokenCheck tokenCheck)
```
  - getRestJsonParameterType
```
public java.lang.String getRestJsonParameterType()
```
  - setRestJsonParameterType
```
public void setRestJsonParameterType(java.lang.String restJsonParameterType)
```
  - getRestJsonParameterName
```
public java.lang.String getRestJsonParameterName()
```
  - setRestJsonParameterName
```
public void setRestJsonParameterName(java.lang.String restJsonParameterName)
```
  - getRestXmlParameterName
```
public java.lang.String getRestXmlParameterName()
```
  - setRestXmlParameterName
```
public void setRestXmlParameterName(java.lang.String restXmlParameterName)
```
  - getAccepts
```
public RequestType[] getAccepts()
```
  - setAccepts
```
public void setAccepts(RequestType[] accepts)
```
  - getMethods
```
public MethodType[] getMethods()
```
  - setMethods
```
public void setMethods(MethodType[] methods)
```
  - 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
  - getDescription
```
public java.lang.String getDescription()
```
    戻り値:
    
    description
  - setDescription
```
public void setDescription(java.lang.String description)
```
    パラメータ:
    
    description - セットする description
  - getCacheControlType
```
public CacheControlType getCacheControlType()
```
    戻り値:
    
    cacheControlType
    
    関連項目:
    
    #setCacheControlType(cacheControlType)
  - setCacheControlType
```
public void setCacheControlType(CacheControlType cacheControlType)
```
    WebAPIキャッシュ指定（Cache-Controlヘッダの制御）。未指定の場合はキャッシュをしない。ブラウザ種別によらず、キャッシュを有効化するためには、合わせてCacheControlMaxAgeの設定も必要。
    
    パラメータ:
    
    cacheControlType -
    
    関連項目:
    
    setCacheControlMaxAge(long)
  - getCacheControlMaxAge
```
public long getCacheControlMaxAge()
```
    戻り値:
    
    関連項目:
    
    setCacheControlMaxAge(long)
  - setCacheControlMaxAge
```
public void setCacheControlMaxAge(long cacheControlMaxAge)
```
    cacheControlMaxAge=CacheControlType.CACHEを指定した場合の WebAPIキャッシュのmax-age（秒）を指定。デフォルト値は-1でこの場合はmax-ageは未指定となる。
    注意：max-age未指定の場合、FF、Chromeでは実際はキャッシュが利用されない
    
    パラメータ:
    
    cacheControlMaxAge -
  - getCommandConfig
```
public CommandConfig getCommandConfig()
```
    戻り値:
    
    commandConfig
  - setCommandConfig
```
public void setCommandConfig(CommandConfig commandConfig)
```
    パラメータ:
    
    commandConfig - セットする commandConfig
  - getWebApiParamMap
```
public WebApiParamMapDefinition[] getWebApiParamMap()
```
    戻り値:
    
    paramMap
  - setWebApiParamMap
```
public void setWebApiParamMap(WebApiParamMapDefinition[] webApiParamMap)
```
    パラメータ:
    
    webApiParamMap - セットする webApiParamMap
  - getResults
```
public java.lang.String[] getResults()
```
    戻り値:
    
    result
  - setResults
```
public void setResults(java.lang.String[] results)
```
    パラメータ:
    
    result - セットする result
  - isPublicWebApi
```
public boolean isPublicWebApi()
```
  - setPublicWebApi
```
public void setPublicWebApi(boolean isPublicWebApi)
```
    このWebApiの呼び出しをセキュリティ設定によらず呼び出し可能にする場合は、trueを設定します。 isPrivilagedとの違いは、Entityの操作などにおいては、セキュリティ制約を受けます。デフォルトはfalseです。
    
    パラメータ:
    
    isPublicWebApi -
  - isPrivilaged
```
public boolean isPrivilaged()
```
    戻り値:
  - setPrivilaged
```
public void setPrivilaged(boolean isPrivilaged)
```
    パラメータ:
    
    isPrivilaged -
  - isCheckXRequestedWithHeader
```
public boolean isCheckXRequestedWithHeader()
```
    XMLHttpRequestがセットされていることを確認するかを取得します。
    
    戻り値:
    
    XMLHttpRequestチェック可否
  - setCheckXRequestedWithHeader
```
public void setCheckXRequestedWithHeader(boolean isCheckXRequestedWithHeader)
```
    XMLHttpRequestチェック可否を設定します。
    
    パラメータ:
    
    isCheckXRequestedWithHeader -

クラス WebApiDefinition

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

メソッドのサマリー

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

コンストラクタの詳細

WebApiDefinition

メソッドの詳細

getMaxFileSize

setMaxFileSize

getMaxRequestBodySize

setMaxRequestBodySize

getAllowRequestContentTypes

setAllowRequestContentTypes

getOauthScopes

setOauthScopes

isSupportBearerToken

setSupportBearerToken

getState

setState

isNeedTrustedAuthenticate

setNeedTrustedAuthenticate

getAccessControlAllowOrigin

setAccessControlAllowOrigin

isAccessControlAllowCredentials

setAccessControlAllowCredentials

getResponseType

setResponseType

isSynchronizeOnSession

setSynchronizeOnSession

getTokenCheck

setTokenCheck

getRestJsonParameterType

setRestJsonParameterType

getRestJsonParameterName

setRestJsonParameterName

getRestXmlParameterName

setRestXmlParameterName

getAccepts

setAccepts

getMethods

setMethods

getName

setName

getDisplayName

setDisplayName

getDescription

setDescription

getCacheControlType

setCacheControlType

getCacheControlMaxAge

setCacheControlMaxAge

getCommandConfig

setCommandConfig

getWebApiParamMap

setWebApiParamMap

getResults

setResults

isPublicWebApi

setPublicWebApi

isPrivilaged

setPrivilaged

isCheckXRequestedWithHeader

setCheckXRequestedWithHeader