Package org.openas2.message

Class BaseMessage

java.lang.Object

org.openas2.message.BaseMessage

All Implemented Interfaces:

java.io.Serializable, Message

Direct Known Subclasses:

AS2Message

public abstract class BaseMessage
extends java.lang.Object
implements Message

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.openas2.message.Message

MSG_STATE_MDN_ASYNC_RECEIVE_FAIL, MSG_STATE_MDN_ERROR_RESPONSE_START, MSG_STATE_MDN_RECEIVE_START, MSG_STATE_MDN_RECEIVING_EXCEPTION, MSG_STATE_MDN_SEND_START, MSG_STATE_MDN_SENDING_EXCEPTION, MSG_STATE_MIC_MISMATCH, MSG_STATE_MSG_RXD_MDN_SENDING_FAIL, MSG_STATE_MSG_RXD_MDN_SENT_OK, MSG_STATE_MSG_SENT_MDN_RECEIVED_ERROR, MSG_STATE_MSG_SENT_MDN_RECEIVED_OK, MSG_STATE_RECEIVE_EXCEPTION, MSG_STATE_RECEIVE_FAIL, MSG_STATE_RECEIVE_START, MSG_STATE_SEND_EXCEPTION, MSG_STATE_SEND_FAIL, MSG_STATE_SEND_FAIL_RESEND_QUEUED, MSG_STATE_SEND_START, MSG_STATUS_MDN_PARSE, MSG_STATUS_MDN_PROCESS_INIT, MSG_STATUS_MDN_SEND, MSG_STATUS_MDN_VERIFY, MSG_STATUS_MDN_WAIT, MSG_STATUS_MSG_CLEANUP, MSG_STATUS_MSG_INIT, MSG_STATUS_MSG_RESEND, MSG_STATUS_MSG_SEND, MSG_STATUS_MSG_TERMINATED_IN_ERROR, SMIME_TYPE_COMPRESSED_DATA, STATE_MSGS

Constructor Summary

Constructors

Constructor	Description
BaseMessage()

Method Summary

Modifier and Type	Method	Description
void	addCustomOuterMimeHeader(java.lang.String key, java.lang.String value)
void	addHeader(java.lang.String key, java.lang.String value)
java.lang.String	extractPayloadFilename()
abstract java.lang.String	generateMessageID()
java.lang.String	getAppTitle()
java.lang.String	getAttribute(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
java.lang.String	getCalculatedMIC()
java.lang.String	getCompressionType()
java.lang.String	getContentDisposition()	Gets the "Content-Disposition" header from the message object
java.lang.String	getContentType()
java.util.Map<java.lang.String,java.lang.String>	getCustomOuterMimeHeaders()
javax.mail.internet.MimeBodyPart	getData()
java.lang.String	getHeader(java.lang.String key)
java.lang.String	getHeader(java.lang.String key, java.lang.String delimiter)
javax.mail.internet.InternetHeaders	getHeaders()
DataHistory	getHistory()
java.lang.String	getLogMsg()
java.lang.String	getLogMsgID()
MessageMDN	getMDN()
java.lang.String	getMessageID()
java.lang.Object	getOption(java.lang.Object key)
java.util.Map<java.lang.Object,java.lang.Object>	getOptions()
Partnership	getPartnership()
java.lang.String	getPayloadFilename()
java.lang.String	getStatus()
java.lang.String	getSubject()
java.lang.String	getXForwardedFor()
java.lang.String	getXRealIP()
boolean	isRxdMsgWasEncrypted()
boolean	isRxdMsgWasSigned()
void	setAttribute(java.lang.String key, java.lang.String value)
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
void	setCalculatedMIC(java.lang.String calculatedMIC)
void	setCompressionType(java.lang.String myCompressionType)
void	setContentDisposition(java.lang.String contentDisposition)	Sets the "Content-Disposition" header in the message object
void	setContentType(java.lang.String contentType)
void	setCustomOuterMimeHeaders(java.util.Map<java.lang.String,java.lang.String> customOuterMimeHeaders)
DataHistoryItem	setData(javax.mail.internet.MimeBodyPart data)
void	setData(javax.mail.internet.MimeBodyPart data, DataHistoryItem historyItem)
void	setHeader(java.lang.String key, java.lang.String value)
void	setHeaders(javax.mail.internet.InternetHeaders headers)
void	setHistory(DataHistory history)
void	setLogMsg(java.lang.String msg)
void	setMDN(MessageMDN mdn)
void	setMessageID(java.lang.String messageID)
void	setOption(java.lang.Object key, java.lang.Object value)
void	setPartnership(Partnership partnership)
void	setPayloadFilename(java.lang.String filename)
void	setRxdMsgWasEncrypted(boolean rxdMsgWasEncrypted)
void	setRxdMsgWasSigned(boolean rxdMsgWasSigned)
void	setStatus(java.lang.String status)
void	setSubject(java.lang.String subject)
java.lang.String	toString()
void	trackMsgState(Session session)
void	updateMessageID()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openas2.message.Message

getProtocol, isConfiguredForAsynchMDN, isConfiguredForMDN, isRequestingAsynchMDN, isRequestingMDN

Constructor Detail

BaseMessage

public BaseMessage()

Method Detail

getAppTitle

public java.lang.String getAppTitle()

Specified by:

getAppTitle in interface Message

getOptions

public java.util.Map<java.lang.Object,java.lang.Object> getOptions()

Specified by:

getOptions in interface Message

getStatus

public java.lang.String getStatus()

Specified by:

getStatus in interface Message

setStatus

public void setStatus(java.lang.String status)

Specified by:

setStatus in interface Message

getCustomOuterMimeHeaders

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

Specified by:

getCustomOuterMimeHeaders in interface Message

setCustomOuterMimeHeaders

public void setCustomOuterMimeHeaders(java.util.Map<java.lang.String,java.lang.String> customOuterMimeHeaders)

Specified by:

setCustomOuterMimeHeaders in interface Message

addCustomOuterMimeHeader

public void addCustomOuterMimeHeader(java.lang.String key,
                                     java.lang.String value)

Specified by:

addCustomOuterMimeHeader in interface Message

setOption

public void setOption(java.lang.Object key,
                      java.lang.Object value)

Specified by:

setOption in interface Message

getOption

public java.lang.Object getOption(java.lang.Object key)

Specified by:

getOption in interface Message

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.String value)

Specified by:

setAttribute in interface Message

getAttribute

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

Specified by:

getAttribute in interface Message

getAttributes

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

Specified by:

getAttributes in interface Message

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

Specified by:

setAttributes in interface Message

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface Message

setContentType

public void setContentType(java.lang.String contentType)

Specified by:

setContentType in interface Message

getCompressionType

public java.lang.String getCompressionType()

Specified by:

getCompressionType in interface Message

setCompressionType

public void setCompressionType(java.lang.String myCompressionType)

Specified by:

setCompressionType in interface Message

getContentDisposition

public java.lang.String getContentDisposition()

Gets the "Content-Disposition" header from the message object

Specified by:

getContentDisposition in interface Message

Returns:

the string value of the header

setContentDisposition

public void setContentDisposition(java.lang.String contentDisposition)

Sets the "Content-Disposition" header in the message object

Specified by:

setContentDisposition in interface Message

Parameters:

contentDisposition - the string value to be set

setData

public void setData(javax.mail.internet.MimeBodyPart data,
                    DataHistoryItem historyItem)

Specified by:

setData in interface Message

setData

public DataHistoryItem setData(javax.mail.internet.MimeBodyPart data)
                        throws OpenAS2Exception

Specified by:

setData in interface Message

Throws:

OpenAS2Exception

getData

public javax.mail.internet.MimeBodyPart getData()

Specified by:

getData in interface Message

setHeader

public void setHeader(java.lang.String key,
                      java.lang.String value)

Specified by:

setHeader in interface Message

getHeader

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

Specified by:

getHeader in interface Message

getHeader

public java.lang.String getHeader(java.lang.String key,
                                  java.lang.String delimiter)

Specified by:

getHeader in interface Message

getHeaders

public javax.mail.internet.InternetHeaders getHeaders()

Specified by:

getHeaders in interface Message

setHeaders

public void setHeaders(javax.mail.internet.InternetHeaders headers)

Specified by:

setHeaders in interface Message

getHistory

public DataHistory getHistory()

Specified by:

getHistory in interface Message

setHistory

public void setHistory(DataHistory history)

Specified by:

setHistory in interface Message

getMDN

public MessageMDN getMDN()

Specified by:

getMDN in interface Message

setMDN

public void setMDN(MessageMDN mdn)

Specified by:

setMDN in interface Message

getMessageID

public java.lang.String getMessageID()

Specified by:

getMessageID in interface Message

setMessageID

public void setMessageID(java.lang.String messageID)

Specified by:

setMessageID in interface Message

getPartnership

public Partnership getPartnership()

Specified by:

getPartnership in interface Message

setPartnership

public void setPartnership(Partnership partnership)

Specified by:

setPartnership in interface Message

generateMessageID

public abstract java.lang.String generateMessageID()
                                            throws InvalidParameterException

Specified by:

generateMessageID in interface Message

Throws:

InvalidParameterException

getSubject

public java.lang.String getSubject()

Specified by:

getSubject in interface Message

setSubject

public void setSubject(java.lang.String subject)

Specified by:

setSubject in interface Message

isRxdMsgWasSigned

public boolean isRxdMsgWasSigned()

setRxdMsgWasSigned

public void setRxdMsgWasSigned(boolean rxdMsgWasSigned)

isRxdMsgWasEncrypted

public boolean isRxdMsgWasEncrypted()

setRxdMsgWasEncrypted

public void setRxdMsgWasEncrypted(boolean rxdMsgWasEncrypted)

getXForwardedFor

public java.lang.String getXForwardedFor()

getXRealIP

public java.lang.String getXRealIP()

addHeader

public void addHeader(java.lang.String key,
                      java.lang.String value)

Specified by:

addHeader in interface Message

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

updateMessageID

public void updateMessageID()
                     throws InvalidParameterException

Specified by:

updateMessageID in interface Message

Throws:

InvalidParameterException

getLogMsgID

public java.lang.String getLogMsgID()

Specified by:

getLogMsgID in interface Message

getLogMsg

public java.lang.String getLogMsg()

Specified by:

getLogMsg in interface Message

setLogMsg

public void setLogMsg(java.lang.String msg)

Specified by:

setLogMsg in interface Message

getCalculatedMIC

public java.lang.String getCalculatedMIC()

Specified by:

getCalculatedMIC in interface Message

setCalculatedMIC

public void setCalculatedMIC(java.lang.String calculatedMIC)

Specified by:

setCalculatedMIC in interface Message

getPayloadFilename

public java.lang.String getPayloadFilename()

Specified by:

getPayloadFilename in interface Message

setPayloadFilename

public void setPayloadFilename(java.lang.String filename)

Specified by:

setPayloadFilename in interface Message

trackMsgState

public void trackMsgState(Session session)

Specified by:

trackMsgState in interface Message

extractPayloadFilename

public java.lang.String extractPayloadFilename()
                                        throws javax.mail.internet.ParseException

Specified by:

extractPayloadFilename in interface Message

Throws:

javax.mail.internet.ParseException