org.gytheio.content.handler

Class AbstractUrlContentReferenceHandler

java.lang.Object

org.gytheio.content.handler.AbstractUrlContentReferenceHandler

All Implemented Interfaces:

ContentReferenceHandler

public abstract class AbstractUrlContentReferenceHandler
extends Object
implements ContentReferenceHandler

A base ContentReferenceHandler implementation with convenience methods for dealing with URLs.

Author:

Ray Gauss II

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isAvailable
protected boolean	waitForAvailability

Constructor Summary

Constructors

Constructor and Description
AbstractUrlContentReferenceHandler()

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.
protected String	createNewUrl(String remoteRelativePath) Gets a URL from the getRemoteBaseUrl() and the given relative path.
protected String	getExtension(String remoteContentUrl) Gets the extension from the remote URL string
protected String	getRelativePath(String remoteContentUrl) Gets the relative path from the remote URL string
protected abstract String	getRemoteBaseUrl() Gets the remote base URL string for the handler.
protected String	getRemoteFileUrl(ContentReference contentReference) Gets the remote URL string from the given content reference.
protected String	getRemotePath(String remoteFilename) Builds the remote path for the given remote file name.
abstract void	init() Performs any initialization needed for the hanlder.
boolean	isAvailable() Determines whether or not the handler is currently available, i.e.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gytheio.content.handler.ContentReferenceHandler

delete, getInputStream, isContentReferenceExists, isContentReferenceSupported, putInputStream

Field Detail

isAvailable

protected boolean isAvailable

waitForAvailability

protected boolean waitForAvailability

Constructor Detail

AbstractUrlContentReferenceHandler

public AbstractUrlContentReferenceHandler()

Method Detail

init

public abstract void init()

Performs any initialization needed for the hanlder.

getRemoteBaseUrl

protected abstract String getRemoteBaseUrl()

Gets the remote base URL string for the handler. Content references contain the path so implementations may choose to only use this for validation purposes.

Returns:

the remote base URL string

createNewUrl

protected String createNewUrl(String remoteRelativePath)

Gets a URL from the getRemoteBaseUrl() and the given relative path.

Parameters:

remoteRelativePath -

Returns:

the new URL string

getRemotePath

protected String getRemotePath(String remoteFilename)

Builds the remote path for the given remote file name. The base implementation simply returns the given filename indicating all files should be saved in the 'root' of the getRemoteBaseUrl().

Parameters:

remoteFilename -

Returns:

the remote file path

getRelativePath

protected String getRelativePath(String remoteContentUrl)

Gets the relative path from the remote URL string

Parameters:

remoteContentUrl -

Returns:

the relative path

getExtension

protected String getExtension(String remoteContentUrl)

Gets the extension from the remote URL string

Parameters:

remoteContentUrl -

Returns:

the extension of the remote URL string

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

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

getRemoteFileUrl

protected String getRemoteFileUrl(ContentReference contentReference)

Gets the remote URL string from the given content reference. The base implementation simply returns the content reference's URI. Other implementations may need to perform some mapping to another protocol and/or path.

Parameters:

contentReference -

Returns:

the remote file URL