com.viaoa.remote.rest.info

Class OARestMethodInfo

java.lang.Object

com.viaoa.remote.rest.info.OARestMethodInfo

public class OARestMethodInfo
extends Object

Manages information and metadata about Java remote methods that use REST API endpoints.

Author:

vvia

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OARestMethodInfo.ReturnClassType

Field Summary

Fields

Modifier and Type	Field and Description
ArrayList<String>	alErrors
List<String>	alIncludePropertyPaths
ArrayList<OARestParamInfo>	alParamInfo
OARestClassInfo	classInfo
String	derivedUrlPath
int	includeReferenceLevelAmount
Method	method
OARestMethod.MethodType	methodType
String	name
String	objectMethodName
Class	origReturnClass
OARestMethod	restMethod
Class	returnClass
OARestMethodInfo.ReturnClassType	returnClassType
Class	rmReturnClass
String	searchOrderBy
String	searchWhere
String	urlPath
OATemplate	urlPathTemplate
String	urlQuery

Constructor Summary

Constructors

Constructor and Description
OARestMethodInfo(Method method)

Method Summary

Modifier and Type	Method and Description
protected void	_verifyMethodTypeX(String msgPrefix, List<String> alErrors)
byte[]	getByteArrayBody(Object[] args)
String	getFormData(Object[] args)
OARestInvokeInfo	getInvokeInfo(Object[] args, String idSeparater) Called when a method is invoked, so that all of the HTTP params can be setup.
String	getJsonBody(Object[] args)
Class	getMethodReturnClass(Object[] args)
String	getSearchWhere(Object[] args)
String	getUrlPath(Object[] args, String idSeparater)
OATemplate	getUrlPathTemplate()
String	getUrlQuery(Object[] args)
void	initialize()
void	setDefaults()
List<String>	verify()
protected void	verifyDerviedUrlPath(String msgPrefix, List<String> alErrors)
protected void	verifyIncludePropertyPaths(String msgPrefix, List<String> alErrors)
protected void	verifyIncludeReferenceLevelAmount(String msgPrefix, List<String> alErrors)
protected void	verifyMethodPageSize(String msgPrefix, List<String> alErrors)
protected void	verifyMethodReturnClass(String msgPrefix, List<String> alErrors)
protected void	verifyMethodType(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypeGET(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypeOADelete(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypeOAGet(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypeOAInsert(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypeOAObjectMethodCall(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypeOARemote(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypeOASearch(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypeOAUpdate(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypePATCH(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypePOST(String msgPrefix, List<String> alErrors)
protected void	verifyMethodTypePUT(String msgPrefix, List<String> alErrors)
void	verifyParamAmounts(String msgPrefix, List<String> alErrors)
boolean	verifyParamType(String msgPrefix, List<String> alErrors, OARestParamInfo pi, OARestParam.ParamType ptCheck, boolean bUsesName, boolean bUsesParamClass, boolean bUsesFormat, boolean bUsesIncludePPs)
boolean	verifyParamType(String msgPrefix, List<String> alErrors, OARestParamInfo pi, OARestParam.ParamType ptCheck, boolean bUsesName, boolean bUsesParamClass, boolean bUsesFormat, boolean bUsesIncludePPs, boolean bTypeString)
void	verifyRestParams(String msgPrefix, List<String> alErrors)
protected void	verifyUrlPath(String msgPrefix, List<String> alErrors)
protected void	verifyUrlQuery(String msgPrefix, List<String> alErrors)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

restMethod

public OARestMethod restMethod

classInfo

public OARestClassInfo classInfo

method

public Method method

name

public String name

urlPath

public String urlPath

derivedUrlPath

public String derivedUrlPath

urlPathTemplate

public OATemplate urlPathTemplate

urlQuery

public String urlQuery

alParamInfo

public ArrayList<OARestParamInfo> alParamInfo

objectMethodName

public String objectMethodName

origReturnClass

public Class origReturnClass

rmReturnClass

public Class rmReturnClass

returnClass

public Class returnClass

methodType

public OARestMethod.MethodType methodType

returnClassType

public OARestMethodInfo.ReturnClassType returnClassType

alErrors

public ArrayList<String> alErrors

includeReferenceLevelAmount

public int includeReferenceLevelAmount

alIncludePropertyPaths

public List<String> alIncludePropertyPaths

searchWhere

public String searchWhere

searchOrderBy

public String searchOrderBy

Constructor Detail

OARestMethodInfo

public OARestMethodInfo(Method method)

Method Detail

verify

public List<String> verify()

initialize

public void initialize()

setDefaults

public void setDefaults()

verifyRestParams

public void verifyRestParams(String msgPrefix,
                             List<String> alErrors)

verifyParamType

public boolean verifyParamType(String msgPrefix,
                               List<String> alErrors,
                               OARestParamInfo pi,
                               OARestParam.ParamType ptCheck,
                               boolean bUsesName,
                               boolean bUsesParamClass,
                               boolean bUsesFormat,
                               boolean bUsesIncludePPs)

verifyParamType

public boolean verifyParamType(String msgPrefix,
                               List<String> alErrors,
                               OARestParamInfo pi,
                               OARestParam.ParamType ptCheck,
                               boolean bUsesName,
                               boolean bUsesParamClass,
                               boolean bUsesFormat,
                               boolean bUsesIncludePPs,
                               boolean bTypeString)

verifyParamAmounts

public void verifyParamAmounts(String msgPrefix,
                               List<String> alErrors)

verifyMethodType

protected void verifyMethodType(String msgPrefix,
                                List<String> alErrors)

verifyMethodPageSize

protected void verifyMethodPageSize(String msgPrefix,
                                    List<String> alErrors)

verifyMethodTypeGET

protected void verifyMethodTypeGET(String msgPrefix,
                                   List<String> alErrors)

verifyMethodTypePOST

protected void verifyMethodTypePOST(String msgPrefix,
                                    List<String> alErrors)

verifyMethodTypePUT

protected void verifyMethodTypePUT(String msgPrefix,
                                   List<String> alErrors)

verifyMethodTypePATCH

protected void verifyMethodTypePATCH(String msgPrefix,
                                     List<String> alErrors)

_verifyMethodTypeX

protected void _verifyMethodTypeX(String msgPrefix,
                                  List<String> alErrors)

verifyMethodTypeOAGet

protected void verifyMethodTypeOAGet(String msgPrefix,
                                     List<String> alErrors)

verifyMethodTypeOASearch

protected void verifyMethodTypeOASearch(String msgPrefix,
                                        List<String> alErrors)

verifyMethodTypeOAObjectMethodCall

protected void verifyMethodTypeOAObjectMethodCall(String msgPrefix,
                                                  List<String> alErrors)

verifyMethodTypeOARemote

protected void verifyMethodTypeOARemote(String msgPrefix,
                                        List<String> alErrors)

verifyMethodTypeOAInsert

protected void verifyMethodTypeOAInsert(String msgPrefix,
                                        List<String> alErrors)

verifyMethodTypeOAUpdate

protected void verifyMethodTypeOAUpdate(String msgPrefix,
                                        List<String> alErrors)

verifyMethodTypeOADelete

protected void verifyMethodTypeOADelete(String msgPrefix,
                                        List<String> alErrors)

verifyUrlQuery

protected void verifyUrlQuery(String msgPrefix,
                              List<String> alErrors)

verifyIncludePropertyPaths

protected void verifyIncludePropertyPaths(String msgPrefix,
                                          List<String> alErrors)

verifyIncludeReferenceLevelAmount

protected void verifyIncludeReferenceLevelAmount(String msgPrefix,
                                                 List<String> alErrors)

verifyMethodReturnClass

protected void verifyMethodReturnClass(String msgPrefix,
                                       List<String> alErrors)

verifyUrlPath

protected void verifyUrlPath(String msgPrefix,
                             List<String> alErrors)

verifyDerviedUrlPath

protected void verifyDerviedUrlPath(String msgPrefix,
                                    List<String> alErrors)

getInvokeInfo

public OARestInvokeInfo getInvokeInfo(Object[] args,
                                      String idSeparater)
                               throws Exception

Called when a method is invoked, so that all of the HTTP params can be setup.

Note: if a method param/argument is type OARestInvokeInfo, then it will be used instead of creating a new one. If so, then it will be updated to match the current method call and argument values.

Parameters:

args - from method invocation

Returns:

new RestInvokeInfo with all of the HTTP information needed to make the call to the endpoint.

Throws:

Exception

getUrlPathTemplate

public OATemplate getUrlPathTemplate()

getUrlPath

public String getUrlPath(Object[] args,
                         String idSeparater)

getUrlQuery

public String getUrlQuery(Object[] args)
                   throws Exception

Throws:

Exception

getSearchWhere

public String getSearchWhere(Object[] args)
                      throws Exception

Throws:

Exception

getJsonBody

public String getJsonBody(Object[] args)
                   throws Exception

Throws:

Exception

getMethodReturnClass

public Class getMethodReturnClass(Object[] args)

getFormData

public String getFormData(Object[] args)
                   throws Exception

Throws:

Exception

getByteArrayBody

public byte[] getByteArrayBody(Object[] args)
                        throws Exception

Throws:

Exception