org.ws4d.java.attachment

Class AttachmentFactory

java.lang.Object

org.ws4d.java.attachment.AttachmentFactory

Direct Known Subclasses:

DefaultAttachmentFactory

public abstract class AttachmentFactory
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AttachmentFactory()

Method Summary

Modifier and Type	Method and Description
abstract boolean	addStreamingMediaType(ContentType type) Add a streaming mediatype.
abstract OutgoingAttachment	createFileAttachment(java.lang.String absoluteFilename, ContentType contentType) Creates a new FileAttachment.
abstract OutgoingAttachment	createFileAttachment(java.lang.String absoluteFilename, java.lang.String contentId, ContentType contentType) Creates a new FileAttachment.
abstract OutgoingAttachment	createMemoryAttachment(byte[] bytes, ContentType contentType) Creates a new MemoryAttachment.
abstract OutgoingAttachment	createMemoryAttachment(byte[] bytes, java.lang.String contentId, ContentType contentType) Creates a new MemoryAttachment.
abstract OutgoingOutputStreamAttachment	createStreamAttachment(ContentType contentType) Creates a new OutgoingOutputStreamAttachment.
abstract OutgoingAttachment	createStreamAttachment(java.io.InputStream in, ContentType contentType) Creates a new OutgoingInputStreamAttachment.
abstract OutgoingAttachment	createStreamAttachment(java.io.InputStream in, java.lang.String contentId, ContentType contentType) Creates a new OutgoingInputStreamAttachment.
abstract OutgoingOutputStreamAttachment	createStreamAttachment(java.lang.String contentId, ContentType contentType) Creates a new OutgoingOutputStreamAttachment.
static AttachmentFactory	getInstance() Returns an implementation of the attachment factory if available, which allows to handle incoming and outgoing attachments.If no implementation is loaded yet attemping to load the DefaultAttachmentFactory .
abstract Iterator	getStreamingMediaTypes() Returns an iterator over all streaming mediatypes.
abstract boolean	isStreamingMediaType(ContentType type) Returns true if type is streaming mediatype.
abstract boolean	removeStreamingMediaType(ContentType type) Removes a streaming mediatype.
abstract void	resetStreamingMediaTypes() Reseted all streaming media types.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentFactory

public AttachmentFactory()

Method Detail

getInstance

public static AttachmentFactory getInstance()

Returns an implementation of the attachment factory if available, which allows to handle incoming and outgoing attachments.If no implementation is loaded yet attemping to load the DefaultAttachmentFactory .

It is necessary to load the corresponding module for attachment support.

Returns:

an implementation of the attachment factory.

createFileAttachment

public abstract OutgoingAttachment createFileAttachment(java.lang.String absoluteFilename,
                                                        ContentType contentType)

Creates a new FileAttachment.

Parameters:

absoluteFilename -

contentType -

Returns:

an outgoing attachment

createFileAttachment

public abstract OutgoingAttachment createFileAttachment(java.lang.String absoluteFilename,
                                                        java.lang.String contentId,
                                                        ContentType contentType)

Creates a new FileAttachment.

Parameters:

absoluteFilename -

contentId -

contentType -

Returns:

an outgoing attachment

createMemoryAttachment

public abstract OutgoingAttachment createMemoryAttachment(byte[] bytes,
                                                          ContentType contentType)

Creates a new MemoryAttachment.

Parameters:

bytes -

contentType -

Returns:

an outgoing attachment

createMemoryAttachment

public abstract OutgoingAttachment createMemoryAttachment(byte[] bytes,
                                                          java.lang.String contentId,
                                                          ContentType contentType)

Creates a new MemoryAttachment.

Parameters:

bytes -

contentId -

contentType -

Returns:

an outgoing attachment

createStreamAttachment

public abstract OutgoingAttachment createStreamAttachment(java.io.InputStream in,
                                                          ContentType contentType)

Creates a new OutgoingInputStreamAttachment.

Parameters:

in -

contentType -

Returns:

an outgoing attachment

createStreamAttachment

public abstract OutgoingAttachment createStreamAttachment(java.io.InputStream in,
                                                          java.lang.String contentId,
                                                          ContentType contentType)

Creates a new OutgoingInputStreamAttachment.

Parameters:

in -

contentId -

contentType -

Returns:

an outgoing attachment

createStreamAttachment

public abstract OutgoingOutputStreamAttachment createStreamAttachment(ContentType contentType)

Creates a new OutgoingOutputStreamAttachment.

Parameters:

contentType -

Returns:

an outgoing output stream attachment

createStreamAttachment

public abstract OutgoingOutputStreamAttachment createStreamAttachment(java.lang.String contentId,
                                                                      ContentType contentType)

Creates a new OutgoingOutputStreamAttachment.

Parameters:

contentId -

contentType -

Returns:

an outgoing output stream attachment

addStreamingMediaType

public abstract boolean addStreamingMediaType(ContentType type)

Add a streaming mediatype.

Parameters:

type -

Returns:

true or false for add or just exists

removeStreamingMediaType

public abstract boolean removeStreamingMediaType(ContentType type)

Removes a streaming mediatype.

Parameters:

type -

Returns:

true or false for remove or not exists

isStreamingMediaType

public abstract boolean isStreamingMediaType(ContentType type)

Returns true if type is streaming mediatype.

Parameters:

type -

Returns:

true or false for exists or not

getStreamingMediaTypes

public abstract Iterator getStreamingMediaTypes()

Returns an iterator over all streaming mediatypes.

Returns:

iterator over all streaming media types

resetStreamingMediaTypes

public abstract void resetStreamingMediaTypes()

Reseted all streaming media types.