Package com.avoka.tm.vo
Class RestCFG
java.lang.Object
com.avoka.tm.vo.RestCFG
Provide a Rest CFG value object class to map Json Object to HttpRequest.
- Since:
- 22.4.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Provides an Authorisation.static class
Provides a multi-part FileParam.static enum
The HTTP Methods.static class
Provides a proxy. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturn the config authorisation.int
return the connection timeout in milliseconds.getFiles()
Return the list of multi-part FileParam.Return the config request headers.Get the POST or PUT message body.byte[]
Get the POST or PUT message body.return the HTTP Method.return the request form parameters.getProxy()
Return the proxy details.Return the request URL.int
Get the socket timeout in milliseconds.void
setAuthorisation
(RestCFG.Authorisation authorisation) Set the config authorisation.void
setConnectionTimeout
(int connectionTimeout) Set the connection timeouts in milliseconds.void
setFiles
(List<RestCFG.FileParam> files) Set the List of multi-part FileParam.void
setHeaders
(Map<String, String> headers) Set the config request headers.void
setMessage
(String message) Set the POST or PUT message body.void
setMessageData
(byte[] messageData) Set the POST or PUT message body.void
setMethodType
(RestCFG.MethodType methodType) Set the HTTP Method.void
setParameters
(Map<String, String> parameters) Set the request form parameters.void
setProxy
(RestCFG.Proxy proxy) Set the proxy details.void
setRestURL
(String restURL) Set the request URL.void
setSocketTimeout
(int socketTimeout) Set the socket timeout in milliseconds.The default socket read timeout is 60 seconds.
-
Constructor Details
-
RestCFG
public RestCFG()
-
-
Method Details
-
getAuthorisation
Return the config authorisation.- Returns:
- the config authorisation
-
setAuthorisation
Set the config authorisation.- Parameters:
authorisation
- the config authorisation- See Also:
-
getConnectionTimeout
public int getConnectionTimeout()return the connection timeout in milliseconds.- Returns:
- the connection timeout
-
setConnectionTimeout
public void setConnectionTimeout(int connectionTimeout) Set the connection timeouts in milliseconds.- Parameters:
connectionTimeout
- the connection timeouts
-
getFiles
Return the list of multi-part FileParam.- Returns:
- the list of multi-part FileParam
-
setFiles
Set the List of multi-part FileParam.- Parameters:
files
- the List of multi-part FileParam
-
getHeaders
Return the config request headers.- Returns:
- the map of request headers
-
setHeaders
Set the config request headers.- Parameters:
headers
- the map of request headers
-
getMessage
Get the POST or PUT message body.- Returns:
- the POST or PUT message body
-
setMessage
Set the POST or PUT message body. If specified the Content-Type will be set to 'plain/text'.- Parameters:
message
- the POST or PUT message body
-
getMessageData
public byte[] getMessageData()Get the POST or PUT message body.- Returns:
- the POST or PUT message body
-
setMessageData
public void setMessageData(byte[] messageData) Set the POST or PUT message body. If specified the Content-Type will be set to 'application/octet-stream'.- Parameters:
messageData
- the POST or PUT message body
-
getMethodType
return the HTTP Method.- Returns:
- the HTTP Method
-
setMethodType
Set the HTTP Method.- Parameters:
methodType
- the HTTP Method
-
getParameters
return the request form parameters.- Returns:
- the request form parameters
-
setParameters
Set the request form parameters.- Parameters:
parameters
- the request form parameters
-
getProxy
Return the proxy details.- Returns:
- the proxy details
- See Also:
-
setProxy
Set the proxy details.- Parameters:
proxy
- the proxy details
-
getRestURL
Return the request URL.- Returns:
- the request URL
-
setRestURL
Set the request URL.- Parameters:
restURL
- the request URL
-
getSocketTimeout
public int getSocketTimeout()Get the socket timeout in milliseconds.- Returns:
- the socket timeout in milliseconds
-
setSocketTimeout
public void setSocketTimeout(int socketTimeout) Set the socket timeout in milliseconds.The default socket read timeout is 60 seconds.- Parameters:
socketTimeout
- the socket timeout in milliseconds
-