com.opendxl.databus.entities

Class Headers

java.lang.Object

com.opendxl.databus.entities.Headers

All Implemented Interfaces:

java.lang.Cloneable

public class Headers
extends java.lang.Object
implements java.lang.Cloneable

It represents a key-value pair map where the user can put elements for the consumer's interest Some out-of-the-box elements names are located at HeadersField

See how to use in DatabusProducer example

Constructor Summary

Constructors

Constructor and Description
Headers() Headers default constructor with and empty map of headers
Headers(java.util.Map<java.lang.String,java.lang.String> headers) Headers constructor with a map of headers as a parameter

Method Summary

Modifier and Type	Method and Description
Headers	clone() A clone object of Headers instance
java.lang.String	get(java.lang.String key) Gets an specific header in the headers map
java.util.Map<java.lang.String,java.lang.String>	getAll() Gets the headers maps
java.lang.String	put(java.lang.String headerKey, java.lang.String value) Puts an specific header in the headers map

Methods inherited from class java.lang.Object

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

Constructor Detail

Headers

public Headers(java.util.Map<java.lang.String,java.lang.String> headers)

Headers constructor with a map of headers as a parameter

Parameters:

headers - a key-value pair Map with header to be transported. A null value is replcaed by a empty String

Headers

public Headers()

Headers default constructor with and empty map of headers

Method Detail

put

public java.lang.String put(java.lang.String headerKey,
                            java.lang.String value)

Puts an specific header in the headers map

Parameters:

headerKey - The header key to add

value - The header value to add

Returns:

The previous value associated

get

public java.lang.String get(java.lang.String key)

Gets an specific header in the headers map

Parameters:

key - The header key to get the header value

Returns:

The header value as String

getAll

public java.util.Map<java.lang.String,java.lang.String> getAll()

Gets the headers maps

Returns:

The Headers map

clone

public Headers clone()

A clone object of Headers instance

Overrides:

clone in class java.lang.Object

Returns:

A new cloned instance of Headers