org.adroitlogic.x.core.attachment

Class Attachment

java.lang.Object

org.adroitlogic.x.core.attachment.Attachment

All Implemented Interfaces:

XAttachment

public class Attachment
extends Object
implements XAttachment

Implementation of XAttachment

Since:

17.01

Author:

Rajind Ruparathna

Constructor Summary

Constructors

Constructor and Description
Attachment(XAttachment xAttachment)
Attachment(XMessageFormat payload)
Attachment(XMessageFormat payload, String contentType)
Attachment(XMessageFormat payload, String contentType, MultiValueMap<String,String> headers)

Method Summary

Modifier and Type	Method and Description
void	addTransportHeader(String key, String value) Add a transport header to this attachment
XAttachment	copyOf() Creates a copy of this attachment including the payload
Optional<String>	getContentType() Retrieves the contentType of the attachment
Map<String,List<String>>	getDuplicateStringTransportHeaders() Get the map of current transport header duplicate values
Optional<String>	getFirstStringTransportHeader(String key) Get the first transport header with the given key wrapped in an Optional
Optional<String>	getFirstStringTransportHeaderIgnoreCase(String key) Get the first transport header with the given key ignoring case wrapped in an Optional
XMessageFormat	getPayload() Get the payload of the attachment
Map<String,String>	getStringTransportHeaders() Get the map of current transport header values ignoring duplicates
List<String>	getStringTransportHeaders(String key) Get a List of transport header values for the given key
void	removeAllTransportHeaders() Remove all transport headers
void	removeTransportHeader(String key) Remove all occurrences of the specified transport header
void	removeTransportHeaders(String... headers) Remove transport headers specified in the comma separated list
void	replaceTransportHeader(String key, String value) Replace the first occurrence of the transport header with the given value
void	retainOnlyTransportHeaders(String... headers) Retain only transport headers specified in the comma separated list
void	setContentType(String contentType) Set the content type of the attachment
void	setPayload(XMessageFormat payload) Set payload of the attachment

Methods inherited from class java.lang.Object

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

Constructor Detail

Attachment

public Attachment(XAttachment xAttachment)

Attachment

public Attachment(XMessageFormat payload)

Attachment

public Attachment(XMessageFormat payload,
                  String contentType)

Attachment

public Attachment(XMessageFormat payload,
                  String contentType,
                  MultiValueMap<String,String> headers)

Method Detail

getContentType

public Optional<String> getContentType()

Description copied from interface: XAttachment

Retrieves the contentType of the attachment

Specified by:

getContentType in interface XAttachment

Returns:

Optional containing the content-type string value if it exists and Optional.EMPTY otherwise

setContentType

public void setContentType(String contentType)

Description copied from interface: XAttachment

Set the content type of the attachment

Specified by:

setContentType in interface XAttachment

Parameters:

contentType - the content type string to be set

getPayload

public XMessageFormat getPayload()

Description copied from interface: XAttachment

Get the payload of the attachment

Specified by:

getPayload in interface XAttachment

Returns:

XMessageFormat value which represents the attachment payload

setPayload

public void setPayload(XMessageFormat payload)

Description copied from interface: XAttachment

Set payload of the attachment

Specified by:

setPayload in interface XAttachment

Parameters:

payload - XMessageFormat value which represents payload

addTransportHeader

public void addTransportHeader(String key,
                               String value)

Description copied from interface: XAttachment

Add a transport header to this attachment

Specified by:

addTransportHeader in interface XAttachment

Parameters:

key - header name

value - header value

getFirstStringTransportHeader

public Optional<String> getFirstStringTransportHeader(String key)

Description copied from interface: XAttachment

Get the first transport header with the given key wrapped in an Optional

Specified by:

getFirstStringTransportHeader in interface XAttachment

Parameters:

key - String key representing header field key

Returns:

Optional containing header content if it exists and Optional.EMPTY otherwise

getFirstStringTransportHeaderIgnoreCase

public Optional<String> getFirstStringTransportHeaderIgnoreCase(String key)

Description copied from interface: XAttachment

Get the first transport header with the given key ignoring case wrapped in an Optional

Specified by:

getFirstStringTransportHeaderIgnoreCase in interface XAttachment

Parameters:

key - String key representing header field key

Returns:

Optional containing header content if it exists and Optional.EMPTY otherwise

getStringTransportHeaders

public List<String> getStringTransportHeaders(String key)

Description copied from interface: XAttachment

Get a List of transport header values for the given key

Specified by:

getStringTransportHeaders in interface XAttachment

Parameters:

key - the name of the transport header that is to be retrieved

Returns:

transport headers as a List for the given key

getStringTransportHeaders

public Map<String,String> getStringTransportHeaders()

Description copied from interface: XAttachment

Get the map of current transport header values ignoring duplicates

Specified by:

getStringTransportHeaders in interface XAttachment

Returns:

transport headers as a Map, when ignoring duplicates

getDuplicateStringTransportHeaders

public Map<String,List<String>> getDuplicateStringTransportHeaders()

Description copied from interface: XAttachment

Get the map of current transport header duplicate values

Specified by:

getDuplicateStringTransportHeaders in interface XAttachment

Returns:

transport header duplicates as a Map

removeTransportHeader

public void removeTransportHeader(String key)

Description copied from interface: XAttachment

Remove all occurrences of the specified transport header

Specified by:

removeTransportHeader in interface XAttachment

Parameters:

key - header name to remove

removeAllTransportHeaders

public void removeAllTransportHeaders()

Description copied from interface: XAttachment

Remove all transport headers

Specified by:

removeAllTransportHeaders in interface XAttachment

removeTransportHeaders

public void removeTransportHeaders(String... headers)

Description copied from interface: XAttachment

Remove transport headers specified in the comma separated list

Specified by:

removeTransportHeaders in interface XAttachment

Parameters:

headers - a list of transport headers to remove

retainOnlyTransportHeaders

public void retainOnlyTransportHeaders(String... headers)

Description copied from interface: XAttachment

Retain only transport headers specified in the comma separated list

Specified by:

retainOnlyTransportHeaders in interface XAttachment

Parameters:

headers - a list of transport headers to retain

replaceTransportHeader

public void replaceTransportHeader(String key,
                                   String value)

Description copied from interface: XAttachment

Replace the first occurrence of the transport header with the given value

Specified by:

replaceTransportHeader in interface XAttachment

Parameters:

key - the header name

value - the new value

copyOf

public XAttachment copyOf()

Description copied from interface: XAttachment

Creates a copy of this attachment including the payload

Specified by:

copyOf in interface XAttachment

Returns:

a copy of this XAttachment