|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Field Summary | |
---|---|
static String |
copyright
|
Fields inherited from interface com.ibm.etools.systems.subsystems.IRemoteObjectResolver |
---|
Copyright |
Method Summary | |
---|---|
void |
cancelSearch(IRemoteSearchResultConfiguration searchConfig)
Given a search configuration, cancel the search. |
void |
copy(File source,
IRemoteFile destination,
IProgressMonitor monitor)
Put the local copy of the remote file back to the remote location. |
void |
copy(File source,
IRemoteFile destination,
String encoding,
IProgressMonitor monitor)
Put the local copy of the remote file back to the remote location. |
void |
copy(InputStream stream,
long totalBytes,
IRemoteFile destination,
String encoding,
IProgressMonitor monitor)
Put local data to a remote location. |
void |
copy(IRemoteFile source,
File destination,
IProgressMonitor monitor)
Get the remote file and save it locally. |
void |
copy(IRemoteFile source,
File destination,
String encoding,
IProgressMonitor monitor)
Get the remote file and save it locally. |
boolean |
copy(IRemoteFile sourceFolderOrFile,
IRemoteFile targetFolder,
String newName,
IProgressMonitor monitor)
Copy a file or folder to a new target parent folder. |
void |
copy(IRemoteFile source,
String destination,
IProgressMonitor monitor)
Get the remote file and save it locally. |
void |
copy(IRemoteFile source,
String destination,
String encoding,
IProgressMonitor monitor)
Get the remote file and save it locally. |
void |
copy(String source,
IRemoteFile destination,
IProgressMonitor monitor)
Put the local copy of the remote file back to the remote location. |
void |
copy(String source,
IRemoteFile destination,
String encoding,
IProgressMonitor monitor)
Put the local copy of the remote file back to the remote location. |
void |
copyLocalToRemote(String source,
String destination,
IProgressMonitor monitor)
Put the local copy of the remote file back to the remote location. |
void |
copyLocalToRemote(String source,
String srcEncoding,
String remotePath,
String rmtEncoding,
IProgressMonitor monitor)
Put the local copy of the remote file back to the remote location. |
void |
copyUTF8(File source,
IRemoteFile destination,
IProgressMonitor monitor)
Put the local copy of the remote file back to the remote location. |
void |
copyUTF8(IRemoteFile source,
File destination,
IProgressMonitor monitor)
Get the remote file and save it locally. |
void |
copyUTF8(IRemoteFile source,
String destination,
IProgressMonitor monitor)
Get the remote file and save it locally. |
void |
copyUTF8(String source,
IRemoteFile destination,
IProgressMonitor monitor)
Put the local copy of the remote file back to the remote location. |
IRemoteFile |
createFile(IRemoteFile fileToCreate)
Create a new file, given its IRemoteFile object (these do not have to represent existing files). |
IRemoteFile |
createFolder(IRemoteFile folderToCreate)
Create a new folder, given its IRemoteFile object (these do not have to represent existing folders) The parent folder must exist for this to succeed. |
IRemoteFile |
createFolders(IRemoteFile folderToCreate)
Given an IRemoteFile for a folder, this will create that folder and any missing parent folders in its path. |
boolean |
delete(IRemoteFile folderOrFile)
Delete the given remote file or folder. |
String |
getHomeFolder()
|
ILanguageUtilityFactory |
getLanguageUtilityFactory()
Returns a language utility factory associated with this subsystem. |
String |
getLineSeparator()
Return as a string the line separator. |
InetAddress |
getLocalAddress()
Returns the TCP/IP address for the local system that is accessible from the remote server. |
IRemoteFile |
getParentFolder(IRemoteFile folderOrFile)
Given a folder or file, return its parent folder object. |
String |
getParentFolderName(IRemoteFile folderOrFile)
Given a folder or file, return its parent folder name, fully qualified |
RemoteFileSubSystemFactory |
getParentRemoteFileSubSystemFactory()
Return parent subsystem factory, cast to a RemoteFileSubSystemFactory |
String |
getPathSeparator()
Return in string format the character used to separate paths. |
char |
getPathSeparatorChar()
Return in char format the character used to separate paths. |
String |
getRemoteEncoding()
Get the default encoding of the target system |
IRemoteFile |
getRemoteFileObject(IRemoteFile parent,
String folderOrFileName)
Given a un-qualified file or folder name, and its parent folder object, return an IRemoteFile object for the file. |
IRemoteFile |
getRemoteFileObject(String folderOrFileName)
Given a fully qualified file or folder name, return an IRemoteFile object for it. |
IRemoteSearchResultConfigurationFactory |
getRemoteSearchResultConfigurationFactory()
Gets the search result configuration factory associated with the subsystem. |
IRemoteSearchResult |
getRemoteSearchResultObject(String key)
Given a key, returns a search result object for it. |
String |
getSeparator()
Return in string format the character used to separate folders. |
char |
getSeparatorChar()
Return in character format the character used to separate folders. |
int |
getUnusedPort()
Returns an unused port number on the remote host that could be used by any tool on the host. |
boolean |
isCaseSensitive()
Return true if file names are case-sensitive. |
IRemoteFile[] |
listFiles(IRemoteFile parent)
Return a list of all remote files in the given parent folder on the remote system |
IRemoteFile[] |
listFiles(IRemoteFile parent,
String fileNameFilter)
Return a list of remote files in the given folder, which match the given name pattern. |
IRemoteFile[] |
listFolders(IRemoteFile parent)
Return a list of all remote folders in the given parent folder on the remote system |
IRemoteFile[] |
listFolders(IRemoteFile parent,
String fileNameFilter)
Return a full list of remote folders in the given parent folder on the remote system. |
IRemoteFile[] |
listFoldersAndFiles(IRemoteFile parent)
Return a list of all remote folders and files in the given folder. |
IRemoteFile[] |
listFoldersAndFiles(IRemoteFile parent,
String fileNameFilter)
Return a list of remote folders and files in the given folder. |
IRemoteFile[] |
listRoots()
Return a list of roots/drives on the remote system. |
boolean |
move(IRemoteFile sourceFolderOrFile,
IRemoteFile targetFolder,
String newName)
Move a file or folder to a new target parent folder. |
boolean |
rename(IRemoteFile folderOrFile,
String newName)
Rename the given remote file or folder. |
void |
search(IRemoteSearchResultConfiguration searchConfig)
Given a search configuration, searches for its results. |
void |
setHomeFolder(String value)
|
boolean |
setLastModified(IRemoteFile folderOrFile,
long newDate)
Set the last modified date for the given file or folder. |
boolean |
setReadOnly(IRemoteFile folderOrFile)
Set a file to readonly. |
Methods inherited from interface com.ibm.etools.systems.subsystems.IRemoteObjectResolver |
---|
getObjectWithAbsoluteName |
Field Detail |
public static final String copyright
Method Detail |
public RemoteFileSubSystemFactory getParentRemoteFileSubSystemFactory()
public boolean isCaseSensitive()
public String getSeparator()
getParentRemoteFileSubSystemFactory()
.getSeparator()
public char getSeparatorChar()
getParentRemoteFileSubSystemFactory()
.getSeparatorChar()
public String getPathSeparator()
getParentRemoteFileSubSystemFactory()
.getPathSeparator()
public char getPathSeparatorChar()
getParentRemoteFileSubSystemFactory()
.getPathSeparatorChar()
public String getLineSeparator()
getParentRemoteFileSubSystemFactory()
.getLineSeparator()
public IRemoteFile[] listRoots() throws InterruptedException
InterruptedException
public IRemoteFile[] listFolders(IRemoteFile parent)
parent
- The parent folder to list folders inpublic IRemoteFile[] listFolders(IRemoteFile parent, String fileNameFilter)
parent
- The parent folder to list folders infileNameFilter
- The name pattern for subsetting the file list when this folder is subsequently expandedpublic IRemoteFile[] listFiles(IRemoteFile parent)
parent
- The parent folder to list files inpublic IRemoteFile[] listFiles(IRemoteFile parent, String fileNameFilter)
parent
- The parent folder to list files infileNameFilter
- The name pattern to subset the list by, or null to return all files.public IRemoteFile[] listFoldersAndFiles(IRemoteFile parent)
parent
- The parent folder to list folders and files inpublic IRemoteFile[] listFoldersAndFiles(IRemoteFile parent, String fileNameFilter)
parent
- The parent folder to list folders and files infileNameFilter
- The name pattern to subset the file list by, or null to return all files.public void search(IRemoteSearchResultConfiguration searchConfig)
searchConfig
- a search configuration.public void cancelSearch(IRemoteSearchResultConfiguration searchConfig)
searchConfig
- a search configuration.public IRemoteSearchResultConfigurationFactory getRemoteSearchResultConfigurationFactory()
public IRemoteFile getParentFolder(IRemoteFile folderOrFile)
folderOrFile
- folder or file to return parent of.public String getParentFolderName(IRemoteFile folderOrFile)
folderOrFile
- folder or file to return parent of.public String getRemoteEncoding()
public IRemoteFile getRemoteFileObject(String folderOrFileName) throws SystemMessageException
folderOrFileName
- Fully qualified folder or file name
SystemMessageException
public IRemoteFile getRemoteFileObject(IRemoteFile parent, String folderOrFileName) throws SystemMessageException
parent
- Folder containing the folder or filefolderOrFileName
- Un-qualified folder or file name
SystemMessageException
public IRemoteSearchResult getRemoteSearchResultObject(String key) throws SystemMessageException
key
- the key that uniquely identifies a search result.
SystemMessageException
public IRemoteFile createFile(IRemoteFile fileToCreate) throws RemoteFileSecurityException, RemoteFileIOException
fileToCreate
- The object representing the file to be created.
RemoteFileSecurityException
RemoteFileIOException
createFolders(IRemoteFile)
public IRemoteFile createFolder(IRemoteFile folderToCreate) throws RemoteFileSecurityException, RemoteFileIOException
folderToCreate
- The object representing the folder to be created.
RemoteFileSecurityException
RemoteFileIOException
createFolders(IRemoteFile)
public IRemoteFile createFolders(IRemoteFile folderToCreate) throws RemoteFileSecurityException, RemoteFileIOException
folderToCreate
- The object representing the folder to be created, along with its parents.
RemoteFileSecurityException
RemoteFileIOException
getParentFolder(IRemoteFile)
public boolean delete(IRemoteFile folderOrFile) throws RemoteFolderNotEmptyException, RemoteFileSecurityException, RemoteFileIOException
folderOrFile
- represents the object to be deleted.
RemoteFolderNotEmptyException
RemoteFileSecurityException
RemoteFileIOException
public boolean rename(IRemoteFile folderOrFile, String newName) throws RemoteFileSecurityException, RemoteFileIOException
folderOrFile
- represents the object to be renamed.newName
- new name to give it.
RemoteFileSecurityException
RemoteFileIOException
public boolean move(IRemoteFile sourceFolderOrFile, IRemoteFile targetFolder, String newName) throws RemoteFileSecurityException, RemoteFileIOException
sourceFolderOrFile
- The file or folder to movetargetFolder
- The folder to move to. No guarantee it is on the same system, so be sure to check getSystemConnection()!newName
- The new name for the moved file or folder
RemoteFileSecurityException
RemoteFileIOException
public boolean setLastModified(IRemoteFile folderOrFile, long newDate) throws RemoteFileSecurityException, RemoteFileIOException
folderOrFile
- represents the object to be renamed.newDate
- new date, in milliseconds from epoch, to assign.
RemoteFileSecurityException
RemoteFileIOException
public boolean setReadOnly(IRemoteFile folderOrFile) throws RemoteFileSecurityException, RemoteFileIOException
folderOrFile
- represents the object to be renamed.
RemoteFileSecurityException
RemoteFileIOException
public boolean copy(IRemoteFile sourceFolderOrFile, IRemoteFile targetFolder, String newName, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
sourceFolderOrFile
- The file or folder to copytargetFolder
- The folder to copy to. No guarantee it is on the same system, so be sure to check getSystemConnection()!newName
- The new name for the copied file or folder
RemoteFileSecurityException
RemoteFileIOException
public void copy(IRemoteFile source, String destination, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- remote file that represents the file to be obtaineddestination
- the absolute path of the local filemonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copy(IRemoteFile source, String destination, String encoding, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- remote file that represents the file to be obtaineddestination
- the absolute path of the local fileencoding
- the encoding of the local filemonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copyUTF8(IRemoteFile source, String destination, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- remote file that represents the file to be obtaineddestination
- the absolute path of the local filemonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copy(IRemoteFile source, File destination, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- remote file that represents the file to be obtaineddestination
- the local filemonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copy(IRemoteFile source, File destination, String encoding, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- remote file that represents the file to be obtaineddestination
- the local fileencoding
- the encoding of the local filemonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copyUTF8(IRemoteFile source, File destination, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- remote file that represents the file to be obtaineddestination
- the local filemonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copy(String source, IRemoteFile destination, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- the absolute path of the local copydestination
- remote file that represents the file on the servermonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copy(String source, IRemoteFile destination, String encoding, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- the absolute path of the local copydestination
- remote file that represents the file on the serverencoding
- the encoding of the local copymonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copy(InputStream stream, long totalBytes, IRemoteFile destination, String encoding, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
stream
- the input stream containing the local data.totalBytes
- the total number of bytes in the stream, or -1 if unknown. If -1 is specified, then the progress monitor must be null
.destination
- remote file that represents the file on the server.encoding
- the encoding of the local data, or null
to specify binary.monitor
- the progress monitor.
RemoteFileSecurityException
RemoteFileIOException
public void copyLocalToRemote(String source, String destination, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- the absolute path of the local copydestination
- remote file that represents the file on the servermonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copyLocalToRemote(String source, String srcEncoding, String remotePath, String rmtEncoding, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- the absolute path of the local copysrcEncoding
- the encoding of the local copyremotePath
- remote file that represents the file on the serverrmtEncoding
- the encoding of the remote file.
RemoteFileSecurityException
RemoteFileIOException
public void copyUTF8(String source, IRemoteFile destination, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- the absolute path of the local copydestination
- remote file that represents the file on the servermonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copy(File source, IRemoteFile destination, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- the local copydestination
- remote file that represents the file on the servermonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copy(File source, IRemoteFile destination, String encoding, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- the local copydestination
- remote file that represents the file on the serverencoding
- the encoding of the local copymonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public void copyUTF8(File source, IRemoteFile destination, IProgressMonitor monitor) throws RemoteFileSecurityException, RemoteFileIOException
source
- the local copydestination
- remote file that represents the file on the servermonitor
- the progress monitor
RemoteFileSecurityException
RemoteFileIOException
public String getHomeFolder()
public void setHomeFolder(String value)
value
- The new value of the HomeFolder attributepublic ILanguageUtilityFactory getLanguageUtilityFactory()
public int getUnusedPort()
public InetAddress getLocalAddress()
null
.
null
if
no address can be resolved.
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |