Package com.storedobject.core

Class StreamContentProducer

java.lang.Object

com.storedobject.core.StreamContentProducer

All Implemented Interfaces:

Executable, ContentProducer, ContentType, RequiresTransactionManager, Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

AbstractSpreadSheet, ImageProducer, TextContentProducer

public abstract class StreamContentProducer
extends Object
implements ContentProducer, Closeable

Field Summary

Fields

Modifier and Type	Field	Description
protected Entity	entity
protected OutputStream	out

Constructor Summary

Constructors

Constructor	Description
StreamContentProducer()
StreamContentProducer(OutputStream out)

Method Summary

Modifier and Type	Method	Description
void	abort(Throwable error)	This method may be called when the content generation is aborted due to some error.
void	close()
abstract void	generateContent()	Generate the content here and write to 'out'
InputStream	getContent()
final Entity	getEntity()
Throwable	getError()	Get the current error (set via ContentProducer.abort(Throwable)).
String	getFileName()
final ReportFormat	getReportFormat()
TransactionManager	getTransactionManager()	Retrieves the transaction manager associated with this object.
protected Writer	getWriter()
static boolean	isBlocked(ContentProducer contentProducer, String type)
final boolean	isBlocked(String type)
void	produce()	Produce the content.
void	ready()
void	setTransactionManager(TransactionManager tm)	Sets the transaction manager for this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.ContentProducer

execute, extractContent, getFileExtension, getStreamData, getStreamDataProvider, getSystemEntity, saveTo, saveTo, saveTo, saveTo

Methods inherited from interface com.storedobject.core.ContentType

getContentType, getLink, getMimeType, isAudio, isHTML, isImage, isLink, isMedia, isPDF, isText, isVideo

Methods inherited from interface com.storedobject.common.Executable

act, run

Field Details

out

protected OutputStream out

entity

protected Entity entity

Constructor Details

StreamContentProducer

public StreamContentProducer()

StreamContentProducer

public StreamContentProducer(OutputStream out)

Method Details

produce

public void produce()

Description copied from interface: ContentProducer

Produce the content.

Specified by:

produce in interface ContentProducer

ready

public void ready()

Specified by:

ready in interface ContentProducer

getFileName

public String getFileName()

Specified by:

getFileName in interface ContentProducer

generateContent

public abstract void generateContent()
                              throws Exception

Generate the content here and write to 'out'

Throws:

Exception - Can throw anything

getContent

public InputStream getContent()

Specified by:

getContent in interface ContentProducer

setTransactionManager

public void setTransactionManager(TransactionManager tm)

Description copied from interface: RequiresTransactionManager

Sets the transaction manager for this object. The transaction manager is responsible for managing transaction boundaries.

Specified by:

setTransactionManager in interface RequiresTransactionManager

Parameters:

tm - the transaction manager to be set

getTransactionManager

public TransactionManager getTransactionManager()

Description copied from interface: RequiresTransactionManager

Retrieves the transaction manager associated with this object.

Specified by:

getTransactionManager in interface ContentProducer

Specified by:

getTransactionManager in interface RequiresTransactionManager

Returns:

the transaction manager responsible for managing transaction boundaries

getWriter

protected Writer getWriter()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

abort

public void abort(Throwable error)

Description copied from interface: ContentProducer

This method may be called when the content generation is aborted due to some error.

Note: This could be invoked multiple times.

Specified by:

abort in interface ContentProducer

Parameters:

error - Error.

getError

public Throwable getError()

Description copied from interface: ContentProducer

Get the current error (set via ContentProducer.abort(Throwable)).

Specified by:

getError in interface ContentProducer

Returns:

Current error if any.

getReportFormat

public final ReportFormat getReportFormat()

getEntity

public final Entity getEntity()

Specified by:

getEntity in interface ContentProducer

isBlocked

public final boolean isBlocked(String type)

isBlocked

public static boolean isBlocked(ContentProducer contentProducer,
 String type)