org.gytheio.content.handler

Class FileContentReferenceHandlerImpl

java.lang.Object

org.gytheio.content.handler.FileContentReferenceHandlerImpl

All Implemented Interfaces:

ContentReferenceHandler, FileContentReferenceHandler

public class FileContentReferenceHandlerImpl
extends Object
implements FileContentReferenceHandler

Java File content reference handler implementation.

Content reference creation is delegated to FileProvider.

Author:

Ray Gauss II

Field Summary

Fields

Modifier and Type	Field and Description
static String	URI_SCHEME_FILE

Constructor Summary

Constructors

Constructor and Description
FileContentReferenceHandlerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
ContentReference	createContentReference(String fileName, String mediaType) Creates a content reference of the given file name and media type.
void	delete(ContentReference contentReference) Deletes the given content reference
File	getFile(ContentReference contentReference, boolean waitForTransfer) Gets a File object for the given content reference, optionally waiting for the file to be available and match the expected file size.
InputStream	getInputStream(ContentReference contentReference, boolean waitForAvailability) Gets an input stream for the given content reference
boolean	isAvailable() Determines whether or not the handler is currently available, i.e.
boolean	isContentReferenceExists(ContentReference contentReference) Determines whether the given content reference exists
boolean	isContentReferenceSupported(ContentReference contentReference) Determines whether the given content reference is supported by the handler
long	putInputStream(InputStream sourceInputStream, ContentReference targetContentReference) Writes the given source input stream into the given target content reference.
void	setFileProvider(FileProvider fileProvider)
void	setFileProviderDirectoryPath(String directoryPath)
void	setTransferCheckPeriodMs(long transferCheckPeriodMs) Sets the interval to check for transfer
void	setTransferCheckTimeoutMs(long transferCheckTimeoutMs) Sets the transfer check timeout
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

URI_SCHEME_FILE

public static final String URI_SCHEME_FILE

See Also:

Constant Field Values

Constructor Detail

FileContentReferenceHandlerImpl

public FileContentReferenceHandlerImpl()

Method Detail

setFileProvider

public void setFileProvider(FileProvider fileProvider)

setTransferCheckPeriodMs

public void setTransferCheckPeriodMs(long transferCheckPeriodMs)

Sets the interval to check for transfer

Parameters:

transferCheckPeriodMs -

setTransferCheckTimeoutMs

public void setTransferCheckTimeoutMs(long transferCheckTimeoutMs)

Sets the transfer check timeout

Parameters:

transferCheckTimeoutMs -

setFileProviderDirectoryPath

public void setFileProviderDirectoryPath(String directoryPath)

isContentReferenceSupported

public boolean isContentReferenceSupported(ContentReference contentReference)

Description copied from interface: ContentReferenceHandler

Determines whether the given content reference is supported by the handler

Specified by:

isContentReferenceSupported in interface ContentReferenceHandler

Returns:

whether or not the content reference is supported

isContentReferenceExists

public boolean isContentReferenceExists(ContentReference contentReference)

Description copied from interface: ContentReferenceHandler

Determines whether the given content reference exists

Specified by:

isContentReferenceExists in interface ContentReferenceHandler

Returns:

whether or not the content reference exists

createContentReference

public ContentReference createContentReference(String fileName,
                                      String mediaType)
                                        throws ContentIOException

Description copied from interface: ContentReferenceHandler

Creates a content reference of the given file name and media type.

Specified by:

createContentReference in interface ContentReferenceHandler

Returns:

the created content reference

Throws:

ContentIOException

getFile

public File getFile(ContentReference contentReference,
           boolean waitForTransfer)
             throws ContentIOException,
                    InterruptedException

Description copied from interface: FileContentReferenceHandler

Gets a File object for the given content reference, optionally waiting for the file to be available and match the expected file size.

This is useful for implementations that already use a file-based implementation and can prevent workers from unnecessarily copying I/O streams.

Specified by:

getFile in interface FileContentReferenceHandler

Returns:

the File for the content reference

Throws:

ContentIOException

InterruptedException

getInputStream

public InputStream getInputStream(ContentReference contentReference,
                         boolean waitForAvailability)
                           throws ContentIOException

Description copied from interface: ContentReferenceHandler

Gets an input stream for the given content reference

Specified by:

getInputStream in interface ContentReferenceHandler

waitForAvailability - whether or not to check and wait for availability

Returns:

the content reference input stream

Throws:

ContentIOException

putInputStream

public long putInputStream(InputStream sourceInputStream,
                  ContentReference targetContentReference)
                    throws ContentIOException

Description copied from interface: ContentReferenceHandler

Writes the given source input stream into the given target content reference.

Implementations should close both streams.

Specified by:

putInputStream in interface ContentReferenceHandler

Returns:

the size copied

Throws:

ContentIOException

delete

public void delete(ContentReference contentReference)
            throws ContentIOException

Description copied from interface: ContentReferenceHandler

Deletes the given content reference

Specified by:

delete in interface ContentReferenceHandler

Throws:

ContentIOException

isAvailable

public boolean isAvailable()

Description copied from interface: ContentReferenceHandler

Determines whether or not the handler is currently available, i.e. any required credentials are defined and valid.

Specified by:

isAvailable in interface ContentReferenceHandler

Returns:

whether or not the handler is available

toString

public String toString()

Overrides:

toString in class Object