org.gcube.contentmanagement.baselayer.networkFileTransfer
Class GridFTPContentManager

java.lang.Object
  extended by org.gcube.contentmanagement.baselayer.networkFileTransfer.GridFTPContentManager
All Implemented Interfaces:
InstantiableManager, RawFileContentManager

public class GridFTPContentManager
extends java.lang.Object
implements RawFileContentManager, InstantiableManager

This class provides easy-to-use access to GridFTP The implementation is backed by the Commodity Grid (CoG) Kit, that provides some assistance to bridge between gt2 and gt4 and is part of the GT4 WS-Core distribution.


Field Summary
 
Fields inherited from interface org.gcube.contentmanagement.baselayer.InstantiableManager
MANAGER_INSTANTIATION_METHOD_NAME
 
Constructor Summary
GridFTPContentManager(java.lang.String managedURL)
          Constructs a new manager for a particular URL
 
Method Summary
 boolean deleteBinaryContent(RawContentLocation location, BasicStorageHints hints)
          Removes the binary content from storage
 void ensureResponsibleFor(RawContentLocation rcl)
           
 boolean existsBinaryContent(RawContentLocation location, BasicStorageHints hints)
          Checks whether there is content associated with this ID
 void get(java.lang.String remotePath, java.io.File localFile)
          Downloads a file from a remote GridFTP server and stores it in a local file
 BaseLayerStream getBinaryContent(RawContentLocation location, BasicStorageHints hints)
          Opens the content for reading and passes the input stream to the caller
 java.lang.String getDataProvider()
           
static java.lang.String getDataProviderPrefix()
          Returns the prefix that is used by the manager for identying responsibility for a data source
static GridFTPContentManager getManagerInstance(java.lang.String[] params, java.lang.String managerName)
          Generic factory method that returns an instance responsible for a particular URL
 java.lang.String getUniqueStorageLocationIDFor(java.lang.String objectID)
           
 boolean handles(java.lang.String dataprovider)
          Checks whether the RawFileContentManager can handle this data.
 RawContentLocation makePermanentLocation(RawContentLocation currentLocation, BasicStorageHints hints)
          Returns a raw location, which can be stored and retrieved later without the need to pass again all the hints.
 void put(java.io.File localFile, java.lang.String remotePath)
          Uploads a local file to a remote GridFTP server
 RawContentLocation saveBinaryContent(java.lang.String uniqueStorageID, BaseLayerStream binaryFileContent, BasicStorageHints hints)
          Saves the passed binary content in the managed resource.
 void setCredentialsProvider(CredentialsProvider provider)
          
 boolean supportsAppending()
          Tells whether this content manager supports appending content in addition to overwriting the content when storing
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GridFTPContentManager

public GridFTPContentManager(java.lang.String managedURL)
Constructs a new manager for a particular URL

Parameters:
managedURL - the URL that should be mamaged
Method Detail

getDataProviderPrefix

public static java.lang.String getDataProviderPrefix()
Returns the prefix that is used by the manager for identying responsibility for a data source

Returns:
the prefix

put

public void put(java.io.File localFile,
                java.lang.String remotePath)
         throws BaseLayerException
Uploads a local file to a remote GridFTP server

Parameters:
localFile - path to the local file
remotePath - URL of remote server
Throws:
BaseLayerException - in any case of failure

get

public void get(java.lang.String remotePath,
                java.io.File localFile)
         throws BaseLayerException
Downloads a file from a remote GridFTP server and stores it in a local file

Parameters:
remotePath - URL of file on remote server
localFile - path to the local file
Throws:
BaseLayerException - in any case of failure

saveBinaryContent

public RawContentLocation saveBinaryContent(java.lang.String uniqueStorageID,
                                            BaseLayerStream binaryFileContent,
                                            BasicStorageHints hints)
                                     throws BaseLayerException
Saves the passed binary content in the managed resource. If the resource did previously exist, it is updated and the old content is lost. If the resource did not exist, it will be newly created.

Specified by:
saveBinaryContent in interface RawFileContentManager
Parameters:
uniqueStorageID - a unique ID to as a hint where to store the content
binaryFileContent - the content to store
hints - the hints that should be used
Returns:
the RawContentLocation where the content is now accessible
Throws:
BaseLayerException - in case of failure of underlying storage system

getBinaryContent

public BaseLayerStream getBinaryContent(RawContentLocation location,
                                        BasicStorageHints hints)
                                 throws BaseLayerException
Opens the content for reading and passes the input stream to the caller

Specified by:
getBinaryContent in interface RawFileContentManager
Parameters:
location - the location to access the content
hints - the hints that should be used
Returns:
the content stored in the managed resource
Throws:
BaseLayerException - in case of failure of underlying storage system

deleteBinaryContent

public boolean deleteBinaryContent(RawContentLocation location,
                                   BasicStorageHints hints)
                            throws BaseLayerException
Removes the binary content from storage

Specified by:
deleteBinaryContent in interface RawFileContentManager
Parameters:
location - the location of the content that should be delteted
hints - the hints that should be used
Returns:
true, if content has been deleted successfully; false if the content did not exist and therefore the operation had no effect.
Throws:
BaseLayerException - in case of failure of underlying storage system

existsBinaryContent

public boolean existsBinaryContent(RawContentLocation location,
                                   BasicStorageHints hints)
                            throws BaseLayerException
Checks whether there is content associated with this ID

Specified by:
existsBinaryContent in interface RawFileContentManager
Parameters:
location - the location of the content
Returns:
true, if there is content present at this location; false, otherwise
Throws:
BaseLayerException - in case of failure of underlying storage system

handles

public boolean handles(java.lang.String dataprovider)
Checks whether the RawFileContentManager can handle this data.

This means that it can handle the requests for content stored at this dataprovider. In the ideal case, this also checks if it has all required access rights. But this cannot be enforced as a strong requirement before the actual calls take place.

Specified by:
handles in interface RawFileContentManager
Parameters:
dataprovider -
Returns:
true, if it can do, false otherwise

ensureResponsibleFor

public void ensureResponsibleFor(RawContentLocation rcl)
                          throws ValueNotValidException
Throws:
ValueNotValidException

getDataProvider

public java.lang.String getDataProvider()
Specified by:
getDataProvider in interface RawFileContentManager
Returns:
a string identifying this data source

supportsAppending

public boolean supportsAppending()
Tells whether this content manager supports appending content in addition to overwriting the content when storing

Specified by:
supportsAppending in interface RawFileContentManager
Returns:
true, if appending is supported
See Also:
BasicStorageHints#HINT_NAME_APPEND_CONTENT

makePermanentLocation

public RawContentLocation makePermanentLocation(RawContentLocation currentLocation,
                                                BasicStorageHints hints)
                                         throws ValueNotValidException
Returns a raw location, which can be stored and retrieved later without the need to pass again all the hints.

This is of particular interest for username / password combinations.

Specified by:
makePermanentLocation in interface RawFileContentManager
Parameters:
currentLocation - the location, where content can be accessed currently (may require information from the hints)
hints - hints, that may be needed to request the content
Returns:
a location which can be accessed without providing again the hints. This may not always be possible.
Throws:
ValueNotValidException - If some hints was not defined correctly or there is no possibility to include that in the permanent location.

getManagerInstance

public static GridFTPContentManager getManagerInstance(java.lang.String[] params,
                                                       java.lang.String managerName)
                                                throws BaseLayerException
Generic factory method that returns an instance responsible for a particular URL

Parameters:
params - the first String contains the URL that will be managed. If array is empty, the manager will be able to manage any directory
managerName - the name of the manager (currently not in use)
Returns:
the manager
Throws:
BaseLayerException - if location is not manageable by this kind of manager

setCredentialsProvider

public void setCredentialsProvider(CredentialsProvider provider)


getUniqueStorageLocationIDFor

public java.lang.String getUniqueStorageLocationIDFor(java.lang.String objectID)
Specified by:
getUniqueStorageLocationIDFor in interface RawFileContentManager