org.adroitlogic.as2.api

Class AttachmentDetails

java.lang.Object

org.adroitlogic.as2.api.AttachmentDetails

public class AttachmentDetails
extends Object

Holds an AS2 attachment / payload which maybe either in a String, or on a file

Author:

asankha

Constructor Summary

Constructors

Constructor and Description
AttachmentDetails(MessageFile messageFile, String contentType) Create a new AttachmentDetails object for the given filename, content type and transfer encoding
AttachmentDetails(String textContent) Create a new AttachmentDetails object for a String
AttachmentDetails(String fileName, String contentType) Create a new AttachmentDetails object for the given filename, content type and transfer encoding

Method Summary

Methods

Modifier and Type	Method and Description
String	getContentTransferEncoding() The content transfer encoding of the attachment
String	getContentType() The content type of the attachment
String	getFileName() The name of the file holding the attachment or null
MessageFile	getMessageFile() Return the MessageFile containing the payload, or null if none have been used
String	getOriginalFileName() The original name of the file (not the path) which contained the attachment
String	getPayloadHeader(String key)
String	getTextContent() The text content of the attachment, if the attachment is a String and not a file
boolean	isText() Is the attachment a String and not a file?
void	setOriginalFileName(String originalFileName) Set the original name of the file containing the attachment
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentDetails

public AttachmentDetails(MessageFile messageFile,
                 String contentType)

Create a new AttachmentDetails object for the given filename, content type and transfer encoding

Parameters:

messageFile - a MessageFile from a file cache containing the payload

contentType - content type of the attachment file

AttachmentDetails

public AttachmentDetails(String fileName,
                 String contentType)

Create a new AttachmentDetails object for the given filename, content type and transfer encoding

Parameters:

fileName - the complete file name for the attachment

contentType - content type of the attachment file

AttachmentDetails

public AttachmentDetails(String textContent)

Create a new AttachmentDetails object for a String

Parameters:

textContent - the String holding the input for the attachment

Method Detail

getMessageFile

public MessageFile getMessageFile()

Return the MessageFile containing the payload, or null if none have been used

Returns:

a MessageFile containing the payload, if used, or null

getFileName

public String getFileName()

The name of the file holding the attachment or null

Returns:

The name of the file holding the attachment or null

getContentType

public String getContentType()

The content type of the attachment

Returns:

The content type of the attachment

getContentTransferEncoding

public String getContentTransferEncoding()

The content transfer encoding of the attachment

Returns:

The content transfer encoding of the attachment

getTextContent

public String getTextContent()

The text content of the attachment, if the attachment is a String and not a file

Returns:

the textual content of the attachment

isText

public boolean isText()

Is the attachment a String and not a file?

Returns:

true, if the attachment is textual

getOriginalFileName

public String getOriginalFileName()

The original name of the file (not the path) which contained the attachment

Returns:

The original name of the file (not the path) which contained the attachment

setOriginalFileName

public void setOriginalFileName(String originalFileName)

Set the original name of the file containing the attachment

Parameters:

originalFileName - the original name of the file containing the attachment

toString

public String toString()

Overrides:

toString in class Object

getPayloadHeader

public String getPayloadHeader(String key)