FileRemoteAccessor

java.lang.Object
- org.vishia.fileRemote.FileRemoteAccessor

All Implemented Interfaces:

EventConsumer

Direct Known Subclasses:

FileAccessorLocalJava7, FileAccessZip
```
public abstract class FileRemoteAccessor
extends java.lang.Object
implements EventConsumer
```
Interface for instances, which organizes a remote access to files. One instance per transfer protocol are need.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileRemoteAccessor.FileWalkerThread` This class offers a Thread especially for `FileRemoteAccessor#walkFileTree(FileRemote, boolean, FileFilter, int, CallbackFile)` which can be use for devices which can evaluate the files by immediately system calls without communication but with maybe waiting for response.

Field Summary

Fields
Modifier and Type Field and Description

private static long serialVersionUID

static java.lang.String version
Version, history and license.
- Fields inherited from interface org.vishia.event.EventConsumer
  mEventConsumed, mEventConsumerException, mEventConsumFinished, mEventDonotRelinquish, mMaskReservedHere

Fields
Modifier and Type	Field and Description
`private static long`	`serialVersionUID`
`static java.lang.String`	`version` Version, history and license.

Constructor Summary

Constructors
Modifier Constructor and Description

protected FileRemoteAccessor()

Constructors
Modifier	Constructor and Description
`protected`	`FileRemoteAccessor()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`abortAll()` Abort currently running and saved copy, check etc. actions.
`abstract void`	`activate()` Activates working of the devide, thread starting, communication establishing etc.
`abstract void`	`close()`
`abstract java.lang.String`	`cmd(boolean bWait, FileRemoteCmdEventData co, EventWithDst<FileRemoteProgressEvData,?> evBack)` Common form of a command with the file.
`java.lang.String`	`cmdFile(FileRemote file, FileRemoteCmdEventData.Cmd cmd, FileRemote fileDst, java.lang.String nameNew, long dateNew, EventWithDst<FileRemoteProgressEvData,FileRemoteCmdEventData> evBack)` Command to handle one single file and maybe a destination file for example for rename, copy, mkdir etc.
`abstract java.lang.CharSequence`	`completeFilePath(java.lang.CharSequence path)` Returns a unique absolute path for the file regarding maybe tmp, home, environment variables etc.
`abstract 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.
`abstract boolean`	`createNewFile(FileRemote file, EventWithDst<FileRemoteProgressEvData,?> evBack)`
`abstract boolean`	`delete(FileRemote file, EventWithDst<FileRemoteProgressEvData,?> evBack)` Try to delete the file.
`abstract java.util.List<java.io.File>`	`getChildren(FileRemote file, java.io.FileFilter filter)` Gets files and sub directories of a directory.
`abstract java.lang.CharSequence`	`getStateInfo()`
`abstract boolean`	`isLocalFileSystem()` Creates or prepares a CmdEvent to send to the correct destination.
`abstract boolean`	`mkdir(FileRemote file, boolean subdirs, EventWithDst<FileRemoteProgressEvData,?> evBack)`
`abstract java.io.InputStream`	`openInputStream(FileRemote file, long passPhase)` Creates an InputStream with this fileRemote instance.
`abstract java.io.OutputStream`	`openOutputStream(FileRemote file, long passPhase)` Creates an OutputStream with this fileRemote instance.
`abstract java.nio.channels.ReadableByteChannel`	`openRead(FileRemote file, long passPhase)`
`abstract java.nio.channels.WritableByteChannel`	`openWrite(FileRemote file, long passPhase)`
`abstract void`	`refreshFileProperties(FileRemote file, EventWithDst<FileRemoteProgressEvData,?> evBack)` Gets the properties of the file from the physical file.
`abstract void`	`search(FileRemote fileSrc, byte[] search, FileRemoteWalkerCallback callbackUser, FileRemoteProgressEvData timeOrderProgress)` Search in all files.
`protected abstract boolean`	`setLastModified(FileRemote file, long time)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.vishia.event.EventConsumer
evThread, processEvent

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - version
```
public static final java.lang.String version
```
    Version, history and license.
    - 2023-07-22 Hartmut new: cmdFile(FileRemote, org.vishia.fileRemote.FileRemoteCmdEventData.Cmd, FileRemote, String, long, EventWithDst). as common solution for all Accessor, uses cmd(boolean, FileRemoteCmdEventData, EventWithDst) for execution.
    - 2023-03-15 Hartmut chg: no more derived from Closeable, instead close() defined here, because there are anytime again unnecessary warnings "resource" on access to this instance.
    - 2012-05-30 Hartmut new: openOutputStream(FileRemote, long) Note: it may be that the openRead(FileRemote, long) and openWrite(FileRemote, long) is not proper for some requirements, working with the traditional streams may be better.
    - 2015-05-30 Hartmut new: #walkFileTreeCheck(FileRemote, boolean, boolean, boolean, String, long, int, FileRemoteWalkerCallback)
    - 2012-09-14 Hartmut new: CallbackFile, #walkFileTree(FileRemote, FileFilter, int, CallbackFile).
    - 2012-08-12 Hartmut chg: Now it is an interface, not an abstract class, only formal.
    - 2012-08-12 Hartmut new: setLastModified(FileRemote, long).
    - 2012-08-12 Hartmut bugfix: getChildren(FileRemote, FileFilter) here only abstract.
    - 2012-08-12 Hartmut new: openInputStream(FileRemote, long)
    - 2012-08-12 Hartmut new: getChildren(FileRemote, FileFilter) implemented here.
    - 2012-08-12 Hartmut chg: up to now this is not an interface but an abstract class. It contains common method implementation. An derivation (or implementation of the interface before that change) may not need other base classes.
    - 2012-08-03 Hartmut chg: Usage of Event in FileRemote. The FileRemoteAccessor.Commission is removed yet. The same instance FileRemote.Callback, now named FileRemote.FileRemoteEvent is used for forward event (commision) and back event.
    - 2012-07-28 Hartmut new: Concept of remote files enhanced with respect to FileAccessZip, see FileRemote
    - 2012-03-10 Hartmut new: Commission#newDate etc. for FileRemote#chgProps(String, int, int, long, org.vishia.fileRemote.FileRemote.CallbackEvent).
    - 2012-01-09 Hartmut new: This class extends from Closeable, because an implementation may have an running thread which is need to close. A device should be closeable any time.
    - 2012-01-06 Hartmut new #refreshFileProperties(FileRemote).
    - 2011-12-31 Hartmut new Commission and #addCommission(Commission). It is used to add commissions to the implementation class to do in another thread/via communication.
    - 2011-12-10 Hartmut creation: Firstly only the FileRemoteAccessorLocalFile is written.
    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
- Constructor Detail
  - FileRemoteAccessor
```
protected FileRemoteAccessor()
```
- Method Detail
  - activate
```
public abstract void activate()
```
    Activates working of the devide, thread starting, communication establishing etc.
  - close
```
public abstract void close()
```
  - completeFilePath
```
public abstract java.lang.CharSequence completeFilePath(java.lang.CharSequence path)
```
    Returns a unique absolute path for the file regarding maybe tmp, home, environment variables etc.
    
    Parameters:
    
    path - given path
    
    Returns:
    
    path to get the file.
  - refreshFileProperties
```
public abstract void refreshFileProperties(FileRemote file,
                                           EventWithDst<FileRemoteProgressEvData,?> evBack)
```
    Gets the properties of the file from the physical file.
    
    Parameters:
    
    file - the destination file object.
    
    callback - If null then the method should access the file system immediately in this thread. It means it is possible that this needs a longer time for wait for response from a maybe remote file system with a suitable timeout.
    If the callback is given, the implementor should install a temporary thread which does the access and calls the callback on finishing. This operation returns immediately. That is especially proper if the operation is called in an event procedure in a graphic system. Prevent scrolling wheel on the screen.
  - cmd
```
public abstract java.lang.String cmd(boolean bWait,
                                     FileRemoteCmdEventData co,
                                     EventWithDst<FileRemoteProgressEvData,?> evBack)
```
    Common form of a command with the file.
    
    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.
    
    Since:
    
    2023-03, the new concept.
  - cmdFile
```
public java.lang.String cmdFile(FileRemote file,
                                FileRemoteCmdEventData.Cmd cmd,
                                FileRemote fileDst,
                                java.lang.String nameNew,
                                long dateNew,
                                EventWithDst<FileRemoteProgressEvData,FileRemoteCmdEventData> evBack)
```
    Command to handle one single file and maybe a destination file for example for rename, copy, mkdir etc. It is implemented here, calls cmd(boolean, FileRemoteCmdEventData, EventWithDst) with prepared FileRemoteCmdEventData gotten from a given evBack . EventWithDst.getOpponent() or if that is not given from a temporary instance for 'FileRemoteCmdEventData'.
    
    Parameters:
    
    file - The file to handle
    
    cmd - command what to do
    
    fileDst - null or maybe a destination path due to cmd
    
    nameNew - null or maybe a new name due to cmd (for rename)
    
    dateNew - null or maybe a timestamp due to cmd.
    
    evBack - back event and the command event usable given as EventWithDst.getOpponent(). If the opponent is not given, the command will be executed in the own thread.
    
    Returns:
    
    return value from cmd(boolean, FileRemoteCmdEventData, EventWithDst). null if successfully or no error known. The complete success will be notified by evBack. If evBack is not given, null is a hint that all is done successfully.
  - getChildren
```
public abstract java.util.List<java.io.File> getChildren(FileRemote file,
                                                         java.io.FileFilter filter)
```
    Gets files and sub directories of a directory. This method uses the File access methods to get the children of this file.
    
    Parameters:
    
    file - parent directory.
    
    filter - maybe a filter
    
    Returns:
    
    The list of that file's children with given filter.
  - setLastModified
```
protected abstract boolean setLastModified(FileRemote file,
                                           long time)
```
  - createNewFile
```
public abstract boolean createNewFile(FileRemote file,
                                      EventWithDst<FileRemoteProgressEvData,?> evBack)
                               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - delete
```
public abstract boolean delete(FileRemote file,
                               EventWithDst<FileRemoteProgressEvData,?> evBack)
```
    Try to delete the file.
    
    Parameters:
    
    callback -
    
    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.
  - mkdir
```
public abstract boolean mkdir(FileRemote file,
                              boolean subdirs,
                              EventWithDst<FileRemoteProgressEvData,?> evBack)
```
    Parameters:
    
    file -
    
    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:
  - copyChecked
```
public abstract 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.
    
    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 abstract void search(FileRemote fileSrc,
                            byte[] search,
                            FileRemoteWalkerCallback callbackUser,
                            FileRemoteProgressEvData timeOrderProgress)
```
    Search in all files.
    
    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 abstract java.nio.channels.ReadableByteChannel openRead(FileRemote file,
                                                               long passPhase)
```
  - openInputStream
```
public abstract java.io.InputStream openInputStream(FileRemote file,
                                                    long passPhase)
```
    Creates an InputStream with this fileRemote instance.
    
    Parameters:
    
    file -
    
    passPhase -
    
    Returns:
  - openWrite
```
public abstract java.nio.channels.WritableByteChannel openWrite(FileRemote file,
                                                                long passPhase)
```
  - openOutputStream
```
public abstract java.io.OutputStream openOutputStream(FileRemote file,
                                                      long passPhase)
```
    Creates an OutputStream with this fileRemote instance.
    
    Parameters:
    
    file -
    
    passPhase -
    
    Returns:
  - isLocalFileSystem
```
public abstract boolean isLocalFileSystem()
```
    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.
  - getStateInfo
```
public abstract java.lang.CharSequence getStateInfo()
```
  - abortAll
```
public abstract void abortAll()
```
    Abort currently running and saved copy, check etc. actions.

Class FileRemoteAccessor

Nested Class Summary

Field Summary

Fields inherited from interface org.vishia.event.EventConsumer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.vishia.event.EventConsumer

Field Detail

serialVersionUID

version

Constructor Detail

FileRemoteAccessor

Method Detail

activate

close

completeFilePath

refreshFileProperties

cmd

cmdFile

getChildren

setLastModified

createNewFile

delete

mkdir

copyChecked

search

openRead

openInputStream

openWrite

openOutputStream

isLocalFileSystem

getStateInfo

abortAll