AbstractContentWriter (Alfresco 5.0.3 Public API)

org.alfresco.repo.content

Class AbstractContentWriter

org.alfresco.repo.content.AbstractContentWriter

All Implemented Interfaces:

Direct Known Subclasses:

public abstract class AbstractContentWriter

Implements all the convenience methods of the interface. The only methods that need to be implemented, i.e. provide low-level content access are:

getReader() to create a reader to the underlying content
getDirectWritableChannel() to write content to the repository

Constructor Summary
protected	AbstractContentWriter(String contentUrl, ContentReader existingContentReader)

Method Summary
void	addListener(ContentStreamListener listener) Adds the listener after checking that the output stream isn't already in use.
protected void	channelOpened() Derived classes can call this method to ensure that necessary trace logging is performed when the IO Channel is opened.
protected abstract ContentReader	createReader() A factory method for subclasses to implement that will ensure the proper implementation of the ContentWriter.getReader() method.
protected void	finalize()
protected FileChannel	getCallbackFileChannel(FileChannel directChannel, List<ContentStreamListener> listeners) Generate a callback instance of the FileChannel.
ContentData	getContentData() Get the data representation of the content being accessed.
protected org.alfresco.repo.content.ContentLimitProvider	getContentLimitProvider() This method returns the configured ContentLimitProvider for this writer.
OutputStream	getContentOutputStream() Get a stream to write to the underlying channel.
String	getContentUrl() Retrieve the URL that this accessor references
protected abstract WritableByteChannel	getDirectWritableChannel() Provides low-level access to write content to the repository.
String	getEncoding() Get the encoding of the content being accessed
protected ContentReader	getExistingContentReader()
FileChannel	getFileChannel(boolean truncate) Provides read-write, random-access to the underlying content.
Locale	getLocale() Get the locale of the content being accessed
String	getMimetype() Get the content mimetype
ContentReader	getReader() Performs checks and copies required reader attributes
WritableByteChannel	getWritableChannel() Provides low-level access to write to repository content.
void	guessEncoding() When the content has been written, attempt to guess the encoding of it.
void	guessMimetype(String filename) When the content has been written, attempt to guess the mimetype of it, using the filename and contents.
boolean	isChannelOpen() Gets the open/close state of the underlying IO Channel.
boolean	isClosed() An automatically created listener sets the flag
void	putContent(ContentReader reader) Copies content from the reader.
void	putContent(File file) Puts content to the repository direct from file
void	putContent(InputStream is) Puts content to the repository
void	putContent(String content) Makes use of the encoding, if available, to convert the string to bytes.
void	setContentLimitProvider(org.alfresco.repo.content.ContentLimitProvider limitProvider)
protected void	setContentUrl(String contentUrl) Allow derived implementations to set the Content URL.
void	setEncoding(String encoding) Set the `String` encoding for this accessor
void	setLocale(Locale locale) Set the `Locale` for this accessor
void	setMimetype(String mimetype) Set the mimetype that must be used for accessing the content.
void	setMimetypeService(MimetypeService mimetypeService) Supplies the Mimetype Service to be used when guessing encoding and mimetype information.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.service.cmr.repository.ContentAccessor

getSize

AbstractContentWriter

protected AbstractContentWriter(String contentUrl,
ContentReader existingContentReader)

contentUrl - the content URL

existingContentReader - a reader of a previous version of this content

setContentLimitProvider

public void setContentLimitProvider(org.alfresco.repo.content.ContentLimitProvider limitProvider)

public void setMimetypeService(MimetypeService mimetypeService)

Supplies the Mimetype Service to be used when guessing encoding and mimetype information.

getExistingContentReader

protected ContentReader getExistingContentReader()

Returns a reader onto the previous version of this content

public void addListener(ContentStreamListener listener)

Adds the listener after checking that the output stream isn't already in use.

listener - a listener that will be called for output stream event notification

protected abstract ContentReader createReader()
throws ContentIOException

A factory method for subclasses to implement that will ensure the proper implementation of the ContentWriter.getReader() method.

Only the instance need be constructed. The required mimetype, encoding, etc will be copied across by this class.

Returns a reader onto the location referenced by this instance. The instance must always be a new instance and never null.

public final ContentReader getReader()
throws ContentIOException

Performs checks and copies required reader attributes

Returns a reader onto the underlying content that this writer will or has written to

getContentLimitProvider

protected org.alfresco.repo.content.ContentLimitProvider getContentLimitProvider()

This method returns the configured ContentLimitProvider for this writer. By default a ContentLimitProvider.NoLimitProvider will be returned.

public final boolean isClosed()

An automatically created listener sets the flag

isClosed in interface ContentWriter

Return true if the content output stream has been used and closed otherwise false.

public boolean isChannelOpen()

Description copied from interface: ContentAccessor

Gets the open/close state of the underlying IO Channel.

Returns true if the underlying IO Channel is open

getDirectWritableChannel

protected abstract WritableByteChannel getDirectWritableChannel()
throws ContentIOException

Provides low-level access to write content to the repository.

This is the only of the content writing methods that needs to be implemented by derived classes. All other content access methods make use of this in their underlying implementations.

Returns a channel with which to write content

ContentIOException - if the channel could not be opened

public final WritableByteChannel getWritableChannel()
throws ContentIOException

Description copied from interface: ContentWriter

Provides low-level access to write to repository content.

The channel returned to the client should remain open (subject to timeouts) until closed by the client. All lock detection, read-only access and other concurrency issues are dealt with during this operation. It remains possible that implementations will throw exceptions when the channel is closed.

The stream will notify any listeners according to the listener interface.

Returns a channel with which to write content

getDirectWritableChannel(), getCallbackWritableChannel(java.nio.channels.WritableByteChannel, List)

public FileChannel getFileChannel(boolean truncate)
throws ContentIOException

Provides read-write, random-access to the underlying content. In general, this method should be considered more expensive than the sequential-access method, ContentWriter.getWritableChannel().

Underlying implementations use the truncate parameter to determine the most effective means of providing access to the content.

truncate - true to start with zero length content

Returns a random-access channel onto the content

getContentOutputStream

public OutputStream getContentOutputStream()
throws ContentIOException

Description copied from interface: ContentWriter

Get a stream to write to the underlying channel.

Returns an output stream onto the underlying channel

public void putContent(ContentReader reader)
throws ContentIOException

Description copied from interface: ContentWriter

Copies content from the reader.

All resources will be closed automatically.

reader - the reader acting as the source of the content

public final void putContent(InputStream is)
throws ContentIOException

Description copied from interface: ContentWriter

Puts content to the repository

All resources will be closed automatically.

is - the input stream from which the content will be read

public final void putContent(File file)
throws ContentIOException

Description copied from interface: ContentWriter

Puts content to the repository direct from file

All resources will be closed automatically.

file - the file to load the content from

public final void putContent(String content)
throws ContentIOException

Makes use of the encoding, if available, to convert the string to bytes.

content - a string representation of the content

public void guessEncoding()

When the content has been written, attempt to guess the encoding of it.

public void guessMimetype(String filename)

When the content has been written, attempt to guess the mimetype of it, using the filename and contents.

filename - The filename of the content (if known)

protected void finalize()
throws Throwable

finalize in class Object

public String toString()

toString in class Object

public ContentData getContentData()

Description copied from interface: ContentAccessor

Get the data representation of the content being accessed.

The content mimetype must be set before this method is called as the content data requires a mimetype whenever the content URL is specified.

Returns the content data

protected final void channelOpened()

Derived classes can call this method to ensure that necessary trace logging is performed when the IO Channel is opened.

public String getContentUrl()

Description copied from interface: ContentAccessor

Retrieve the URL that this accessor references

protected void setContentUrl(String contentUrl)

Allow derived implementations to set the Content URL. This allows for implementations where the URL is not known when the accessor is first constructed.

contentUrl - the new content URL

public String getMimetype()

Description copied from interface: ContentAccessor

Get the content mimetype

Returns a content mimetype

public void setMimetype(String mimetype)

Description copied from interface: ContentAccessor

Set the mimetype that must be used for accessing the content.

When dealing with a ContentWriter, you may wish to use ContentWriter.guessMimetype(String) to have this set for you based on the filename and contents.

mimetype - the underlying content's mimetype - null if unknown

public String getEncoding()

Description copied from interface: ContentAccessor

Get the encoding of the content being accessed

Returns the content encoding - null if unknown

public void setEncoding(String encoding)

Description copied from interface: ContentAccessor

Set the String encoding for this accessor

When dealing with a ContentWriter, you may wish to use ContentWriter.guessMimetype(String) to have this set for you based on the contents.

encoding - the underlying content's encoding - null if unknown

public Locale getLocale()

Description copied from interface: ContentAccessor

Get the locale of the content being accessed

Returns the content locale or null if unkown

public void setLocale(Locale locale)

Description copied from interface: ContentAccessor

Set the Locale for this accessor

locale - the content's locale, if known.

getCallbackFileChannel

protected FileChannel getCallbackFileChannel(FileChannel directChannel,
List<ContentStreamListener> listeners)
throws ContentIOException

Generate a callback instance of the FileChannel.

directChannel - the delegate that to perform the actual operations

listeners - the listeners to call

Returns a new channel that functions just like the original, except that it issues callbacks to the listeners

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.