SoapConfig
Path
com.roma.apic.livedata.config.v1.SoapConfig
Description
This class is used together with SoapClient to configure SOAP requests.
Constructor Details
public SoapConfig()
Constructs a SoapConfig without parameters.
Method List
Returned Type |
Method and Description |
---|---|
String |
Construct a SOAP request packet. |
String |
Obtain the node prefix of a request packet. |
String |
Obtain the HTTP request encoding format. |
int |
Obtain the connection timeout interval. |
Object |
Obtain the request content. |
String |
Obtain the packet parameter type. |
String |
Obtain the envelope prefix. |
String |
getHeader(String name) Obtain the request header value based on the request header name. |
Map<String,String> |
Obtain request header information. |
String |
Obtain the request method. |
String |
Obtain the namespace. |
String |
Obtain the namespace prefix. |
String |
Obtain the operation name. |
String |
getParameter(String name) Obtain SOAP request parameters based on the specified name. |
Map<String,String> |
Obtains the SOAP request parameters. |
String |
Obtain the request protocol. |
int |
Obtain the read timeout. |
String |
Obtain the operation request address. |
String |
getUrl() Obtain the request address. |
boolean |
Allow redirection or not. |
void |
setBodyPrefix(String bodyPrefix) Set the node prefix of a request packet. |
void |
setCharset(String charset) Set the HTTP request encoding format. |
void |
setConnectTimeout(int connectTimeout) Set the connection timeout interval. |
void |
setContent(Object content) Set the request content. |
void |
setContentType(String contentType) Set the packet parameter type. |
void |
setEnvelopePrefix(String envelopePrefix) Set the envelope prefix. |
void |
setHeader(String name, String value) Set request header information. |
void |
setHeaders(Map<String,String> headers) Set request header information. |
void |
setMethod(String method) Set the request method. |
void |
setNamespace(String namespace) Set the namespace. |
void |
setNamespacePrefix(String namespacePrefix) Set the namespace prefix. |
void |
setOperation(String operation) Set the operation name. |
void |
setParameter(String name, String value) Set a SOAP request parameter. |
void |
setParameters(Map<String,String> parameters) Set the SOAP request parameters. |
void |
setProtocol(String protocol) Set the request protocol. |
void |
setReadTimeout(int readTimeout) Set the read timeout. |
void |
setRedirects(boolean redirects) Set whether to redirect. |
void |
setSoapAction(String soapAction) Set the operation request address. |
void |
setUrl(String url) Set the request address. |
Method Details
- public String buildSoapMessage()
Construct a SOAP request packet.
Returns
SOAP request packet.
- public String getBodyPrefix()
Obtain the node prefix of a request packet.
Returns
Node prefix of a request packet.
- public String getCharset()
Obtain the HTTP request encoding format.
Returns
HTTP request encoding format.
- public int getConnectTimeout()
Obtain the connection timeout interval.
Returns
Connection timeout.
- public Object getContent()
Obtain the request content.
Returns
Request content.
- public String getContentType()
Obtain the packet parameter type.
Returns
Packet parameter type.
- public String getEnvelopePrefix()
Obtain the envelope prefix.
Returns
Envelope prefix.
- public String getHeader(String name)
Obtain the request header value based on the request header name.
Input Parameter
name indicates the request header name.
Returns
Request header value corresponding to the request header name
- public Map<String,String> getHeaders()
Obtain request header information.
Returns
Request header information.
- public String getMethod()
Obtain the request method.
Returns
Request method.
- public String getNamespace()
Obtain the namespace.
Returns
Namespace.
- public String getNamespacePrefix()
Obtain the namespace prefix.
Returns
Namespace prefix.
- public String getOperation()
Obtain the operation name.
Returns
Operation name.
- public String getParameter(String name)
Obtain SOAP request parameters based on the specified name.
Input Parameter
name indicates the name of a SOAP request parameter.
Returns
SOAP request parameter.
- public Map<String,String> getParameters()
Obtain the SOAP request parameters.
Returns
SOAP request parameters.
- public String getProtocol()
Obtain the request protocol.
Returns
Request protocol.
- public int getReadTimeout()
Obtain the read timeout.
Returns
Read timeout.
- public String getSoapAction()
Obtain the operation request address.
Returns
Operation request address.
- public String getUrl()
Obtain the request address.
Returns
Request address.
- public boolean isRedirects()
Allow redirection or not.
Returns
true or false
- public void setBodyPrefix(String bodyPrefix)
Set the node prefix of a request packet.
Input Parameter
bodyPrefix indicates the node prefix of a request packet.
- public void setCharset(String charset)
Set the HTTP request encoding format.
Input Parameter
charset indicates the encoding format of the HTTP request.
- public void setConnectTimeout(int connectTimeout)
Set the connection timeout interval.
Input Parameter
Connection timeout indicates the connection timeout interval.
- public void setContent(Object content)
Set the request content.
Input Parameter
content indicates the request content.
- public void setContentType(String contentType)
Set the packet parameter type.
Input Parameter
contentType indicates the packet parameter type.
- public void setEnvelopePrefix(String envelopePrefix)
Set the envelope prefix.
Input Parameter
envelopePrefix indicates the envelope prefix.
- public void setHeader(String name, String value)
Set request header information.
Input Parameter
- name indicates the request header name.
- value indicates the request header value.
- public void setHeaders(Map<String,String> headers)
Set request header information.
Input Parameter
headers indicates the request header information.
- public void setMethod(String method)
Set the request method.
Input Parameter
method indicates a request method.
- public void setNamespace(String namespace)
Set the namespace.
Input Parameter
namespace indicates the namespace.
- public void setNamespacePrefix(String namespacePrefix)
Set the namespace prefix.
Input Parameter
namespacePrefix indicates the namespace prefix.
- public void setOperation(String operation)
Set the operation name.
Input Parameter
operation indicates the operation name.
- public void setParameter(String name, String value)
Set the SOAP request parameters.
Input Parameter
- name indicates the name of a SOAP request parameter.
- value indicates the value of a SOAP request parameter.
- public void setParameters(Map<String,String> parameters)
Set the SOAP request parameters.
Input Parameter
parameters indicates the SOAP request parameters.
- public void setProtocol(String protocol)
Set the request protocol.
Input Parameter
protocol indicates the request protocol.
- public void setReadTimeout(int readTimeout)
Set the read timeout.
Input Parameter
readTimeout indicates the read timeout interval.
- public void setRedirects(boolean redirects)
Set whether to redirect.
Input Parameter
redirects indicates whether to redirect.
- public void setSoapAction(String soapAction)
Set the operation request address.
Input Parameter
soapAction indicates the operation request address.
- public void setUrl(String url)
Set the request address.
Input Parameter
url indicates the request URL.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot