クラス WebApiDefinition
- java.lang.Object
-
- org.iplass.mtp.webapi.definition.WebApiDefinition
-
- すべての実装されたインタフェース:
java.io.Serializable,Definition
public class WebApiDefinition extends java.lang.Object implements Definition
- 関連項目:
- 直列化された形式
-
-
コンストラクタの概要
コンストラクタ コンストラクタ 説明 WebApiDefinition()
-
メソッドの概要
修飾子とタイプ メソッド 説明 RequestType[]getAccepts()java.lang.StringgetAccessControlAllowOrigin()java.lang.String[]getAllowRequestContentTypes()longgetCacheControlMaxAge()CacheControlTypegetCacheControlType()CommandConfiggetCommandConfig()java.lang.StringgetDescription()概要を取得します。java.lang.StringgetDisplayName()表示名を取得します。java.lang.LonggetMaxFileSize()java.lang.LonggetMaxRequestBodySize()MethodType[]getMethods()java.lang.StringgetName()名前を取得します。java.lang.String[]getOauthScopes()java.lang.StringgetResponseType()java.lang.StringgetRestJsonParameterName()java.lang.StringgetRestJsonParameterType()java.lang.StringgetRestXmlParameterName()java.lang.String[]getResults()StateTypegetState()WebApiTokenCheckgetTokenCheck()WebApiParamMapDefinition[]getWebApiParamMap()booleanisAccessControlAllowCredentials()booleanisCheckXRequestedWithHeader()XMLHttpRequestがセットされていることを確認するかを取得します。booleanisNeedTrustedAuthenticate()booleanisPrivilaged()booleanisPublicWebApi()booleanisSupportBearerToken()booleanisSynchronizeOnSession()voidsetAccepts(RequestType[] accepts)voidsetAccessControlAllowCredentials(boolean accessControlAllowCredentials)voidsetAccessControlAllowOrigin(java.lang.String accessControlAllowOrigin)voidsetAllowRequestContentTypes(java.lang.String[] allowRequestContentTypes)許可するリクエストボディのContentTypeを指定。voidsetCacheControlMaxAge(long cacheControlMaxAge)cacheControlMaxAge=CacheControlType.CACHEを指定した場合の WebAPIキャッシュのmax-age(秒)を指定。voidsetCacheControlType(CacheControlType cacheControlType)WebAPIキャッシュ指定(Cache-Controlヘッダの制御)。voidsetCheckXRequestedWithHeader(boolean isCheckXRequestedWithHeader)XMLHttpRequestチェック可否を設定します。voidsetCommandConfig(CommandConfig commandConfig)voidsetDescription(java.lang.String description)概要を設定します。voidsetDisplayName(java.lang.String displayName)表示名を設定します。voidsetMaxFileSize(java.lang.Long maxFileSize)multipart/form-data時のアップロードファイルの最大サイズ。voidsetMaxRequestBodySize(java.lang.Long maxRequestBodySize)リクエストボディの最大サイズ。voidsetMethods(MethodType[] methods)voidsetName(java.lang.String name)名前を設定します。voidsetNeedTrustedAuthenticate(boolean needTrustedAuthenticate)voidsetOauthScopes(java.lang.String[] oauthScopes)voidsetPrivilaged(boolean isPrivilaged)voidsetPublicWebApi(boolean isPublicWebApi)このWebApiの呼び出しをセキュリティ設定によらず呼び出し可能にする場合は、trueを設定します。voidsetResponseType(java.lang.String responseType)voidsetRestJsonParameterName(java.lang.String restJsonParameterName)voidsetRestJsonParameterType(java.lang.String restJsonParameterType)voidsetRestXmlParameterName(java.lang.String restXmlParameterName)voidsetResults(java.lang.String[] results)voidsetState(StateType state)WebApiをStatelessとして呼び出すか否かを設定します。voidsetSupportBearerToken(boolean supportBearerToken)voidsetSynchronizeOnSession(boolean synchronizeOnSession)voidsetTokenCheck(WebApiTokenCheck tokenCheck)voidsetWebApiParamMap(WebApiParamMapDefinition[] webApiParamMap)
-
-
-
メソッドの詳細
-
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を指定。未指定の場合はすべて許可。
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()
インタフェースからコピーされた説明: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
-
getDescription
public java.lang.String getDescription()
インタフェースからコピーされた説明:Definition概要を取得します。- 定義:
getDescriptionインタフェース内Definition- 戻り値:
- description
-
setDescription
public void setDescription(java.lang.String description)
インタフェースからコピーされた説明:Definition概要を設定します。- 定義:
setDescriptionインタフェース内Definition- パラメータ:
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-
-
-