oracle.soa.api.message

Interface Attachment

All Superinterfaces:

java.io.Serializable

public interface Attachment
extends java.io.Serializable

Message attachment

Example:

 
        Attachment attachment =
        AttachmentFactory.getInstance().createAttachment("xyz",
                                                         "plain/text; charset=us-ascii",
                                                         "Attachment Content".getBytes("us-ascii"));
        message.addAttachment(attachment);
  
  

Method Summary

Modifier and Type	Method and Description
byte[]	getAsByteArray() Gets the attachment contents as a byte array
java.lang.String	getContentID() Gets the content identifier associated with the attachment
java.lang.String	getContentType() Gets the attachment content type
java.io.InputStream	getInputStream() Gets the attachment contents as an input stream
java.lang.String	getPartName() Gets the MIME part name for the attachment
int	getSize() Gets the attachment contents size, measured in number of bytes
java.lang.String	getTransferEncoding() Gets the transfer encoding for the attachment
void	setContentID(java.lang.String contentId) Sets the content identifier associated with the attachment
void	setContentType(java.lang.String contentType) Sets the attachment content type
void	setPartName(java.lang.String name) Sets the MIME part name for the attachment
void	setTransferEncoding(java.lang.String encoding) Sets the transfer encoding for the attachment

Method Detail

getAsByteArray

byte[] getAsByteArray()
               throws java.io.IOException

Gets the attachment contents as a byte array

Throws:

java.io.IOException

getContentID

java.lang.String getContentID()

Gets the content identifier associated with the attachment

Returns:

the content identifier

getContentType

java.lang.String getContentType()

Gets the attachment content type

Returns:

the content type

getInputStream

java.io.InputStream getInputStream()
                            throws java.io.IOException

Gets the attachment contents as an input stream

Throws:

java.io.IOException

getPartName

java.lang.String getPartName()

Gets the MIME part name for the attachment

Returns:

the part name, or null

getSize

int getSize()
     throws java.io.IOException

Gets the attachment contents size, measured in number of bytes

Returns:

the content size

Throws:

java.io.IOException

getTransferEncoding

java.lang.String getTransferEncoding()

Gets the transfer encoding for the attachment

Returns:

the transfer encoding

setContentID

void setContentID(java.lang.String contentId)

Sets the content identifier associated with the attachment

Parameters:

contentId - the content identifier

setContentType

void setContentType(java.lang.String contentType)

Sets the attachment content type

Parameters:

contentType - the content type

setPartName

void setPartName(java.lang.String name)

Sets the MIME part name for the attachment

Parameters:

name - the part name

setTransferEncoding

void setTransferEncoding(java.lang.String encoding)

Sets the transfer encoding for the attachment

Parameters:

encoding - A valid transfer encoding, complying to those values defined by http://www.iana.org/assignments/transfer-encodings/