org.mule.runtime.http.api.domain.message

Interface MessageWithHeaders

All Known Subinterfaces:

HttpMessage, HttpRequest, HttpResponse, WebSocketRequest

All Known Implementing Classes:

BaseHttpMessage, BaseMessageWithHeaders

public interface MessageWithHeaders

Generic contract for a message which contains headers

Since:

4.2.0

Method Summary

Modifier and Type	Method and Description
default boolean	containsHeader(String headerName)
Collection<String>	getHeaderNames()
org.mule.runtime.api.util.MultiMap<String,String>	getHeaders()
String	getHeaderValue(String headerName)
String	getHeaderValueIgnoreCase(String headerName) Deprecated. The underlying implementation is already case-insensitive. Use getHeaderValue(String)
Collection<String>	getHeaderValues(String headerName)
Collection<String>	getHeaderValuesIgnoreCase(String headerName) Deprecated. The underlying implementation is already case-insensitive. Use getHeaderValues(String)

Method Detail

getHeaderNames

Collection<String> getHeaderNames()

Returns:

all headers name

containsHeader

default boolean containsHeader(String headerName)

Parameters:

headerName - name of the header

Returns:

whether or not the header is present in the message

Since:

1.2

getHeaderValue

String getHeaderValue(String headerName)

Parameters:

headerName - name of the header

Returns:

first value of the header

getHeaderValueIgnoreCase

@Deprecated
String getHeaderValueIgnoreCase(String headerName)

Deprecated. The underlying implementation is already case-insensitive. Use getHeaderValue(String)

Parameters:

headerName - name of the header

Returns:

first value of the header, regardless of the case

getHeaderValues

Collection<String> getHeaderValues(String headerName)

Parameters:

headerName - name of the header

Returns:

an immutable Collection containing all the values of that headers. If not such headers exists return null, otherwise the collection of header values

getHeaderValuesIgnoreCase

@Deprecated
Collection<String> getHeaderValuesIgnoreCase(String headerName)

Deprecated. The underlying implementation is already case-insensitive. Use getHeaderValues(String)

Parameters:

headerName - name of the header

Returns:

an immutable Collection containing all the values of that headers, regardless of the case. If not such headers exists return null, otherwise the collection of header values

getHeaders

org.mule.runtime.api.util.MultiMap<String,String> getHeaders()

Returns:

an immutable MultiMap containing all headers