Interface HeadersAwareReceiverWebServiceConnection

All Superinterfaces:

AutoCloseable, WebServiceConnection

All Known Implementing Classes:

AbstractReceiverConnection, HttpExchangeConnection, HttpServletConnection, JmsReceiverConnection, MailReceiverConnection, XmppReceiverConnection

public interface HeadersAwareReceiverWebServiceConnection
extends WebServiceConnection

Sub-interface of WebServiceConnection that is aware of request headers and can define response headers.

Since:

2.3

Method Summary

Modifier and Type	Method	Description
void	addResponseHeader(String name, String value)	Adds a response header with the given name and value.
Iterator<String>	getRequestHeaderNames()	Return an iteration over all the header names the request contains.
Iterator<String>	getRequestHeaders(String name)	Return an iteration over all the string values of the specified request header.

Methods inherited from interface WebServiceConnection

close, getErrorMessage, getUri, hasError, receive, send

Method Details

getRequestHeaderNames

Iterator<String> getRequestHeaderNames()
                                throws IOException

Return an iteration over all the header names the request contains. Returns an empty Iterator if there are no headers.

Throws:

IOException

getRequestHeaders

Iterator<String> getRequestHeaders(String name)
                            throws IOException

Return an iteration over all the string values of the specified request header. Return an empty Iterator if there is no header of the specified name.

Throws:

IOException

addResponseHeader

void addResponseHeader(String name,
 String value)
                throws IOException

Adds a response header with the given name and value. This method can be called multiple times, to allow for headers with multiple values.

Parameters:

name - the name of the header

value - the value of the header

Throws:

IOException