Class UploadBean

java.lang.Object

se.datadosen.jalbum.UploadBean

All Implemented Interfaces:

AutoCloseable, RemoteFSProgressMonitor

public class UploadBean
extends Object
implements RemoteFSProgressMonitor, AutoCloseable

Version 1.0
Glue between the JAlbum user interface and the RemoteFSBean ftp component. Also adds the "smart" upload feature by comparing file sizes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UploadBean.PathFinder	Utility class that helps resolving (figuring out) paths and URLs to published albums

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WEB_ROOT_PROPERTY

Constructor Summary

Constructors

Constructor	Description
UploadBean()
UploadBean(AlbumBean engine)

Method Summary

Modifier and Type	Method	Description
void	addAlbumBeanListener(AlbumBeanListener l)	AlbumBeanListener used to track and control file deletion
void	addPropertyChangeListener(PropertyChangeListener listener)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	addTransferListener(TransferListener l)	Event dispatching code
void	bytesTransferred(long bytes)	Implements RemoteFSProgressMonitor
boolean	cancelUpload()	Cancels the preprocessing stage prior to uploading files (cancels calculation of what files to upload)
void	close()
void	connect()
void	deleteAlbum(AlbumObject root, String remoteDir)	Remove all files and directories from remote album, then update properties for root album object
void	deleteDirectory(String remoteDir)	Remove all files and directories from remote album
void	disconnect()
void	downloadFile(RemoteFSNode node, File destination)
void	downloadFiles(String remotePath, File destination)
protected void	fireErrorOccured(Exception param1, File param2)
protected void	fireFileProcessingFinished(ProgressEvent e)
protected void	fireFileProcessingProgress(ProgressEvent e)
protected void	fireFileProcessingStarted(ProgressEvent e)
protected void	fireImageProcessingFinished(AlbumBeanEvent e)
protected void	fireImageProcessingStarted(AlbumBeanEvent e)
protected void	fireProgress(ProgressEvent e)
protected void	firePropertyChange(String propertyName, Object oldValue, Object newValue)	Support for reporting bound property changes for Object properties.
String	getAlbumURL()
String	getBaseDirectory()	The current directory when just logged in.
NavigableSet<RemoteFile>	getExistingAlbumFiles(AlbumBean engine, String remoteDirectory)	Attempt to gather the file contents under the specified remoteDirectory First try to grab the manifest.jmf file Then try CrushFTP's :filetree method Finally gather the contents by manually traversing the album directory
NavigableSet<RemoteFile>	getExistingAlbumFiles(AlbumBean engine, String remoteDirectory, Consumer<RemoteFile> consumer)	Same as above, but calls callback consumer for each remote file found, in case slow traversal is needed
String	getFtpPassword()
int	getFtpPort()
String	getFtpServer()
String	getFtpUser()
UploadBean.PathFinder	getPathFinder(AccountProfile account, AlbumBean engine)	Return utility class that helps resolving (figuring out) paths and URLs to published albums
UploadBean.PathFinder	getPathFinder(AlbumObject root, AlbumBean engine)
String	getPrintableAlbumURL()
TransferProtocol	getProtocol()
String	getRemoteDirectory()
RemoteFSDelegate	getRemoteFS()
Stopwatch	getStopwatch()
static long	getTotalSize(Set<RemoteFile> files, int clusterSize)
boolean	isConnected()
boolean	isFtpForceUTF8()
boolean	isMyjalbum()
boolean	isPassiveMode()
void	removeAlbumBeanListener(AlbumBeanListener l)
void	removePropertyChangeListener(PropertyChangeListener listener)	Removes a PropertyChangeListener from the listener list.
void	removeTransferListener(TransferListener l)
void	setAccountProperties(AccountProfile account)
void	setFtpForceUTF8(boolean force)
void	setFtpPassword(String newFtpPassword)
void	setFtpPort(int newFtpPort)
void	setFtpServer(String newFtpServer)
void	setFtpUser(String newFtpUser)
void	setMyjalbum(boolean myjalbum)
void	setPassiveMode(boolean newPassiveMode)
void	setProtocol(TransferProtocol protocol)
void	setRemoteDirectory(String remoteDirectory)
static void	showErrorDialog(Component owner, RemoteFSException ex, String messagePrefix, String title)	Convenience method
void	testConnection(AlbumBean engine)	Test a connection to a remote filesystem Exceptions are thrown if connection could not be established.
AlbumManifest	uploadAlbum(AlbumBean engine, boolean fullUpdate)	Upload an album to a server
AlbumManifest	uploadAlbum(AlbumBean engine, boolean fullUpdate, Set<File> localAlbumFiles, NavigableSet<RemoteFile> existingFiles)
void	uploadFiles(File[] filesDirs, String remotePath)

Methods inherited from class java.lang.Object

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

Field Details

WEB_ROOT_PROPERTY

public static final String WEB_ROOT_PROPERTY

See Also:

• Constant Field Values

Constructor Details

UploadBean

public UploadBean()

UploadBean

public UploadBean(AlbumBean engine)

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChangeListener from the listener list. This method should be used to remove PropertyChangeListeners that were registered for all bound properties of this class.

If listener is null, no exception is thrown and no action is performed.

Parameters:

listener - the PropertyChangeListener to be removed

See Also:

• addPropertyChangeListener(java.beans.PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener listener)

firePropertyChange

protected void firePropertyChange(String propertyName,
 Object oldValue,
 Object newValue)

Support for reporting bound property changes for Object properties. This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners.

Parameters:

propertyName - the property whose value has changed

oldValue - the property's previous value

newValue - the property's new value

getStopwatch

public Stopwatch getStopwatch()

showErrorDialog

public static void showErrorDialog(Component owner,
 RemoteFSException ex,
 String messagePrefix,
 String title)

Convenience method

cancelUpload

public boolean cancelUpload()

Cancels the preprocessing stage prior to uploading files (cancels calculation of what files to upload)

Returns:

true if successful

Since:

26.1

getRemoteFS

public RemoteFSDelegate getRemoteFS()

deleteAlbum

public void deleteAlbum(AlbumObject root,
 String remoteDir)
                 throws ParameterException,
RemoteFSException,
IOException

Remove all files and directories from remote album, then update properties for root album object

Throws:

ParameterException

RemoteFSException

IOException

deleteDirectory

public void deleteDirectory(String remoteDir)
                     throws ParameterException,
RemoteFSException,
IOException

Remove all files and directories from remote album

Throws:

ParameterException

RemoteFSException

IOException

setFtpServer

public void setFtpServer(String newFtpServer)

getFtpServer

public String getFtpServer()

setFtpPort

public void setFtpPort(int newFtpPort)
                throws RemoteFSException

Throws:

RemoteFSException

getFtpPort

public int getFtpPort()
               throws RemoteFSException

Throws:

RemoteFSException

setFtpUser

public void setFtpUser(String newFtpUser)

getFtpUser

public String getFtpUser()

setFtpPassword

public void setFtpPassword(String newFtpPassword)

getFtpPassword

public String getFtpPassword()

isMyjalbum

public boolean isMyjalbum()

setMyjalbum

public void setMyjalbum(boolean myjalbum)

isFtpForceUTF8

public boolean isFtpForceUTF8()
                       throws RemoteFSException

Throws:

RemoteFSException

setFtpForceUTF8

public void setFtpForceUTF8(boolean force)
                     throws RemoteFSException

Throws:

RemoteFSException

getProtocol

public TransferProtocol getProtocol()

setProtocol

public void setProtocol(TransferProtocol protocol)

setPassiveMode

public void setPassiveMode(boolean newPassiveMode)
                    throws RemoteFSException

Throws:

RemoteFSException

isPassiveMode

public boolean isPassiveMode()
                      throws RemoteFSException

Throws:

RemoteFSException

setAccountProperties

public void setAccountProperties(AccountProfile account)

connect

public void connect()
             throws RemoteFSException,
IOException,
AccountExpiredException,
FailedLoginException

Throws:

RemoteFSException

IOException

AccountExpiredException

FailedLoginException

Since:

7.0

getRemoteDirectory

public String getRemoteDirectory()

setRemoteDirectory

public void setRemoteDirectory(String remoteDirectory)

disconnect

public void disconnect()

Since:

7.0

isConnected

public boolean isConnected()

testConnection

public void testConnection(AlbumBean engine)
                    throws IOException,
RemoteFSException

Test a connection to a remote filesystem Exceptions are thrown if connection could not be established. New in version 1.1

Throws:

RemoteFSException

IOException

getPrintableAlbumURL

public String getPrintableAlbumURL()

getAlbumURL

public String getAlbumURL()

getBaseDirectory

public String getBaseDirectory()

The current directory when just logged in. Relative paths should be relative to this directory

getTotalSize

public static long getTotalSize(Set<RemoteFile> files,
 int clusterSize)

getExistingAlbumFiles

public NavigableSet<RemoteFile> getExistingAlbumFiles(AlbumBean engine,
 String remoteDirectory)
                                               throws IOException,
RemoteFSException

Attempt to gather the file contents under the specified remoteDirectory First try to grab the manifest.jmf file Then try CrushFTP's :filetree method Finally gather the contents by manually traversing the album directory

Throws:

IOException

RemoteFSException

close

public void close()

Specified by:

close in interface AutoCloseable

getExistingAlbumFiles

public NavigableSet<RemoteFile> getExistingAlbumFiles(AlbumBean engine,
 String remoteDirectory,
 Consumer<RemoteFile> consumer)
                                               throws IOException,
RemoteFSException

Same as above, but calls callback consumer for each remote file found, in case slow traversal is needed

Parameters:

engine -

remoteDirectory -

consumer -

Returns:

Throws:

IOException

RemoteFSException

uploadAlbum

public AlbumManifest uploadAlbum(AlbumBean engine,
 boolean fullUpdate)
                          throws RemoteFSException,
IOException

Upload an album to a server

Parameters:

fullUpdate - Throws ParameterException

Throws:

RemoteFSException

IOException

OperationAbortedException

uploadAlbum

public AlbumManifest uploadAlbum(AlbumBean engine,
 boolean fullUpdate,
 Set<File> localAlbumFiles,
 NavigableSet<RemoteFile> existingFiles)
                          throws RemoteFSException,
IOException,
OperationAbortedException

Throws:

RemoteFSException

IOException

OperationAbortedException

uploadFiles

public void uploadFiles(File[] filesDirs,
 String remotePath)
                 throws RemoteFSException,
IOException,
OperationAbortedException

Throws:

RemoteFSException

IOException

OperationAbortedException

downloadFile

public void downloadFile(RemoteFSNode node,
 File destination)
                  throws RemoteFSException,
IOException,
OperationAbortedException

Throws:

RemoteFSException

IOException

OperationAbortedException

downloadFiles

public void downloadFiles(String remotePath,
 File destination)
                   throws RemoteFSException,
IOException,
OperationAbortedException

Throws:

RemoteFSException

IOException

OperationAbortedException

addTransferListener

public void addTransferListener(TransferListener l)

Event dispatching code

removeTransferListener

public void removeTransferListener(TransferListener l)

fireProgress

protected void fireProgress(ProgressEvent e)

fireFileProcessingStarted

protected void fireFileProcessingStarted(ProgressEvent e)

fireFileProcessingProgress

protected void fireFileProcessingProgress(ProgressEvent e)

fireFileProcessingFinished

protected void fireFileProcessingFinished(ProgressEvent e)

fireErrorOccured

protected void fireErrorOccured(Exception param1,
 File param2)

addAlbumBeanListener

public void addAlbumBeanListener(AlbumBeanListener l)

AlbumBeanListener used to track and control file deletion

removeAlbumBeanListener

public void removeAlbumBeanListener(AlbumBeanListener l)

fireImageProcessingStarted

protected void fireImageProcessingStarted(AlbumBeanEvent e)

fireImageProcessingFinished

protected void fireImageProcessingFinished(AlbumBeanEvent e)

bytesTransferred

public void bytesTransferred(long bytes)

Implements RemoteFSProgressMonitor

Specified by:

bytesTransferred in interface RemoteFSProgressMonitor

getPathFinder

public UploadBean.PathFinder getPathFinder(AccountProfile account,
 AlbumBean engine)
                                    throws IOException,
RemoteFSException

Return utility class that helps resolving (figuring out) paths and URLs to published albums

Parameters:

account -

engine -

Returns:

Throws:

IOException

RemoteFSException

getPathFinder

public UploadBean.PathFinder getPathFinder(AlbumObject root,
 AlbumBean engine)
                                    throws IOException,
RemoteFSException

Throws:

IOException

RemoteFSException