com.helger.phase4.messaging.domain

Class MessageHelperMethods

java.lang.Object

com.helger.phase4.messaging.domain.MessageHelperMethods

@Immutable
public final class MessageHelperMethods
extends Object

This class contains every method, static variables which are used by more than one message creating classes in this package.

Author:

bayerlma, Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	PART_PROPERTY_CHARACTER_SET
static String	PART_PROPERTY_COMPRESSION_TYPE
static String	PART_PROPERTY_MIME_TYPE
static String	PREFIX_CID

Method Summary

Modifier and Type	Method and Description
static Ebms3CollaborationInfo	createEbms3CollaborationInfo(String sAgreementRefPMode, String sAgreementRefValue, String sServiceType, String sServiceValue, String sAction, String sConversationID)
static Ebms3Description	createEbms3Description(Locale aLocale, String sText)
static Ebms3MessageInfo	createEbms3MessageInfo() Create a new message info with a UUID as message ID.
static Ebms3MessageInfo	createEbms3MessageInfo(String sRefToMessageID) Create a new message info with a UUID as message ID and a reference to the previous message.
static Ebms3MessageInfo	createEbms3MessageInfo(String sMessageID, String sRefToMessageID) Create a new message info.
static Ebms3MessageProperties	createEbms3MessageProperties(List<Ebms3Property> aEbms3Properties)
static Ebms3PartInfo	createEbms3PartInfo(IAS4Attachment aAttachment)
static Ebms3PartyId	createEbms3PartyId(String sValue)
static Ebms3PartyId	createEbms3PartyId(String sType, String sValue)
static Ebms3PartyInfo	createEbms3PartyInfo(String sFromRole, String sFromPartyID, String sToRole, String sToPartyID)
static Ebms3PartyInfo	createEbms3PartyInfo(String sFromRole, String sFromPartyIDType, String sFromPartyID, String sToRole, String sToPartyIDType, String sToPartyID)
static Ebms3PayloadInfo	createEbms3PayloadInfo(boolean bHasSoapPayload, com.helger.commons.collection.impl.ICommonsList<? extends IAS4Attachment> aAttachments) Add payload info if attachments are present.
static Ebms3Property	createEbms3Property(String sName, String sValue)
static Ebms3PartyInfo	createEbms3ReversePartyInfo(Ebms3PartyInfo aOrigPartyInfo)
static com.helger.commons.collection.impl.ICommonsList<Ebms3Property>	createEmbs3PropertiesOriginalSenderFinalRecipient(String sOriginalSender, String sFinalRecipient)
static String	createRandomAttachmentID()
static String	createRandomConversationID()
static String	createRandomMessageID()
static String	createRandomMessagingID()
static String	createRandomWSUID()
static void	forEachHeaderAndRemoveAfterwards(javax.mail.internet.MimeMessage aMimeMsg, BiConsumer<String,String> aConsumer, boolean bUnifyValues)
static com.helger.commons.http.HttpHeaderMap	getAndRemoveAllHeaders(javax.mail.internet.MimeMessage aMimeMsg)

Methods inherited from class java.lang.Object

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

Field Detail

PART_PROPERTY_MIME_TYPE

public static final String PART_PROPERTY_MIME_TYPE

See Also:

Constant Field Values

PART_PROPERTY_CHARACTER_SET

public static final String PART_PROPERTY_CHARACTER_SET

See Also:

Constant Field Values

PART_PROPERTY_COMPRESSION_TYPE

public static final String PART_PROPERTY_COMPRESSION_TYPE

See Also:

Constant Field Values

PREFIX_CID

public static final String PREFIX_CID

Method Detail

createRandomConversationID

@Nonnull
 @Nonempty
public static String createRandomConversationID()

createRandomMessageID

@Nonnull
 @Nonempty
public static String createRandomMessageID()

createRandomMessagingID

@Nonnull
 @Nonempty
public static String createRandomMessagingID()

createRandomAttachmentID

@Nonnull
 @Nonempty
public static String createRandomAttachmentID()

createRandomWSUID

@Nonnull
 @Nonempty
public static String createRandomWSUID()

createEbms3MessageInfo

@Nonnull
public static Ebms3MessageInfo createEbms3MessageInfo()

Create a new message info with a UUID as message ID.

Returns:

Never null.

createEbms3MessageInfo

@Nonnull
public static Ebms3MessageInfo createEbms3MessageInfo(@Nullable
                                                                String sRefToMessageID)

Create a new message info with a UUID as message ID and a reference to the previous message.

Parameters:

sRefToMessageID - The message ID of the referenced message. May be null.

Returns:

Never null.

createEbms3MessageInfo

@Nonnull
public static Ebms3MessageInfo createEbms3MessageInfo(@Nonnull @Nonempty
                                                                String sMessageID,
                                                                @Nullable
                                                                String sRefToMessageID)

Create a new message info.

Parameters:

sMessageID - The message ID. May neither be null nor empty.

sRefToMessageID - to set the reference to the previous message needed for two way exchanges

Returns:

Never null.

createEbms3Description

@Nonnull
 @ReturnsMutableCopy
public static Ebms3Description createEbms3Description(@Nonnull
                                                                                      Locale aLocale,
                                                                                      @Nonnull
                                                                                      String sText)

createEbms3Property

@Nonnull
public static Ebms3Property createEbms3Property(@Nonnull @Nonempty
                                                          String sName,
                                                          @Nonnull
                                                          String sValue)

createEmbs3PropertiesOriginalSenderFinalRecipient

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsList<Ebms3Property> createEmbs3PropertiesOriginalSenderFinalRecipient(@Nonnull
                                                                                                                                                               String sOriginalSender,
                                                                                                                                                               @Nonnull
                                                                                                                                                               String sFinalRecipient)

createEbms3PartyId

@Nonnull
public static Ebms3PartyId createEbms3PartyId(@Nonnull @Nonempty
                                                        String sValue)

createEbms3PartyId

@Nonnull
public static Ebms3PartyId createEbms3PartyId(@Nullable
                                                        String sType,
                                                        @Nonnull @Nonempty
                                                        String sValue)

createEbms3ReversePartyInfo

@Nonnull
public static Ebms3PartyInfo createEbms3ReversePartyInfo(@Nonnull
                                                                   Ebms3PartyInfo aOrigPartyInfo)

createEbms3PartyInfo

@Nonnull
public static Ebms3PartyInfo createEbms3PartyInfo(@Nonnull @Nonempty
                                                            String sFromRole,
                                                            @Nonnull @Nonempty
                                                            String sFromPartyID,
                                                            @Nonnull @Nonempty
                                                            String sToRole,
                                                            @Nonnull @Nonempty
                                                            String sToPartyID)

createEbms3PartyInfo

@Nonnull
public static Ebms3PartyInfo createEbms3PartyInfo(@Nonnull @Nonempty
                                                            String sFromRole,
                                                            @Nullable
                                                            String sFromPartyIDType,
                                                            @Nonnull @Nonempty
                                                            String sFromPartyID,
                                                            @Nonnull @Nonempty
                                                            String sToRole,
                                                            @Nullable
                                                            String sToPartyIDType,
                                                            @Nonnull @Nonempty
                                                            String sToPartyID)

createEbms3MessageProperties

@Nonnull
public static Ebms3MessageProperties createEbms3MessageProperties(@Nullable
                                                                            List<Ebms3Property> aEbms3Properties)

createEbms3CollaborationInfo

@Nonnull
public static Ebms3CollaborationInfo createEbms3CollaborationInfo(@Nullable
                                                                            String sAgreementRefPMode,
                                                                            @Nullable
                                                                            String sAgreementRefValue,
                                                                            @Nullable
                                                                            String sServiceType,
                                                                            @Nonnull @Nonempty
                                                                            String sServiceValue,
                                                                            @Nonnull @Nonempty
                                                                            String sAction,
                                                                            @Nonnull @Nonempty
                                                                            String sConversationID)

createEbms3PartInfo

@Nullable
public static Ebms3PartInfo createEbms3PartInfo(@Nullable
                                                           IAS4Attachment aAttachment)

createEbms3PayloadInfo

@Nullable
public static Ebms3PayloadInfo createEbms3PayloadInfo(boolean bHasSoapPayload,
                                                                 @Nullable
                                                                 com.helger.commons.collection.impl.ICommonsList<? extends IAS4Attachment> aAttachments)

Add payload info if attachments are present.

Parameters:

bHasSoapPayload - true if SOAP payload is present. This must be false when using MIME message layout!

aAttachments - Used attachments

Returns:

null if no attachments are present.

forEachHeaderAndRemoveAfterwards

public static void forEachHeaderAndRemoveAfterwards(@Nonnull
                                                    javax.mail.internet.MimeMessage aMimeMsg,
                                                    @Nonnull
                                                    BiConsumer<String,String> aConsumer,
                                                    boolean bUnifyValues)
                                             throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getAndRemoveAllHeaders

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.http.HttpHeaderMap getAndRemoveAllHeaders(@Nonnull
                                                                                                           javax.mail.internet.MimeMessage aMimeMsg)
                                                                                                    throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException