Package org.alfresco.repo.content.filestore

Class FileContentWriter

java.lang.Object

org.alfresco.repo.content.AbstractContentAccessor

org.alfresco.repo.content.AbstractContentWriter

org.alfresco.repo.content.filestore.FileContentWriter

All Implemented Interfaces:

ContentAccessor, ContentWriter, MimetypeServiceAware

Direct Known Subclasses:

ContentCacheImpl.CacheWriter

@AlfrescoPublicApi
public class FileContentWriter
extends AbstractContentWriter

Provides direct access to a local file.

This class does not provide remote access to the file.

Author:

Derek Hulley

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.repo.content.AbstractContentAccessor

AbstractContentAccessor.CallbackFileChannel, AbstractContentAccessor.ChannelCloseCallbackAdvise

Constructor Summary

Constructors

Constructor	Description
FileContentWriter(File file)	Constructor that builds a URL based on the absolute path of the file.
FileContentWriter(File file, String url, ContentReader existingContentReader)	Constructor that explicitely sets the URL that the reader represents.
FileContentWriter(File file, ContentReader existingContentReader)	Constructor that builds a URL based on the absolute path of the file.

Method Summary

Modifier and Type	Method	Description
boolean	canWrite()
protected ContentReader	createReader()	The URL of the write is known from the start and this method contract states that no consideration needs to be taken w.r.t. the stream state.
protected WritableByteChannel	getDirectWritableChannel()	Provides low-level access to write content to the repository.
File	getFile()
long	getSize()

Methods inherited from class org.alfresco.repo.content.AbstractContentWriter

addListener, getContentLimitProvider, getContentOutputStream, getExistingContentReader, getFileChannel, getReader, getWritableChannel, guessEncoding, guessMimetype, isChannelOpen, isClosed, putContent, putContent, putContent, putContent, setContentLimitProvider, setMimetypeService

Methods inherited from class org.alfresco.repo.content.AbstractContentAccessor

channelOpened, finalize, getCallbackFileChannel, getContentData, getContentUrl, getEncoding, getLocale, getMimetype, setContentUrl, setEncoding, setLocale, setMimetype, 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

getContentData, getContentUrl, getEncoding, getLocale, getMimetype, setEncoding, setLocale, setMimetype

Constructor Details

FileContentWriter

public FileContentWriter(File file)

Constructor that builds a URL based on the absolute path of the file.

Parameters:

file - the file for writing. This will most likely be directly related to the content URL.

FileContentWriter

public FileContentWriter(File file,
 ContentReader existingContentReader)

Constructor that builds a URL based on the absolute path of the file.

Parameters:

file - the file for writing. This will most likely be directly related to the content URL.

existingContentReader - a reader of a previous version of this content

FileContentWriter

public FileContentWriter(File file,
 String url,
 ContentReader existingContentReader)

Constructor that explicitely sets the URL that the reader represents.

Parameters:

file - the file for writing. This will most likely be directly related to the content URL.

url - the relative url that the reader represents

existingContentReader - a reader of a previous version of this content

Method Details

getFile

public File getFile()

Returns:

Returns the file that this writer accesses

getSize

public long getSize()

Returns:

Returns the size of the underlying file or

createReader

protected ContentReader createReader()
                              throws ContentIOException

The URL of the write is known from the start and this method contract states that no consideration needs to be taken w.r.t. the stream state.

Specified by:

createReader in class AbstractContentWriter

Returns:

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

Throws:

ContentIOException

getDirectWritableChannel

protected WritableByteChannel getDirectWritableChannel()
                                                throws ContentIOException

Description copied from class: AbstractContentWriter

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.

Specified by:

getDirectWritableChannel in class AbstractContentWriter

Returns:

Returns a channel with which to write content

Throws:

ContentIOException - if the channel could not be opened

canWrite

public boolean canWrite()

Returns:

Returns true always