RequestObject (Katalon Studio API Specification)

com.kms.katalon.core.testobject.RequestObject

All Implemented Interfaces and Traits:: HttpMessage

public class RequestObject
extends TestObject
implements HttpMessage

Field Summary

Fields
Modifiers	Name	Description
`static long`	`DEFAULT_MAX_RESPONSE_SIZE`	The default maximum response size.
`static int`	`DEFAULT_TIMEOUT`	The default connection/socket timeout.
`static long`	`MAX_RESPONSE_SIZE_UNLIMITED`	Set response size limit to this value mean to this request has no response size limit.
`static long`	`MAX_RESPONSE_SIZE_UNSET`	Set max response size to this value mean to unset its current max response size.
`static int`	`TIMEOUT_UNLIMITED`	Set connection/socket timeout to this value mean to this request has no connection/socket timeout limit.
`static int`	`TIMEOUT_UNSET`	Set connection/socket timeout to this value mean to unset its current timeout.

Constructor Summary

Constructors
Constructor and description
`RequestObject (String objectId)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public HttpBodyContent`	`getBodyContent()` Gets the body content of request.
	`public int`	`getConnectionTimeout()` Get the connection timeout of this request in milliseconds.
	`public String`	`getHttpBody()` Get the http body for this request object
	`public List<TestObjectProperty>`	`getHttpHeaderProperties()` Get the http headers of this request object
	`public String`	`getHttpMethod()`
	`public long`	`getMaxResponseSize()` Get the maximum response size of this request in bytes.
	`public String`	`getName()` Get the name of this request object
	`public String`	`getObjectId()` Get the id of this request object
	`public ProxyInformation`	`getProxy()` Get the proxy of this request.
	`public int`	`getRedirectTimes()`
	`public RequestAuthorization`	`getRequestAuthorization()` Get the authorization for this request
	`public List<TestObjectProperty>`	`getRestParameters()` Get the rest parameters of this request object if it is a "RESTful" request object
	`public String`	`getRestRequestMethod()` Get the rest request method of this request object if it is a "RESTful" request object
	`public String`	`getRestUrl()` Get the rest url of this request object if it is a "RESTful" request object
	`public String`	`getServiceType()` Return the request type for this request object
	`public String`	`getSoapBody()` Get the soap body of this request object if it is a "SOAP" request object
	`public String`	`getSoapRequestMethod()` Get the soap request method of this request object if it is a "SOAP" request object
	`public String`	`getSoapServiceEndpoint()` Get SOAP service endpoint
	`public String`	`getSoapServiceFunction()` Get the soap service function of this request object if it is a "SOAP" request object
	`public int`	`getSocketTimeout()` Get the socket timeout of this request in milliseconds.
	`public String`	`getUrl()`
	`public List<ValidationStep>`	`getValidationSteps()`
	`public Map<String, Object>`	`getVariables()`
	`public String`	`getVerificationScript()`
	`public String`	`getWsdlAddress()` Get the wsdl address of this request object if it is a "SOAP" request object
	`public boolean`	`isFollowRedirects()`
	`public void`	`setBodyContent(HttpBodyContent bodyContent)` Sets the body content for this request.
	`public void`	`setConnectionTimeout(int connectionTimeout)` Set the connection timeout for this request.
	`public void`	`setFollowRedirects(boolean followRedirects)`
	`public void`	`setHttpBody(String httpBody)` Set the http body for this request object
	`public void`	`setHttpHeaderProperties(List<TestObjectProperty> httpHeaderProperties)` Set the http headers of this request object
	`public void`	`setMaxResponseSize(long maxResponseSize)` Set the maximum response size for this request.
	`public void`	`setName(String name)` Set the name for this request object
	`public void`	`setObjectId(String objectId)` Set the id for this request object
	`public void`	`setProxy(ProxyInformation proxy)` Set the proxy for this request.
	`public void`	`setRedirectTimes(int redirectTimes)`
	`public void`	`setRequestAuthorization(RequestAuthorization requestAuthorization)` Set the Authorization for the request object
	`public void`	`setRestParameters(List<TestObjectProperty> restParameters)` Set the rest parameters for this request object
	`public void`	`setRestRequestMethod(String restRequestMethod)` Set the rest request method for this request object
	`public void`	`setRestUrl(String restUrl)` Set the rest url for this request object
	`public void`	`setServiceType(String serviceType)` Set the service type for this request object
	`public void`	`setSoapBody(String soapBody)` Set the soap body for this request object
	`public void`	`setSoapRequestMethod(String soapRequestMethod)` Set the soap request method for this request object
	`public void`	`setSoapServiceEndpoint(String soapServiceEndpoint)` Set SOAP service endpoint
	`public void`	`setSoapServiceFunction(String soapServiceFunction)` Set the soap service function for this request object
	`public void`	`setSocketTimeout(int socketTimeout)` Set the socket timeout for this request.
	`public void`	`setUseServiceInfoFromWsdl(boolean useServiceInfoFromWsdl)` Set a flag that determines whether to use the service info (service endpoint, SOAP action,...) parsed from WSDL when sending a SOAP request.
	`public void`	`setValidationSteps(List<ValidationStep> validationSteps)`
	`public void`	`setVariables(Map<String, Object> variables)`
	`public void`	`setVerificationScript(String verificationScript)`
	`public void`	`setWsdlAddress(String wsdlAddress)` Set the wsdl address of this request object
	`public boolean`	`useServiceInfoFromWsdl()` Get a flag that determines whether to use the service info (service endpoint, SOAP action,...) parsed from WSDL when sending a SOAP request.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class TestObject`	addProperty, addProperty, addProperty, addXpath, addXpath, addXpath, findProperty, findPropertyValue, findPropertyValue, findXpath, findXpathValue, findXpathValue, getActiveProperties, getActiveXpaths, getCachedWebElement, getImagePath, getObjectId, getParentObject, getProperties, getSelectorCollection, getSelectorMethod, getSmartSelectorCollection, getUseRelativeImagePath, getXpaths, isParentObjectShadowRoot, setCachedWebElement, setImagePath, setParentObject, setParentObjectShadowRoot, setProperties, setSelectorMethod, setSelectorValue, setSmartSelectorCollection, setUseRelativeImagePath, setXpaths, toString

- Field Detail
  - public static final long DEFAULT_MAX_RESPONSE_SIZE
    
    The default maximum response size. Default value is same to unlimited.
  - public static final int DEFAULT_TIMEOUT
    
    The default connection/socket timeout. The default value is set to unlimited.
  - public static final long MAX_RESPONSE_SIZE_UNLIMITED
    
    Set response size limit to this value mean to this request has no response size limit.
  - public static final long MAX_RESPONSE_SIZE_UNSET
    
    Set max response size to this value mean to unset its current max response size. The project's max response size will be used.
  - public static final int TIMEOUT_UNLIMITED
    
    Set connection/socket timeout to this value mean to this request has no connection/socket timeout limit.
  - public static final int TIMEOUT_UNSET
    
    Set connection/socket timeout to this value mean to unset its current timeout. The project's socket timeout will be used.
- Constructor Detail
  - public RequestObject(String objectId)
- Method Detail
  - @Override public HttpBodyContent getBodyContent()
    
    Gets the body content of request.
    See Also:
    HttpTextBodyContent
    Since:
    5.4
  - public int getConnectionTimeout()
    
    Get the connection timeout of this request in milliseconds.
    Since:
    7.6.0
  - public String getHttpBody()
    
    Get the http body for this request object
    deprecated:
    Deprecated from 5.4. Please use setBodyContent(HttpBodyContent) instead.
    
    Returns:
    the http body for this request object as a String
  - public List<TestObjectProperty> getHttpHeaderProperties()
    
    Get the http headers of this request object
    Returns:
    the list contains the http headers of this request object
  - public String getHttpMethod()
  - public long getMaxResponseSize()
    
    Get the maximum response size of this request in bytes.
    Since:
    7.6.0
  - public String getName()
    
    Get the name of this request object
    Returns:
    the name of this request object
  - public String getObjectId()
    
    Get the id of this request object
    Returns:
    the id of this request object
  - public ProxyInformation getProxy()
    
    Get the proxy of this request. This proxy will take precedence over proxy settings in Preferences.
  - public int getRedirectTimes()
  - public RequestAuthorization getRequestAuthorization()
    
    Get the authorization for this request
    Returns:
    the authorization of this request
    Since:
    8.4.0
  - public List<TestObjectProperty> getRestParameters()
    
    Get the rest parameters of this request object if it is a "RESTful" request object
    Returns:
    the rest parameters of this request object if it is a "RESTful" request object, or empty list if it is not
  - public String getRestRequestMethod()
    
    Get the rest request method of this request object if it is a "RESTful" request object
    Returns:
    the rest request method of this request object if it is a "RESTful" request object, or null if it is not
  - public String getRestUrl()
    
    Get the rest url of this request object if it is a "RESTful" request object
    Returns:
    the rest url of this request object if it is a "RESTful" request object, or null if it is not
  - public String getServiceType()
    
    Return the request type for this request object
    Possible values: SOAP, RESTful
    Returns:
    the request type for this request object
  - public String getSoapBody()
    
    Get the soap body of this request object if it is a "SOAP" request object
    Returns:
    the soap body of this request object if it is a "SOAP" request object, or null if it is not
  - public String getSoapRequestMethod()
    
    Get the soap request method of this request object if it is a "SOAP" request object
    Possible values: SOAP, SOAP12, GET, POST
    Returns:
    the soap request method of this request object if it is a "SOAP" request object, or null if it is not
  - public String getSoapServiceEndpoint()
    
    Get SOAP service endpoint
    Since:
    7.4.5
  - public String getSoapServiceFunction()
    
    Get the soap service function of this request object if it is a "SOAP" request object
    Returns:
    the soap service function of this request object if it is a "SOAP" request object, or null if it is not
  - public int getSocketTimeout()
    
    Get the socket timeout of this request in milliseconds.
    Since:
    7.6.0
  - public String getUrl()
  - public List<ValidationStep> getValidationSteps()
  - public Map<String, Object> getVariables()
  - public String getVerificationScript()
  - public String getWsdlAddress()
    
    Get the wsdl address of this request object if it is a "SOAP" request object
    Returns:
    the wsdl address of this request object if it is a "SOAP" request object, or null if it is not
  - public boolean isFollowRedirects()
  - public void setBodyContent(HttpBodyContent bodyContent)
    
    Sets the body content for this request.
    Parameters:
    bodyContent - an implementation of HttpBodyContent
    See Also:
    HttpTextBodyContent
    HttpFileBodyContent
    HttpFormDataBodyContent
    HttpUrlEncodedBodyContent
  - public void setConnectionTimeout(int connectionTimeout)
    
    Set the connection timeout for this request.
    Parameters:
    connectionTimeout - The connection timeout in milliseconds.
    A timeout value of zero or negative is interpreted as an infinite timeout.
    
    Additional available values:
    
    RequestObject.TIMEOUT_UNLIMITED: Set the connection timeout of this request to unlimited.
    
    RequestObject.DEFAULT_TIMEOUT: Set the connection timeout of this request to the default value (The default value is set to unlimited).
    
    RequestObject.TIMEOUT_UNSET: Unset the connection timeout of this request. The project's connection timeout will be used.
    Since:
    7.6.0
  - public void setFollowRedirects(boolean followRedirects)
  - public void setHttpBody(String httpBody)
    
    Set the http body for this request object
    deprecated:
    Deprecated from 5.4. Please use setBodyContent(HttpBodyContent) instead.
    
    Parameters:
    httpBody - the new http body for this request object as a String
  - public void setHttpHeaderProperties(List<TestObjectProperty> httpHeaderProperties)
    
    Set the http headers of this request object
    Parameters:
    httpHeaderProperties - the new list contains the http headers for this request object
  - public void setMaxResponseSize(long maxResponseSize)
    
    Set the maximum response size for this request.
    Parameters:
    maxResponseSize - The response size limit in bytes.
    A max response size value of zero or negative is interpreted as an unlimited response size.
    
    Additional available values:
    
    RequestObject.MAX_RESPONSE_SIZE_UNLIMITED: Set the maximum response size of this request to unlimited.
    
    RequestObject.DEFAULT_MAX_RESPONSE_SIZE: Set the maximum response size of this request to the default value (The default value is set to unlimited).
    
    RequestObject.MAX_RESPONSE_SIZE_UNSET: Unset the maximum response size of this request. The project's maximum response size will be used.
    Since:
    7.6.0
  - public void setName(String name)
    
    Set the name for this request object
    Parameters:
    name - the new name of this request object
  - public void setObjectId(String objectId)
    
    Set the id for this request object
    Parameters:
    objectId - the new id of this request object
  - public void setProxy(ProxyInformation proxy)
    
    Set the proxy for this request. This proxy will take precedence over proxy settings in Preferences.
  - public void setRedirectTimes(int redirectTimes)
  - public void setRequestAuthorization(RequestAuthorization requestAuthorization)
    
    Set the Authorization for the request object
    Parameters:
    requestAuthorization - the requestAuthorization is used for authentication when sending a request object
    Since:
    8.4.0
    See Also:
    NTLMAuthorization
  - public void setRestParameters(List<TestObjectProperty> restParameters)
    
    Set the rest parameters for this request object
    Parameters:
    restParameters - the new rest parameters of this request object
  - public void setRestRequestMethod(String restRequestMethod)
    
    Set the rest request method for this request object
    Parameters:
    restRequestMethod - the new request method for this request object
  - public void setRestUrl(String restUrl)
    
    Set the rest url for this request object
    Parameters:
    restUrl - the new rest url for this request object
  - public void setServiceType(String serviceType)
    
    Set the service type for this request object
    Parameters:
    serviceType - the new request type for this request object
  - public void setSoapBody(String soapBody)
    
    Set the soap body for this request object
    Parameters:
    soapBody - the new soap body for this request object
  - public void setSoapRequestMethod(String soapRequestMethod)
    
    Set the soap request method for this request object
    Parameters:
    soapRequestMethod - the new soap request method for this request object
  - public void setSoapServiceEndpoint(String soapServiceEndpoint)
    
    Set SOAP service endpoint
    Since:
    7.4.5
  - public void setSoapServiceFunction(String soapServiceFunction)
    
    Set the soap service function for this request object
    Parameters:
    soapServiceFunction - the new soap service function for this request object
  - public void setSocketTimeout(int socketTimeout)
    
    Set the socket timeout for this request.
    Parameters:
    socketTimeout - The socket timeout in milliseconds.
    A timeout value of zero or negative is interpreted as an infinite timeout.
    
    Additional available values:
    
    RequestObject.TIMEOUT_UNLIMITED: Set the socket timeout of this request to unlimited.
    
    RequestObject.DEFAULT_TIMEOUT: Set the socket timeout of this request to the default value (The default value is set to unlimited).
    
    RequestObject.TIMEOUT_UNSET: Unset the socket timeout of this request. The project's socket timeout will be used.
    Since:
    7.6.0
  - public void setUseServiceInfoFromWsdl(boolean useServiceInfoFromWsdl)
    
    Set a flag that determines whether to use the service info (service endpoint, SOAP action,...) parsed from WSDL when sending a SOAP request.
    Parameters:
    useServiceInfoFromWsdl
    Since:
    7.4.5
  - public void setValidationSteps(List<ValidationStep> validationSteps)
  - public void setVariables(Map<String, Object> variables)
  - public void setVerificationScript(String verificationScript)
  - public void setWsdlAddress(String wsdlAddress)
    
    Set the wsdl address of this request object
    Parameters:
    wsdlAddress - the new wsdl address of this request object
  - public boolean useServiceInfoFromWsdl()
    
    Get a flag that determines whether to use the service info (service endpoint, SOAP action,...) parsed from WSDL when sending a SOAP request.
    Since:
    7.4.5

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class RequestObject

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final long DEFAULT_MAX_RESPONSE_SIZE

public static final int DEFAULT_TIMEOUT

public static final long MAX_RESPONSE_SIZE_UNLIMITED

public static final long MAX_RESPONSE_SIZE_UNSET

public static final int TIMEOUT_UNLIMITED

public static final int TIMEOUT_UNSET

Constructor Detail

public RequestObject(String objectId)

Method Detail

@Override public HttpBodyContent getBodyContent()

public int getConnectionTimeout()

public String getHttpBody()

public List<TestObjectProperty> getHttpHeaderProperties()

public String getHttpMethod()

public long getMaxResponseSize()

public String getName()

public String getObjectId()

public ProxyInformation getProxy()

public int getRedirectTimes()

public RequestAuthorization getRequestAuthorization()

public List<TestObjectProperty> getRestParameters()

public String getRestRequestMethod()

public String getRestUrl()

public String getServiceType()

public String getSoapBody()

public String getSoapRequestMethod()

public String getSoapServiceEndpoint()

public String getSoapServiceFunction()

public int getSocketTimeout()

public String getUrl()

public List<ValidationStep> getValidationSteps()

public Map<String, Object> getVariables()

public String getVerificationScript()

public String getWsdlAddress()

public boolean isFollowRedirects()

public void setBodyContent(HttpBodyContent bodyContent)

public void setConnectionTimeout(int connectionTimeout)

public void setFollowRedirects(boolean followRedirects)

public void setHttpBody(String httpBody)

public void setHttpHeaderProperties(List<TestObjectProperty> httpHeaderProperties)

public void setMaxResponseSize(long maxResponseSize)

public void setName(String name)

public void setObjectId(String objectId)

public void setProxy(ProxyInformation proxy)

public void setRedirectTimes(int redirectTimes)

public void setRequestAuthorization(RequestAuthorization requestAuthorization)

public void setRestParameters(List<TestObjectProperty> restParameters)

public void setRestRequestMethod(String restRequestMethod)

public void setRestUrl(String restUrl)

public void setServiceType(String serviceType)

public void setSoapBody(String soapBody)

public void setSoapRequestMethod(String soapRequestMethod)

public void setSoapServiceEndpoint(String soapServiceEndpoint)

public void setSoapServiceFunction(String soapServiceFunction)

public void setSocketTimeout(int socketTimeout)

public void setUseServiceInfoFromWsdl(boolean useServiceInfoFromWsdl)

public void setValidationSteps(List<ValidationStep> validationSteps)

public void setVariables(Map<String, Object> variables)

public void setVerificationScript(String verificationScript)

public void setWsdlAddress(String wsdlAddress)

public boolean useServiceInfoFromWsdl()