com.helger.as2lib.message

Interface IBaseMessage

All Superinterfaces:

Serializable

All Known Subinterfaces:

IMessage, IMessageMDN

All Known Implementing Classes:

AbstractBaseMessage, AbstractMessage, AbstractMessageMDN, AS2Message, AS2MessageMDN

public interface IBaseMessage
extends Serializable

Base interface for IMessage and IMessageMDN. Must be Serializable, so that writing to disk for re-sending works.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.attr.IStringMap	attrs()
default boolean	containsHeader(String sName)
String	generateMessageID()
String	getAsString()
default String	getHeader(String sName)
default String	getHeaderCombined(String sName, String sDelimiter)
default String	getHeaderOrDefault(String sName, String sDefault)
String	getLoggingText()
default String	getMessageID()
com.helger.commons.http.HttpHeaderMap	headers()
Partnership	partnership()
default void	setMessageID(String sMessageID) Set special message ID header
void	setPartnership(Partnership aPartnership)
default void	updateMessageID() Shortcut for setMessageID (generateMessageID ())

Method Detail

attrs

@Nonnull
 @ReturnsMutableObject
com.helger.commons.collection.attr.IStringMap attrs()

Returns:

Mutable custom attribute map. Never null.

headers

@Nonnull
 @ReturnsMutableObject
com.helger.commons.http.HttpHeaderMap headers()

Returns:

Mutable HTTP header map. Never null.

getHeader

@Nullable
default String getHeader(@Nonnull
                                    String sName)

getHeaderCombined

@Nullable
default String getHeaderCombined(@Nonnull
                                            String sName,
                                            @Nonnull
                                            String sDelimiter)

getHeaderOrDefault

@Nullable
default String getHeaderOrDefault(@Nonnull
                                             String sName,
                                             @Nullable
                                             String sDefault)

containsHeader

default boolean containsHeader(@Nullable
                               String sName)

getMessageID

@Nullable
default String getMessageID()

Returns:

Special message ID header

setMessageID

default void setMessageID(@Nullable
                          String sMessageID)

Set special message ID header

Parameters:

sMessageID - Message ID

generateMessageID

@Nonnull
String generateMessageID()

updateMessageID

default void updateMessageID()

Shortcut for setMessageID (generateMessageID ())

partnership

@Nonnull
 @ReturnsMutableObject
Partnership partnership()

setPartnership

void setPartnership(@Nonnull
                    Partnership aPartnership)

getLoggingText

@Nonnull
 @Nonempty
String getLoggingText()

getAsString

@Nonnull
 @Nonempty
String getAsString()