org.vishia.fileRemote

Class FileAccessZip

java.lang.Object

org.vishia.fileRemote.FileRemoteAccessor

org.vishia.fileRemote.FileAccessZip

All Implemented Interfaces:

EventConsumer

public class FileAccessZip
extends FileRemoteAccessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	FileAccessZip.FileZipData
(package private) static class	FileAccessZip.FileZipInputStream A wrapper class for the returned InputStream.

Nested classes/interfaces inherited from class org.vishia.fileRemote.FileRemoteAccessor

FileRemoteAccessor.FileWalkerThread

Field Summary

Fields

Modifier and Type	Field and Description
private static FileAccessZip	instance
static int	version Version, history and license.

Fields inherited from interface org.vishia.event.EventConsumer

mEventConsumed, mEventConsumerException, mEventConsumFinished, mEventDonotRelinquish, mMaskReservedHere

Constructor Summary

Constructors

Constructor and Description
FileAccessZip()

Method Summary

Modifier and Type	Method and Description
void	abortAll() Abort currently running and saved copy, check etc. actions.
void	activate() Activates working of the devide, thread starting, communication establishing etc.
void	close()
void	close(FileRemote file)
java.lang.String	cmd(boolean bWait, FileRemoteCmdEventData co, EventWithDst<FileRemoteProgressEvData,?> evBack) Common form of a command with the file.
java.lang.CharSequence	completeFilePath(java.lang.CharSequence sPath) Returns a unique absolute path for the file regarding maybe tmp, home, environment variables etc.
void	copyChecked(FileRemote fileSrc, java.lang.String pathDst, java.lang.String nameModification, int mode, FileRemoteWalkerCallback callbackUser, FileRemoteProgressEvData timeOrderProgress) Copies all files which are checked before.
boolean	createNewFile(FileRemote file, EventWithDst<FileRemoteProgressEvData,?> evBack)
boolean	delete(FileRemote file, EventWithDst<FileRemoteProgressEvData,?> evBack) Try to delete the file.
EventThread_ifc	evThread() This operation should return that thread, which is associated to this consumer.
static FileRemote	examineZipFile(FileRemote fileZip) It examines a zip file.
java.util.List<java.io.File>	getChildren(FileRemote file, java.io.FileFilter filter) Gets files and sub directories of a directory.
static FileAccessZip	getInstance() Returns the singleton instance of this class.
java.lang.CharSequence	getStateInfo()
boolean	isLocalFileSystem() Creates or prepares a CmdEvent to send to the correct destination.
boolean	mkdir(FileRemote file, boolean subdirs, EventWithDst<FileRemoteProgressEvData,?> evBack)
java.io.InputStream	openInputStream(FileRemote file, long passPhase) Returns an opened InputStream with the Zip entry.
java.io.OutputStream	openOutputStream(FileRemote file, long passPhase) Returns an opened InputStream with the Zip entry.
java.nio.channels.ReadableByteChannel	openRead(FileRemote file, long passPhase)
java.nio.channels.WritableByteChannel	openWrite(FileRemote file, long passPhase)
int	processEvent(java.util.EventObject ev) This routine should be overwritten from the user to processes an event.
void	refreshFileProperties(FileRemote file, EventWithDst<FileRemoteProgressEvData,?> evBack) Gets the properties of the file from the physical file.
void	search(FileRemote fileSrc, byte[] search, FileRemoteWalkerCallback callbackUser, FileRemoteProgressEvData timeOrderProgress) Search in all files.
boolean	setLastModified(FileRemote file, long time)
void	XXXrefreshFilePropertiesAndChildren(FileRemote file, FileRemoteProgressEvData callback)

Methods inherited from class org.vishia.fileRemote.FileRemoteAccessor

cmdFile

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final int version

Version, history and license.

• 2013-01-20 artmut bugfix examineZipFile(FileRemote) if the file is faulty. It outputs an error hint on System.err.println(). Better (TODO) FileNotFoundException.
• 2013-01-07 Hartmut chg: The openInputStream(FileRemote, long) returns an opened stream and opens the ZipFile therefore. To close the ZipFile the returned InputStream is wrapped to detect the close() invocation of the InputStream.
• 2013-01-06 Hartmut chg: The openZipFile(FileRemote) method is now named examineZipFile(FileRemote). It opens and closes the Zipfile after building FileRemote instances for the entries. Elsewhere the ZipFile remains open and it hangs on system till the application is closed. TODO: Does openRead works?
• 2012-07-28 Hartmut completed. The class FileZip is not neccessary yet.
• 2012-07-21 Hartmut creation: See FileRemoteAccessor. Support files in zip-File

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

instance

private static FileAccessZip instance

Constructor Detail

FileAccessZip

public FileAccessZip()

Method Detail

getInstance

public static FileAccessZip getInstance()

Returns the singleton instance of this class. Note: The instance will be created and the thread will be started if this routine was called firstly.

Returns:

The singleton instance.

completeFilePath

public java.lang.CharSequence completeFilePath(java.lang.CharSequence sPath)

Returns a unique absolute path for the file regarding maybe tmp, home, environment variables etc. It uses FileFunctions#absolutePath(String, File) to fulfill all.

Specified by:

completeFilePath in class FileRemoteAccessor

Parameters:

path - given path

Returns:

path to get the file.

examineZipFile

public static FileRemote examineZipFile(FileRemote fileZip)

It examines a zip file. Some FileRemote instances are created, one for each zip file entry. The zipfile itself will be opened and closed after them. The returned FileRemote refers all Zipfile entries as children and the zipfile itself as parent. Any FileRemote which represents a ZipEntry contains a FileAccessZip.FileZipData instance referred in the FileRemote.oFile association. Reading the content of an entry should re-open the ZipFile.

Parameters:

fileZip - The zip file itself (in file system).

Returns:

A new instance which refers all children. The children are the files inside the zip files.

close

public void close()

Specified by:

close in class FileRemoteAccessor

close

public void close(FileRemote file)
           throws java.io.IOException

Throws:

java.io.IOException

refreshFileProperties

public void refreshFileProperties(FileRemote file,
                                  EventWithDst<FileRemoteProgressEvData,?> evBack)

Description copied from class: FileRemoteAccessor

Gets the properties of the file from the physical file.

Specified by:

refreshFileProperties in class FileRemoteAccessor

Parameters:

file - the destination file object.

XXXrefreshFilePropertiesAndChildren

public void XXXrefreshFilePropertiesAndChildren(FileRemote file,
                                                FileRemoteProgressEvData callback)

getChildren

public java.util.List<java.io.File> getChildren(FileRemote file,
                                                java.io.FileFilter filter)

Description copied from class: FileRemoteAccessor

Gets files and sub directories of a directory. This method uses the File access methods to get the children of this file.

Specified by:

getChildren in class FileRemoteAccessor

Parameters:

file - parent directory.

filter - maybe a filter

Returns:

The list of that file's children with given filter.

createNewFile

public boolean createNewFile(FileRemote file,
                             EventWithDst<FileRemoteProgressEvData,?> evBack)
                      throws java.io.IOException

Specified by:

createNewFile in class FileRemoteAccessor

Throws:

java.io.IOException

mkdir

public boolean mkdir(FileRemote file,
                     boolean subdirs,
                     EventWithDst<FileRemoteProgressEvData,?> evBack)

Specified by:

mkdir in class FileRemoteAccessor

subdirs - true then create all necessary dirs on the path

evBack - It will be called on any directory which was made, to update the local instance of FileRemote.

Returns:

delete

public boolean delete(FileRemote file,
                      EventWithDst<FileRemoteProgressEvData,?> evBack)

Description copied from class: FileRemoteAccessor

Try to delete the file.

Specified by:

delete in class FileRemoteAccessor

Returns:

If the callback is null, the method returns if the file is deleted or it can't be deleted. The it returns true if the file is deleted successfully. If the callback is not null, it returns true.

copyChecked

public void copyChecked(FileRemote fileSrc,
                        java.lang.String pathDst,
                        java.lang.String nameModification,
                        int mode,
                        FileRemoteWalkerCallback callbackUser,
                        FileRemoteProgressEvData timeOrderProgress)

Description copied from class: FileRemoteAccessor

Copies all files which are checked before.

Specified by:

copyChecked in class FileRemoteAccessor

Parameters:

fileSrc - dir or file as root for copy to the given pathDst

pathDst - String given destination for the copy

nameModification - Modification for each name. null then no modification. TODO

mode - One of the bits FileRemote.modeCopyCreateYes etc.

callbackUser - Maybe null, elsewhere on every directory and file which is finished to copy a callback is invoked.

timeOrderProgress - may be null, to show the progress of copy.

search

public void search(FileRemote fileSrc,
                   byte[] search,
                   FileRemoteWalkerCallback callbackUser,
                   FileRemoteProgressEvData timeOrderProgress)

Description copied from class: FileRemoteAccessor

Search in all files.

Specified by:

search in class FileRemoteAccessor

Parameters:

fileSrc - dir or file as root for search the given byte[]

callbackUser - Maybe null, elsewhere on every directory and file which is finished to copy a callback is invoked.

timeOrderProgress - may be null, to show the progress of copy.

openRead

public java.nio.channels.ReadableByteChannel openRead(FileRemote file,
                                                      long passPhase)

Specified by:

openRead in class FileRemoteAccessor

openInputStream

public java.io.InputStream openInputStream(FileRemote file,
                                           long passPhase)

Returns an opened InputStream with the Zip entry. It opens the ZipFile. The ZipFile will be closed when the InputStream.close() is invoked. Therefore the returned InputStream is wrapped with FileAccessZip.FileZipInputStream. Normally more as one InputStream can be used with one ZipFile. This routine creates a ZipFile instance only for this one entry.

Specified by:

openInputStream in class FileRemoteAccessor

Returns:

See Also:

FileRemoteAccessor.openInputStream(org.vishia.fileRemote.FileRemote, long)

openOutputStream

public java.io.OutputStream openOutputStream(FileRemote file,
                                             long passPhase)

Returns an opened InputStream with the Zip entry. It opens the ZipFile. The ZipFile will be closed when the InputStream.close() is invoked. Therefore the returned InputStream is wrapped with FileAccessZip.FileZipInputStream. Normally more as one InputStream can be used with one ZipFile. This routine creates a ZipFile instance only for this one entry.

Specified by:

openOutputStream in class FileRemoteAccessor

Returns:

See Also:

FileRemoteAccessor.openInputStream(org.vishia.fileRemote.FileRemote, long)

openWrite

public java.nio.channels.WritableByteChannel openWrite(FileRemote file,
                                                       long passPhase)

Specified by:

openWrite in class FileRemoteAccessor

isLocalFileSystem

public boolean isLocalFileSystem()

Description copied from class: FileRemoteAccessor

Creates or prepares a CmdEvent to send to the correct destination. The event is ready to use but not occupied yet. If the evBack contains a CmdEvent as its opponent, it is used. In that way a non-dynamic event management is possible.

Specified by:

isLocalFileSystem in class FileRemoteAccessor

getStateInfo

public java.lang.CharSequence getStateInfo()

Specified by:

getStateInfo in class FileRemoteAccessor

setLastModified

public boolean setLastModified(FileRemote file,
                               long time)

Specified by:

setLastModified in class FileRemoteAccessor

abortAll

public void abortAll()

Description copied from class: FileRemoteAccessor

Abort currently running and saved copy, check etc. actions.

Specified by:

abortAll in class FileRemoteAccessor

activate

public void activate()

Description copied from class: FileRemoteAccessor

Activates working of the devide, thread starting, communication establishing etc.

Specified by:

activate in class FileRemoteAccessor

evThread

public EventThread_ifc evThread()

Description copied from interface: EventConsumer

This operation should return that thread, which is associated to this consumer.

Returns:

null possible if no specific thread was associated.

processEvent

public int processEvent(java.util.EventObject ev)

Description copied from interface: EventConsumer

This routine should be overwritten from the user to processes an event. The return value of the users implementation can contain the following bits:

• 0x01 = EventConsumer.mEventConsumed or StateSimple.mEventConsumed: The event is designated as consumed. If not set, the event should applied on other EventConsumer.processEvent(EventObject) operations, for example for other states if possible
• 0x02 = EventConsumer.mEventDonotRelinquish or StateSimple.mEventDonotRelinquish: The event should not be relinquished by the manager of the events (EventTimerThread), it will be relinquished later in the application after completion detection. It means the application (user) declares itself responsible for relinquish. See EventWithDst.relinquish().
• 0x04 = #mEventConsumerFinished: The task which should be organized by the event is finished. This bit is especially used to designate a TimeOrder as finished for usage, quest in TimeOrder#awaitExecution(int, int). Note that a task can need some more events or other conditions, this bit should be set on the last expected event in the return value of EventConsumer.processEvent(EventObject). For example if a copy of a file tree is finished, or the graphic implementation is completely built.
• 0x08 = EventConsumer.mEventConsumerException: The execution of EventConsumer.processEvent(EventObject) has thrown an error, which is caught in the calling environment in EventTimerThread. How to deal with this information - the application is responsible to, the problem should be logged or debugged.
• 0x010000 .. 0x80000 = see StateSimple.

Parameters:

ev - The event. It contains some data. The type of the event is not specified here. Any events can be processed.

Returns:

0 or EventConsumer.mEventConsumed or EventConsumer.mEventDonotRelinquish etc. see list above. This value is forwarded to EventSource.notifyConsumed(int) and can be evaluated by the application in the calling thread or in any other thread which have access to implementation of EventSource.

cmd

public java.lang.String cmd(boolean bWait,
                            FileRemoteCmdEventData co,
                            EventWithDst<FileRemoteProgressEvData,?> evBack)

Description copied from class: FileRemoteAccessor

Common form of a command with the file.

Specified by:

cmd in class FileRemoteAccessor

Parameters:

bWait - true then wait for fulfill. If it is a local file (depends on FileRemote.device(), then the execution is immediately done in the same thread. If it is especially a file on a remote device only able to reach via communication ( for example on an embedded device), the operation should wait for success.

co - Command description. It is the payload of an command event.

evBack - prepared event for back information or also for progress. The event knows a destination where the back event is processed. If this argument is null, no back information will be sent. This is sensible if bWait is true, and if the caller can check what is happen. Hint: Usual an instance of FileRemoteProgressEventConsumer can be used to execute the event, and also to wait for success on user level.

Returns:

null if executed successfully in another thread (bWait = false), else return null if no error.