Class WebServiceParam
- java.lang.Object
-
- io.vertigo.vega.webservice.definitions.WebServiceParam
-
public final class WebServiceParam extends Object
WebService param infos : - source type (query, path, body, innerBody or implicit) - name - type (class) - includedField (for DtObjet or DtList) - excludedField (for DtObjet or DtList) - if object kept serverSide - if one time token - specific validators- Author:
- npiedeloup
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WebServiceParam.ImplicitParam
static class
WebServiceParam.WebServiceParamType
Parameter's source types.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WebServiceParamBuilder
builder(Type paramType)
Static method factory for WebServiceDefinitionBuilderList<Class<? extends DtObjectValidator>>
getDtObjectValidatorClasses()
Set<String>
getExcludedFields()
String
getFullName()
Type
getGenericType()
Set<String>
getIncludedFields()
String
getName()
WebServiceParam.WebServiceParamType
getParamType()
Class<?>
getType()
boolean
isConsumeServerSideToken()
boolean
isNeedServerSideToken()
boolean
isOptional()
String
toString()
-
-
-
Method Detail
-
builder
public static WebServiceParamBuilder builder(Type paramType)
Static method factory for WebServiceDefinitionBuilder- Parameters:
paramType
- param type- Returns:
- WebServiceDefinitionBuilder
-
getParamType
public WebServiceParam.WebServiceParamType getParamType()
- Returns:
- Parameter's source type
-
getFullName
public String getFullName()
- Returns:
- Full name of this param.
-
getName
public String getName()
- Returns:
- Parameter name in source
-
getType
public Class<?> getType()
- Returns:
- Parameter class
-
getGenericType
public Type getGenericType()
- Returns:
- generics Type
-
isOptional
public boolean isOptional()
- Returns:
- is optional
-
isNeedServerSideToken
public boolean isNeedServerSideToken()
- Returns:
- if access token mandatory
-
isConsumeServerSideToken
public boolean isConsumeServerSideToken()
- Returns:
- if access token is consume (one time token)
-
getDtObjectValidatorClasses
public List<Class<? extends DtObjectValidator>> getDtObjectValidatorClasses()
- Returns:
- List of validator classes (order is keep)
-
-