com.eviware.soapui.impl.rest

Class RestRequest

java.lang.Object

com.eviware.soapui.model.support.AbstractModelItem

com.eviware.soapui.impl.wsdl.AbstractWsdlModelItem<T>

com.eviware.soapui.impl.support.AbstractHttpRequest<RestRequestConfig>

com.eviware.soapui.impl.rest.RestRequest

All Implemented Interfaces:

RestRequestInterface, AbstractHttpRequestInterface<RestRequestConfig>, HttpRequestInterface<RestRequestConfig>, MediaType, AttachmentContainer, MutableAttachmentContainer, MutableTestPropertyHolder, JMSHeaderContainer, JMSPropertyContainer, Request, ModelItem, PropertyExpansionContainer, Releasable, AnimatableItem, TestPropertyHolder, PropertyChangeNotifier, PropertyChangeListener, EventListener

Direct Known Subclasses:

RestTestRequest

public class RestRequest
extends AbstractHttpRequest<RestRequestConfig>
implements RestRequestInterface

Request implementation holding a SOAP request

Author:

Ole.Matzura

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestRequest.ParameterMessagePart
class	RestRequest.RestContentPart

Nested classes/interfaces inherited from class com.eviware.soapui.impl.support.AbstractHttpRequest

AbstractHttpRequest.RequestIconAnimator<T extends AbstractHttpRequest<?>>

Nested classes/interfaces inherited from interface com.eviware.soapui.impl.rest.RestRequestInterface

RestRequestInterface.HttpMethod

Nested classes/interfaces inherited from interface com.eviware.soapui.model.iface.Request

Request.SubmitException

Field Summary

Fields inherited from class com.eviware.soapui.impl.support.AbstractHttpRequest

BASIC_AUTH_PROFILE, CR_ESCAPE_SEQUENCE, SELECTED_AUTH_PROFILE_PROPERTY_NAME

Fields inherited from interface com.eviware.soapui.impl.rest.RestRequestInterface

DEFAULT_MEDIATYPE, log, REST_XML_REQUEST

Fields inherited from interface com.eviware.soapui.impl.support.AbstractHttpRequestInterface

BIND_ADDRESS, DISABLE_MULTIPART_ATTACHMENTS, DUMP_FILE, FOLLOW_REDIRECTS, MAX_SIZE, REMOVE_EMPTY_CONTENT, REQUEST_HEADERS_PROPERTY, RESPONSE_PROPERTY, STRIP_WHITESPACES

Fields inherited from interface com.eviware.soapui.model.iface.Request

ENCODING_PROPERTY, ENDPOINT_PROPERTY, MEDIA_TYPE, REQUEST_PROPERTY

Fields inherited from interface com.eviware.soapui.model.ModelItem

DESCRIPTION_PROPERTY, ICON_PROPERTY, LABEL_PROPERTY, NAME_PROPERTY

Fields inherited from interface com.eviware.soapui.impl.wsdl.AttachmentContainer

ATTACHMENTS_PROPERTY

Constructor Summary

Constructors

Constructor and Description
RestRequest(RestMethod method, RestRequestConfig requestConfig, boolean forLoadTest)

Method Summary

Modifier and Type	Method and Description
void	addJMSHeaderExpansions(PropertyExpansionsResult result, JMSHeaderConfig jmsHeaderConfig, ModelItem modelItem)
TestProperty	addProperty(String name)
void	addTestPropertyListener(TestPropertyListener listener)
String	getAccept()
HttpAttachmentPart	getAttachmentPart(String partName) Override just to get a better return type
HttpAttachmentPart[]	getDefinedAttachmentParts()
JMSHeaderConfig	getJMSHeaderConfig()
JMSPropertiesConfig	getJMSPropertiesConfig()
String	getMediaType() This method should return a valid media type.
RestRequestInterface.HttpMethod	getMethod()
ModelItem	getModelItem() Returns ModelItem associated with this container
String	getMultiValueDelimiter()
RestResource	getOperation()
RestParamsPropertyHolder	getParams()
ModelItem	getParent()
String	getPath()
Map<String,TestProperty>	getProperties()
String	getPropertiesLabel()
RestParamProperty	getProperty(String name)
RestParamProperty	getPropertyAt(int index)
int	getPropertyCount()
PropertyExpansion[]	getPropertyExpansions()
List<TestProperty>	getPropertyList()
String[]	getPropertyNames()
String	getPropertyValue(String name)
RestRepresentation[]	getRepresentations()
RestRepresentation[]	getRepresentations(RestRepresentation.Type type)
RestRepresentation[]	getRepresentations(RestRepresentation.Type type, String mediaType)
MessagePart[]	getRequestParts()
RestResource	getResource()
String	getResponseContentAsXml()
String[]	getResponseMediaTypes()
MessagePart[]	getResponseParts()
RestMethod	getRestMethod()
boolean	hasEndpoint()
boolean	hasProperty(String name)
boolean	hasRequestBody()
protected AbstractHttpRequest.RequestIconAnimator<?>	initIconAnimator()
boolean	isPostQueryString()
void	moveProperty(String propertyName, int targetIndex)
void	propertyChange(PropertyChangeEvent evt)
void	release()
TestProperty	removeProperty(String propertyName)
void	removeTestPropertyListener(TestPropertyListener listener)
boolean	renameProperty(String name, String newName)
void	resetPropertyValues()
void	setAccept(String acceptEncoding)
void	setMediaType(String mediaType) This method should set the media type so it can later be accessed by getMediaType.
void	setMethod(RestRequestInterface.HttpMethod method)
void	setMultiValueDelimiter(String delimiter)
void	setPath(String fullPath)
void	setPostQueryString(boolean b)
void	setPropertyValue(String name, String value)
protected void	setRestMethod(RestMethod restMethod)
WsdlSubmit<RestRequest>	submit(SubmitContext submitContext, boolean async)
void	updateConfig(RestRequestConfig request)
protected void	updateParams()

Methods inherited from class com.eviware.soapui.impl.support.AbstractHttpRequest

addAttachmentsChangeListener, addBasicAuthenticationProfile, addExternalDependencies, addSubmitListener, attachBinaryData, attachFile, beforeSave, copyAttachmentsTo, getAfterRequestInjection, getAttachmentAt, getAttachmentCount, getAttachments, getAttachmentsForPart, getAttachmentsList, getAuthType, getBasicAuthenticationProfiles, getBasicAuthType, getBindAddress, getDomain, getDumpFile, getEncoding, getEndpoint, getIcon, getIconAnimator, getMaxSize, getPassword, getPreemptive, getRequestContent, getRequestHeaders, getResponse, getSelectedAuthProfile, getSslKeystore, getSubmitListeners, getTimeout, getUsername, importAttachment, isEntitizeProperties, isFollowRedirects, isMultipartEnabled, isPrettyPrint, isReadOnly, isRemoveEmptyContent, isStripWhitespaces, removeAttachment, removeAttachmentsChangeListener, removeBasicAuthenticationProfile, removeSubmitListener, resolve, setAfterRequestInjection, setAttachmentAt, setBindAddress, setDomain, setDumpFile, setEncoding, setEndpoint, setEntitizeProperties, setFollowRedirects, setIconAnimator, setMaxSize, setMultipartEnabled, setPassword, setPreemptive, setPrettyPrint, setRemoveEmptyContent, setRequestContent, setRequestHeaders, setRequestHeaders, setResponse, setSelectedAuthProfileAndAuthType, setSslKeystore, setStripWhitespaces, setTimeout, setUsername

Methods inherited from class com.eviware.soapui.impl.wsdl.AbstractWsdlModelItem

afterLoad, dependsOn, getConfig, getDescription, getExternalDependencies, getId, getName, getSettings, getWsdlModelItemById, getWsdlModelItemByName, setConfig, setDescription, setIcon, setName, setSettings

Methods inherited from class com.eviware.soapui.model.support.AbstractModelItem

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, getChildren, getProject, notifyPropertyChanged, notifyPropertyChanged, notifyPropertyChanged, notifyPropertyChanged, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.eviware.soapui.impl.rest.RestRequestInterface

setResponse

Methods inherited from interface com.eviware.soapui.impl.support.AbstractHttpRequestInterface

addExternalDependencies, beforeSave, copyAttachmentsTo, getAfterRequestInjection, getAuthType, getBindAddress, getDomain, getDumpFile, getIcon, getIconAnimator, getMaxSize, getPassword, getRequestHeaders, getResponse, getSslKeystore, getSubmitListeners, getUsername, importAttachment, isEntitizeProperties, isFollowRedirects, isPrettyPrint, isReadOnly, isRemoveEmptyContent, isStripWhitespaces, resolve, setBindAddress, setDomain, setDumpFile, setEntitizeProperties, setFollowRedirects, setIconAnimator, setMaxSize, setMultipartEnabled, setPassword, setPrettyPrint, setRemoveEmptyContent, setRequestContent, setRequestHeaders, setSslKeystore, setStripWhitespaces, setUsername

Methods inherited from interface com.eviware.soapui.model.iface.Request

addSubmitListener, dependsOn, getAttachments, getEncoding, getEndpoint, getRequestContent, getTimeout, removeSubmitListener, setEncoding, setEndpoint

Methods inherited from interface com.eviware.soapui.model.ModelItem

getChildren, getDescription, getId, getName, getProject, getSettings

Methods inherited from interface com.eviware.soapui.support.PropertyChangeNotifier

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.eviware.soapui.impl.wsdl.MutableAttachmentContainer

attachFile, removeAttachment

Methods inherited from interface com.eviware.soapui.impl.wsdl.AttachmentContainer

addAttachmentsChangeListener, getAttachmentAt, getAttachmentCount, getAttachments, getAttachmentsForPart, isMultipartEnabled, removeAttachmentsChangeListener

Constructor Detail

RestRequest

public RestRequest(RestMethod method,
                   RestRequestConfig requestConfig,
                   boolean forLoadTest)

Method Detail

getParent

public ModelItem getParent()

Specified by:

getParent in interface ModelItem

Overrides:

getParent in class AbstractWsdlModelItem<RestRequestConfig>

getRestMethod

public RestMethod getRestMethod()

Specified by:

getRestMethod in interface RestRequestInterface

initIconAnimator

protected AbstractHttpRequest.RequestIconAnimator<?> initIconAnimator()

Overrides:

initIconAnimator in class AbstractHttpRequest<RestRequestConfig>

getRequestParts

public MessagePart[] getRequestParts()

Specified by:

getRequestParts in interface Request

getRepresentations

public RestRepresentation[] getRepresentations()

Specified by:

getRepresentations in interface RestRequestInterface

getRepresentations

public RestRepresentation[] getRepresentations(RestRepresentation.Type type)

Specified by:

getRepresentations in interface RestRequestInterface

getRepresentations

public RestRepresentation[] getRepresentations(RestRepresentation.Type type,
                                               String mediaType)

Specified by:

getRepresentations in interface RestRequestInterface

getResponseParts

public MessagePart[] getResponseParts()

Specified by:

getResponseParts in interface Request

getMethod

public RestRequestInterface.HttpMethod getMethod()

Specified by:

getMethod in interface AbstractHttpRequestInterface<RestRequestConfig>

Specified by:

getMethod in class AbstractHttpRequest<RestRequestConfig>

getAccept

public String getAccept()

Specified by:

getAccept in interface RestRequestInterface

setAccept

public void setAccept(String acceptEncoding)

Specified by:

setAccept in interface RestRequestInterface

setMediaType

public void setMediaType(String mediaType)

Description copied from interface: MediaType

This method should set the media type so it can later be accessed by getMediaType.

Specified by:

setMediaType in interface MediaType

Parameters:

mediaType - a valid media type.

getMediaType

public String getMediaType()

Description copied from interface: MediaType

This method should return a valid media type. For example application/xml or application/json. Check out the standard for valid values.

Specified by:

getMediaType in interface MediaType

Returns:

a valid media type.

setMethod

public void setMethod(RestRequestInterface.HttpMethod method)

Specified by:

setMethod in interface HttpRequestInterface<RestRequestConfig>

submit

public WsdlSubmit<RestRequest> submit(SubmitContext submitContext,
                                      boolean async)
                               throws Request.SubmitException

Specified by:

submit in interface Request

Throws:

Request.SubmitException

getPropertyExpansions

public PropertyExpansion[] getPropertyExpansions()

Specified by:

getPropertyExpansions in interface PropertyExpansionContainer

Overrides:

getPropertyExpansions in class AbstractHttpRequest<RestRequestConfig>

addJMSHeaderExpansions

public void addJMSHeaderExpansions(PropertyExpansionsResult result,
                                   JMSHeaderConfig jmsHeaderConfig,
                                   ModelItem modelItem)

addProperty

public TestProperty addProperty(String name)

Specified by:

addProperty in interface MutableTestPropertyHolder

moveProperty

public void moveProperty(String propertyName,
                         int targetIndex)

Specified by:

moveProperty in interface MutableTestPropertyHolder

removeProperty

public TestProperty removeProperty(String propertyName)

Specified by:

removeProperty in interface MutableTestPropertyHolder

renameProperty

public boolean renameProperty(String name,
                              String newName)

Specified by:

renameProperty in interface MutableTestPropertyHolder

addTestPropertyListener

public void addTestPropertyListener(TestPropertyListener listener)

Specified by:

addTestPropertyListener in interface TestPropertyHolder

getModelItem

public ModelItem getModelItem()

Description copied from interface: AttachmentContainer

Returns ModelItem associated with this container

Specified by:

getModelItem in interface AttachmentContainer

Specified by:

getModelItem in interface TestPropertyHolder

getOperation

public RestResource getOperation()

Specified by:

getOperation in interface Request

Overrides:

getOperation in class AbstractHttpRequest<RestRequestConfig>

getProperties

public Map<String,TestProperty> getProperties()

Specified by:

getProperties in interface TestPropertyHolder

getProperty

public RestParamProperty getProperty(String name)

Specified by:

getProperty in interface TestPropertyHolder

getPropertyAt

public RestParamProperty getPropertyAt(int index)

Specified by:

getPropertyAt in interface TestPropertyHolder

getPropertyCount

public int getPropertyCount()

Specified by:

getPropertyCount in interface TestPropertyHolder

getPropertyNames

public String[] getPropertyNames()

Specified by:

getPropertyNames in interface TestPropertyHolder

getPropertyValue

public String getPropertyValue(String name)

Specified by:

getPropertyValue in interface TestPropertyHolder

hasProperty

public boolean hasProperty(String name)

Specified by:

hasProperty in interface TestPropertyHolder

removeTestPropertyListener

public void removeTestPropertyListener(TestPropertyListener listener)

Specified by:

removeTestPropertyListener in interface TestPropertyHolder

setPropertyValue

public void setPropertyValue(String name,
                             String value)

Specified by:

setPropertyValue in interface TestPropertyHolder

resetPropertyValues

public void resetPropertyValues()

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

getResponseMediaTypes

public String[] getResponseMediaTypes()

Specified by:

getResponseMediaTypes in interface RestRequestInterface

isPostQueryString

public boolean isPostQueryString()

Specified by:

isPostQueryString in interface HttpRequestInterface<RestRequestConfig>

setPostQueryString

public void setPostQueryString(boolean b)

Specified by:

setPostQueryString in interface HttpRequestInterface<RestRequestConfig>

getPropertiesLabel

public String getPropertiesLabel()

Specified by:

getPropertiesLabel in interface TestPropertyHolder

getParams

public RestParamsPropertyHolder getParams()

Specified by:

getParams in interface HttpRequestInterface<RestRequestConfig>

getAttachmentPart

public HttpAttachmentPart getAttachmentPart(String partName)

Description copied from class: AbstractHttpRequest

Override just to get a better return type

Specified by:

getAttachmentPart in interface AttachmentContainer

Specified by:

getAttachmentPart in class AbstractHttpRequest<RestRequestConfig>

See Also:

AttachmentContainer.getAttachmentPart(java.lang.String)

getDefinedAttachmentParts

public HttpAttachmentPart[] getDefinedAttachmentParts()

Specified by:

getDefinedAttachmentParts in interface AttachmentContainer

hasRequestBody

public boolean hasRequestBody()

Specified by:

hasRequestBody in interface HttpRequestInterface<RestRequestConfig>

getResource

public RestResource getResource()

Specified by:

getResource in interface RestRequestInterface

getPath

public String getPath()

Specified by:

getPath in interface HttpRequestInterface<RestRequestConfig>

setPath

public void setPath(String fullPath)

Specified by:

setPath in interface RestRequestInterface

getResponseContentAsXml

public String getResponseContentAsXml()

Specified by:

getResponseContentAsXml in interface HttpRequestInterface<RestRequestConfig>

release

public void release()

Specified by:

release in interface RestRequestInterface

Specified by:

release in interface AbstractHttpRequestInterface<RestRequestConfig>

Specified by:

release in interface Releasable

Overrides:

release in class AbstractHttpRequest<RestRequestConfig>

updateConfig

public void updateConfig(RestRequestConfig request)

Specified by:

updateConfig in interface HttpRequestInterface<RestRequestConfig>

updateParams

protected void updateParams()

hasEndpoint

public boolean hasEndpoint()

Specified by:

hasEndpoint in interface RestRequestInterface

Specified by:

hasEndpoint in interface AbstractHttpRequestInterface<RestRequestConfig>

Overrides:

hasEndpoint in class AbstractHttpRequest<RestRequestConfig>

getPropertyList

public List<TestProperty> getPropertyList()

Specified by:

getPropertyList in interface TestPropertyHolder

setRestMethod

protected void setRestMethod(RestMethod restMethod)

getJMSHeaderConfig

public JMSHeaderConfig getJMSHeaderConfig()

Specified by:

getJMSHeaderConfig in interface JMSHeaderContainer

getJMSPropertiesConfig

public JMSPropertiesConfig getJMSPropertiesConfig()

Specified by:

getJMSPropertiesConfig in interface JMSPropertyContainer

getMultiValueDelimiter

public String getMultiValueDelimiter()

Specified by:

getMultiValueDelimiter in interface HttpRequestInterface<RestRequestConfig>

setMultiValueDelimiter

public void setMultiValueDelimiter(String delimiter)