org.gytheio.content.handler

Interface ContentReferenceHandler

All Known Subinterfaces:

FileContentReferenceHandler

All Known Implementing Classes:

AbstractUrlContentReferenceHandler, FileContentReferenceHandlerImpl

public interface ContentReferenceHandler

Defines a handler for reading and writing ContentReference objects.

Author:

Ray Gauss II

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
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	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.

Method Detail

isContentReferenceSupported

boolean isContentReferenceSupported(ContentReference contentReference)

Determines whether the given content reference is supported by the handler

Parameters:

contentReference -

Returns:

whether or not the content reference is supported

createContentReference

ContentReference createContentReference(String fileName,
                                      String mediaType)
                                        throws ContentIOException

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

Parameters:

fileName -

mediaType -

Returns:

the created content reference

Throws:

ContentIOException

getInputStream

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

Gets an input stream for the given content reference

Parameters:

contentReference -

waitForAvailability - whether or not to check and wait for availability

Returns:

the content reference input stream

Throws:

ContentIOException

InterruptedException

putInputStream

long putInputStream(InputStream sourceInputStream,
                  ContentReference targetContentReference)
                    throws ContentIOException

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

Implementations should close both streams.

Parameters:

sourceInputStream -

targetContentReference -

Returns:

the size copied

Throws:

ContentIOException

delete

void delete(ContentReference contentReference)
            throws ContentIOException

Deletes the given content reference

Parameters:

contentReference -

Throws:

ContentIOException

isAvailable

boolean isAvailable()

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

Returns:

whether or not the handler is available